ApplicationCallOptions

• init(audio: Bool = true, audioOptions: AudioOptions = AudioOptions(), video: Bool = false, videoOptions: VideoOptions = VideoOptions(), customData: CustomData = [:], dataChannel: Bool = false, platformOptions: PlatformOptions? = nil, autoReconnect: Bool = false)
• audio: Bool
• audioOptions: AudioOptions
• video: Bool
• videoOptions: VideoOptions
• customData: CustomData
• dataChannel: Bool
• platformOptions: PlatformOptions
• autoReconnect: Bool

init(audio, audioOptions, video, videoOptions, customData, dataChannel, platformOptions, autoReconnect)

Description

Creates an instance of ApplicationCallOptions.

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.
• 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 backend application.
• dataChannel: Bool - Flag indicating whether the data channel should be created for the call. Disabled by default.
• platformOptions: PlatformOptions - Optional configuration of the application and entity that the call should be associated with.
• autoReconnect: Bool - Optional flag indicating whether reconnect should be enabled for the call. Disabled by default.

Returns

• ApplicationCallOptions - Instance of the ApplicationCallOptions.

Example

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

audio

Description

Getter for the audio field.

Arguments

• none

Returns

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

Example

let audio = ApplicationCallOptions().audio

audioOptions

Description

Getter for the audioOptions field.

Arguments

• none

Returns

• AudioOptions - Value of the audioOptions field containing audio configuration.

Example

let audioOptions = ApplicationCallOptions().audioOptions

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 = ApplicationCallOptions().video

videoOptions

Description

Getter for the videoOptions field.

Arguments

• none

Returns

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

Example

let videoOptions = ApplicationCallOptions().videoOptions

customData

Description

Getter for the customData field.

Arguments

• none

Returns

• CustomData - Value of the customData field containing custom additional information.

Example

let customData = ApplicationCallOptions().customData

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 = ApplicationCallOptions().dataChannel

platformOptions

Description

Getter for the platformOptions field.

Arguments

• none

Returns

• PlatformOptions - Value of the platformOptions field. For more details, see documentation.

Example

let platformOptions = ApplicationCallOptions().platformOptions

autoReconnect

Description

Getter for the autoReconnect field.

Arguments

• none

Returns

• Bool - Value of the autoReconnect field indicating whether the call should automatically reconnect.

Example

let autoReconnect = ApplicationCallOptions().autoReconnect