VideoOptionsBuilder

• setCameraOrientation(_cameraOrientation: CameraOrientation): VideoOptionsBuilder
• setVideoFilter(videoFilter: VideoFilter): VideoOptionsBuilder
• setVideoMode(videoMode: VideoMode): VideoOptionsBuilder
• setCameraVideoFrameRate(cameraVideoFrameRate: number): VideoOptionsBuilder
• setScreenShareFrameRate(screenShareFrameRate: number): VideoOptionsBuilder
• setDeviceId(deviceId: string): VideoOptionsBuilder
• build(): VideoOptions

setCameraOrientation(cameraOrientation)

Description

Setter for the cameraOrientation field.

Arguments

• cameraOrientation: CameraOrientation - Optional enum value representing camera facing mode for local video. Default value is FRONT.

Returns

• VideoOptionsBuilder - Instance of the builder.

Example

let videoOptionsBuilder = VideoOptions.builder();
videoOptionsBuilder.setCameraOrientation(CameraOrientation.BACK);

setVideoFilter(videoFilter)

Description

Setter for the videoFilter field.

Arguments

• videoFilter: VideoFilter - The object that represents the video filter to be applied on the camera video stream. Default value is null.

Returns

• VideoOptionsBuilder - Instance of the builder.

Example

let videoFilter = createVideoFilterImplementation()
let videoOptionsBuilder = VideoOptions.builder();
videoOptionsBuilder.setVideoFilter(videoFilter);

setVideoMode(videoMode)

Description

Setter for the videoMode field.

Arguments

• videoMode: videoMode - Optional enum value representing configuration used for video subscriptions in the call. Default value is PRESENTATION.

Returns

• VideoOptionsBuilder - Instance of the builder.

Example

let videoOptionsBuilder = VideoOptions.builder();
videoOptionsBuilder.setVideoMode(VideoMode.GRID);

setCameraVideoFrameRate(cameraVideoFrameRate)

Description

Setter for the cameraVideoFrameRate field.

Arguments

• cameraVideoFrameRate: number - Frame rate of the camera video. 24 frames per second (fps) by default. The applicable value range is from 1 (min) to 30 (max) frames per second.

Returns

• VideoOptionsBuilder - Instance of the builder.

Example

let videoOptionsBuilder = VideoOptions.builder();
videoOptionsBuilder.setCameraVideoFrameRate(30);

setScreenShareFrameRate(screenShareFrameRate)

Description

Setter for the screenShareFrameRate field.

Arguments

• screenShareFrameRate: number - Frame rate of the screen share. 8 frames per second (fps) by default. The applicable value range is from 1 (min) to 30 (max) frames per second.

Returns

• VideoOptionsBuilder - Instance of the builder.

Example

let videoOptionsBuilder = VideoOptions.builder();
videoOptionsBuilder.setScreenShareFrameRate(30);

setDeviceId(deviceId)

Description

Setter for the deviceId field.

Arguments

• deviceId: string - Identifier of the preferred video input device.

Returns

• VideoOptionsBuilder - Instance of the builder.

Example

let videoOptionsBuilder = VideoOptions.builder();
videoOptionsBuilder.setDeviceId('my-preferred-device-id');

build()

Description

Builds a new instance of the VideoOptions.

Arguments

• none

Returns

• VideoOptions - Instance of the VideoOptions.

Example

let videoOptionsBuilder = VideoOptions.builder();
let videoOptions = videoOptionsBuilder.build();