VideoOptions

• static builder(): VideoOptionsBuilder
• cameraOrientation(): CameraOrientation
• videoFilter(): VideoFilter
• videoMode(): VideoMode
• cameraVideoFrameRate(): number
• screenShareFrameRate(): number
• deviceId(): string

static builder()

Description

Creates a builder instance used to build a new instance of VideoOptions.

Arguments

• none

Returns

• VideoOptionsBuilder - Instance of the builder.

Example

let videoOptionsBuilder = VideoOptions.builder();

cameraOrientation()

Description

Getter for the cameraOrientation field.

Arguments

• none

Returns

• CameraOrientation - Value of the cameraOrientation field representing camera facing mode.

Example

let videoOptions = VideoOptions.builder()
    .setCameraOrientation(CameraOrientation.BACK)
    .build();
let cameraOrientation = videoOptions.cameraOrientation;

videoFilter()

Description

Getter for the videoFilter field.

Arguments

• none

Returns

• VideoFilter - The value of the videoFilter field, which represents the video filter to be applied on the camera video stream.

Example

let videoFilter = createVideoFilterImplementation();
let videoOptions = VideoOptions.builder()
    .setVideoFilter(videoFilter)
    .build();
let videoFilter = videoOptions.videoFilter;

videoMode()

Description

Getter for the videoMode field.

Arguments

• none

Returns

• VideoMode - Value of the videoMode field representing a configuration used for video subscriptions in the call.

Example

let videoOptions = VideoOptions.builder()
        .setVideoMode(VideoMode.GRID)
        .build();
let videoMode = videoOptions.videoMode;

cameraVideoFrameRate()

Description

Getter for the cameraVideoFrameRate field.

Arguments

• none

Returns

• number - Value of the cameraVideoFrameRate field representing the max frame rate of the camera video. The value ranges from 1 (min) to 30 (max) frames per second.

Example

let videoOptions = VideoOptions.builder()
        .setCameraVideoFrameRate(30)
        .build();
let cameraVideoFrameRate = videoOptions.videoMode.cameraVideoFrameRate;

screenShareFrameRate()

Description

Getter for the screenShareFrameRate field.

Arguments

• none

Returns

• number - Value of the screenShareFrameRate field representing the max frame rate of the screen share. The value ranges from 1 (min) to 30 (max) frames per second.

Example

let videoOptions = VideoOptions.builder()
        .setScreenShareFrameRate(30)
        .build();
let cameraVideoFrameRate = videoOptions.videoMode.screenShareFrameRate;

deviceId()

Description

Getter for the deviceId field.

Arguments

• none

Returns

• string - Value of the deviceId field representing the identifier of the preferred video input device.

Example

let videoOptions = VideoOptions.builder()
        .deviceId('my-preferred-device-id')
        .build();
let deviceId = videoOptions.deviceId