VideoOptions

• init(_ cameraOrientation: CameraOrientation, _ videoMode: VideoMode, _ cameraVideoFrameRate: Int, _ screenShareFrameRate: Int, _ videoFilter: VideoFilter?)
• cameraOrientation: CameraOrientation
• videoMode: VideoMode
• cameraVideoFrameRate: Int
• screenShareFrameRate: Int
• videoFilter: VideoFilter?

init(cameraOrientation, videoMode, cameraVideoFrameRate, screenShareFrameRate, videoFilter)

Description

Creates an instance of the VideoOptions.

Arguments

• cameraOrientation: CameraOrientation - Optional enum value representing camera facing mode for local video. Default value is .front.
• videoMode: VideoMode - Optional enum value representing video mode of the call. Default value is .presentation.
• cameraVideoFrameRate: Int - Optional value representing the camera video frame rate. Default is 24.
• screenShareFrameRate: Int - Optional value representing the screen share frame rate. Default is 8.
• videoFilter: VideoFilter? - Optional object that represents the video filter to be applied on the camera video stream. Default value is nil.

Returns

• VideoOptions - Instance of the VideoOptions.

Example

let videoOptions = VideoOptions(.front, .presentation, 30, 8, nil)

cameraOrientation

Description

Writable property representing the camera facing mode.

Example

let cameraOrientation = VideoOptions().cameraOrientation

videoMode

Description

Writable property representing the video mode of the call.

Returns

• VideoMode - Value of the videoMode field.

Example

let videoMode = VideoOptions().videoMode

cameraVideoFrameRate

Description

Writable property representing frame rate of the camera video.

Returns

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

Example

let cameraVideoFrameRate = VideoOptions().cameraVideoFrameRate

screenShareFrameRate

Description

Writable property representing frame rate of the screen share video.

Returns

• Int - 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

let screenShareFrameRate = VideoOptions().screenShareFrameRate

videoFilter

Description

Writable property representing the video filter that should be applied on the camera video stream.

Returns

• VideoFilter? - Value of the videoFilter field.

Example

let videoFilter = VideoOptions().videoFilter