WebrtCallOptions

extends CallOptions

• init(audio: Bool = true, audioOptions: AudioOptions = AudioOptions(), recordingOptions: RecordingOptions = RecordingOptions(), video: Bool = false, videoOptions: VideoOptions = VideoOptions(), customData: CustomData = [:], dataChannel: Bool = false
• video: Bool
• videoOptions: VideoOptions
• dataChannel: Bool

init(audio, audioOptions, recordingOptions, video, videoOptions, customData, dataChannel)

Description

Creates an instance of WebrtcCallOptions.

Arguments

• audio: Bool - Flag indicating whether the local audio should be enabled for the call. Enabled by default.
• audioOptions: AudioOptions - Optional audio configuration to be used when making a call.
• recordingOptions: RecordingOptions - Optional recording configuration to be used when making a call.
• video: Bool - Flag indicating whether the local video should be enabled for the call. Disabled by default.
• videoOptions: VideoOptions - Optional video configuration to be used when making a call.
• customData: CustomData - Optional object containing custom additional information. Empty by default. This object will be forwarded to the remote endpoint in the incoming call event.
• dataChannel: Bool - Flag indicating whether the data channel should be created for the call. Disabled by default.

Returns

• WebrtcCallOptions - Instance of the WebrtcCallOptions.

Example

let customData = ["userId": "bgxy-as45-ddf3"]
let webrtcCallOptions = WebrtcCallOptions(video: true, videoOptions: VideoOptions(CameraOrientation.back), customData: customData)

video

Description

Getter for the video field.

Arguments

• none

Returns

• Bool - Value of the video field indicating whether the call should include local video.

Example

let video = WebrtcCallOptions().video

videoOptions

Description

Getter for the videoOptions field.

Arguments

• none

Returns

• VideoOptions - Value of the videoOptions field containing video configuration.

Example

let videoOptions = WebrtcCallOptions().videoOptions

dataChannel

Description

Getter for the dataChannel field.

Arguments

• none

Returns

• Bool - Value of the dataChannel field indicating whether the data channel should be created for a call.

Example

let dataChannel = WebrtcCallOptions().dataChannel