Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CaptureVideoOption

Capture video option interface.

Hierarchy

  • CaptureVideoOption

Index

Properties

Optional cameraId

cameraId: string | typeof MobileVideoFacingMode

Camera ID for the camera capturing the video, if not specified, use system default.

Optional captureHeight

captureHeight: number

Customized height of capture, default is 360p.

Optional captureWidth

captureWidth: number

Customized width of capture, default is 640p.

Optional hd

hd: boolean

Determines whether capture 720p video enabled.

Optional mirrored

mirrored: boolean

Determines whether self video is mirrored.

Optional originalRatio

originalRatio: boolean

Whether to capture the video in the original ratio, the default is to crop the ratio to 16:9.

Optional videoElement

videoElement: HTMLVideoElement

Video element. Only used in Android platform or non-SharedArrayBuffer Chromium-like browsers.

Optional virtualBackground

virtualBackground: { cropped?: boolean; imageUrl: undefined | string }

Virtual background options.

Type declaration

  • Optional cropped?: boolean

    Determines whether to crop the background image to an appropriate aspect ratio (16/9), default is false.

  • imageUrl: undefined | string

    Image URL for the virtual background.

    • If set a specific image, the URL can be a regular HTTP or HTTPS URL, base64 format, or ObjectURL.
    • 'blur' : Blurs the background.
    • undefined : no virtual background.