Type alias CameraConfig<MetadataType>

CameraConfig<MetadataType>: {
    cameraEnabled: boolean;
    captureDeviceId: string;
    flipVideo: boolean;
    maxBandwidth: TrackBandwidthLimit;
    quality: VideoQuality;
    simulcastConfig: SimulcastConfig;
    videoTrackMetadata: MetadataType;
}

Type Parameters

Type declaration

  • cameraEnabled: boolean

    whether the camera track is initially enabled, you can toggle it on/off later with toggleCamera method

    Default

    true

  • captureDeviceId: string

    id of the camera to start capture with. Get available cameras with getCaptureDevices(). You can switch the cameras later with flipCamera/switchCamera functions.

    Default

    the first front camera
  • flipVideo: boolean

    whether to flip the dimensions of the video, that is whether to film in vertical orientation.

    Default

    true

  • maxBandwidth: TrackBandwidthLimit

    bandwidth limit of a video track. By default there is no bandwidth limit.

  • quality: VideoQuality

    resolution + aspect ratio of local video track, one of: QVGA_169, VGA_169, QHD_169, HD_169, FHD_169, QVGA_43, VGA_43, QHD_43, HD_43, FHD_43. Note that quality might be worse than specified due to device capabilities, internet connection etc.

    Default

    VGA_169

  • simulcastConfig: SimulcastConfig

    SimulcastConfig of a video track. By default simulcast is disabled.

  • videoTrackMetadata: MetadataType

    a map string -> any containing video track metadata to be sent to the server.

Settings

Member Visibility

Theme

Generated using TypeDoc