VideoOptions

• static VideoOptions.Builder builder()
• VideoOptions.CameraOrientation getCameraOrientation()
• VideoOptions.VideoMode getVideoMode()
• VideoFilter getVideoFilter()
• int getCameraVideoFrameRate()
• int getScreenShareFrameRate()
• static class Builder

builder()

Description

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

Arguments

• none

Returns

• VideoOptions.Builder - Instance of the builder.

Example

VideoOptions.Builder builder = VideoOptions.builder();

getCameraOrientation()

Description

Getter for the cameraOrientation field.

Arguments

• none

Returns

• VideoOptions.CameraOrientation - The value of the cameraOrientation field which configures the camera's orientation.

Example

VideoOptions videoOptions = VideoOptions.builder()
        .cameraOrientation(VideoOptions.CameraOrientation.FRONT)
        .build();
VideoOptions.CameraOrientation cameraOrientation = videoOptions.getCameraOrientation();

getVideoMode()

Description

Getter for the videoMode field.

Arguments

• none

Returns

• VideoOptions.VideoMode - The value of the videoMode field which configures the mode of subscription to available video streams.

Example

VideoOptions videoOptions = VideoOptions.builder()
        .videoMode(VideoOptions.VideoMode.PRESENTATION)
        .build();
VideoOptions.VideoMode videoMode = videoOptions.getVideoMode();

getVideoFilter()

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

// Create a VideoOptions object with a video filter
VideoOptions videoOptions = VideoOptions.builder()
        .videoFilter(createVideoFilter())
        .build();

// Get the video filter from the VideoOptions object
VideoFilter videoFilter = videoOptions.getVideoFilter();

getCameraVideoFrameRate()

Description

Getter for the cameraVideoFrameRate field.

Arguments

• none

Returns

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

Example

VideoOptions videoOptions = VideoOptions.builder()
        .cameraVideoFrameRate(15)
        .build();
int cameraVideoFrameRate = videoOptions.getCameraVideoFrameRate();

getScreenShareFrameRate()

Description

Getter for the screenShareFrameRate field.

Arguments

• none

Returns

• int - The value of the screenShareFrameRate field representing frame rate of the screen share video. The value ranges from 1 to 30 frames per second (fps).

Example

VideoOptions videoOptions = VideoOptions.builder()
        .screenShareFrameRate(10)
        .build();
int screenShareFrameRate = videoOptions.getScreenShareFrameRate();

Builder

• Builder cameraOrientation(CameraOrientation cameraOrientation)
• Builder videoMode(VideoMode videoMode)
• Builder videoFilter(VideoFilter videoFilter)
• Builder cameraVideoFrameRate(int cameraVideoFrameRate)
• Builder screenShareFrameRate(int screenShareFrameRate)
• VideoOptions build()

---

cameraOrientation(cameraOrientation)

Description

Setter for the cameraOrientation field.

Arguments

• cameraOrientation: CameraOrientation - Camera's orientation. CameraOrientation.FRONT by default.

Returns

• VideoOptions.Builder - Instance of the builder.

Example

VideoOptions.Builder videoOptionsBuilder = VideoOptions.builder().cameraOrientation(CameraOrientation.FRONT);

videoMode(videoMode)

Description

Setter for the videoMode field.

Arguments

• videoMode: VideoMode - Mode of subscription to available video streams. VideoMode.PRESENTATION by default.

Returns

• VideoOptions.Builder - Instance of the builder.

Example

VideoOptions.Builder videoOptionsBuilder = VideoOptions.builder().videoMode(VideoMode.PRESENTATION);

videoFilter(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

• VideoOptions.Builder - Instance of the builder.

Example

// Create a VideoOptions.Builder object and set the video filter
VideoOptions.Builder videoOptionsBuilder = VideoOptions.builder().videoFilter(createVideoFilter());

cameraVideoFrameRate(cameraVideoFrameRate)

Description

Setter for the cameraVideoFrameRate field.

Arguments

• cameraVideoFrameRate: int - Frame rate of the camera video. 24 frames per second (fps) by default.

Returns

• VideoOptions.Builder - Instance of the builder.

Example

VideoOptions.Builder videoOptionsBuilder = VideoOptions.builder().cameraVideoFrameRate(15);

screenShareFrameRate(screenShareFrameRate)

Description

Setter for the screenShareFrameRate field.

Arguments

• screenShareFrameRate: int - Frame rate of the screen share video. 8 frames per second (fps) by default.

Returns

• VideoOptions.Builder - Instance of the builder.

Example

VideoOptions.Builder videoOptionsBuilder = VideoOptions.builder().screenShareFrameRate(10);

build()

Description

Builds a new instance of the VideoOptions.

Arguments

• none

Returns

• VideoOptions - Instance of the VideoOptions.

Example

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