Variable switchUserVideo`Const`

switchUserVideo: SwitchUserVideoType = ...

Switches the user's video input device based on the provided options.

Param: options

The options for switching the user's video.

Param: options.videoPreference

The preferred video input device ID.

Param: options.checkoff

Flag indicating whether to turn off the video.

Param: options.parameters

Additional parameters required for switching the video.

Param: options.parameters.audioOnlyRoom

Indicates if the room is audio-only.

Param: options.parameters.frameRate

The desired frame rate for the video.

Param: options.parameters.vidCons

Video constraints such as width and height.

Param: options.parameters.prevVideoInputDevice

The previous video input device ID.

Param: options.parameters.showAlert

Function to show alerts to the user.

Param: options.parameters.mediaDevices

Media devices object to access user media.

Param: options.parameters.hasCameraPermission

Indicates if the user has camera permission.

Param: options.parameters.updateVideoSwitching

Function to update video switching state.

Param: options.parameters.updateUserDefaultVideoInputDevice

Function to update the default video input device.

Param: options.parameters.requestPermissionCamera

Function to request camera permission.

Param: options.parameters.streamSuccessVideo

Function to handle successful video stream.

Param: options.parameters.sleep

Function to pause execution for a specified duration.

Param: options.parameters.checkMediaPermission

Function to check media permissions.

Returns

A promise that resolves when the video input device has been successfully switched.

Throws

Will throw an error if the audio input device cannot be accessed or if there is an unexpected error.

Example

await switchUserVideo({
  videoPreference: 'video-device-id',
  checkoff: false,
  parameters: {
    audioOnlyRoom: false,
    frameRate: 30,
    vidCons: { width: 640, height: 480 },
    prevVideoInputDevice: 'prev-video-device-id',
    showAlert: showAlertFunction,
    mediaDevices: navigator.mediaDevices,
    hasCameraPermission: true,
    updateVideoSwitching: updateVideoSwitchingFunction,
    updateUserDefaultVideoInputDevice: updateUserDefaultVideoInputDeviceFunction,
    requestPermissionCamera: requestPermissionCameraFunction,
    streamSuccessVideo: streamSuccessVideoFunction,
    sleep: sleepFunction,
    checkMediaPermission: true,
    getUpdatedAllParams: getUpdatedAllParamsFunction,
  },
});