CameraComponentConfig class

Warning: This API is now obsolete.

Creating a layout using component configurations is deprecated. Instead use MediaSourceManager.createCameraSource() to create a camera media source and use that to create a camera component.

Options to populate a layout element with a camera component

Signature:

export declare class CameraComponentConfig extends ComponentConfig 

Extends: ComponentConfig

Constructors

ConstructorModifiersDescription
(constructor)()Constructs a new instance of the CameraComponentConfig class

Properties

PropertyModifiersTypeDescription
cameraTypeEnum<typeof CameraType>Determine which camera feed to show in the camera component. The default is the front facing camera.
CameraType

static

readonly

typeof CameraType
recordMicrophonebooleanEnables or disables recording of microphone audio when recording a video from the camera component. Microphone recording is enabled by default.
resolutionScaleEnum<typeof CameraResolutionScale>Resolution required by this camera. By default full resolution is used.

CameraComponentConfig.(constructor)

Constructs a new instance of the CameraComponentConfig class

Signature:

constructor();

CameraComponentConfig.CameraType property

Warning: This API is now obsolete.

Use CameraType which is identical

Signature:

static readonly CameraType: typeof CameraType;

CameraComponentConfig.recordMicrophone property

Enables or disables recording of microphone audio when recording a video from the camera component. Microphone recording is enabled by default.

Signature:

recordMicrophone: boolean;

Remarks

For recording a camera video without audio, it is recommended to use this option instead of setting the volume to zero as this will skip audio encoding completely.

CameraComponentConfig.resolutionScale property

Resolution required by this camera. By default full resolution is used.

Signature:

resolutionScale: Enum<typeof CameraResolutionScale>;

Remarks

Consider using less than Full resolution if the camera and its recorded video will be displayed smaller than full screen.