Skip to content

CallOptions

Adnan Mujagić edited this page Jun 11, 2024 · 4 revisions



init(audio, audioOptions, recordingOptions, customData)

Description

Creates an instance of CallOptions.

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.
  • customData: CustomData - Optional object containing custom additional information. Empty by default.

Returns

Example

let customData = ["userId": "bgxy-as45-ddf3"]
let callOptions = CallOptions(audio: false, 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 = CallOptions().audio



audioOptions

Description

Getter for the audioOptions field.

Arguments

  • none

Returns

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

Example

let audioOptions = CallOptions().audioOptions



recordingOptions

Description

Getter for the recordingOptions field.

Arguments

  • none

Returns

  • RecordingOptions - Value of the recordingOptions field containing recording configuration.

Example

let recordingOptions = CallOptions().recordingOptions



customData

Description

Getter for the customData field.

Arguments

  • none

Returns

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

Example

let customData = CallOptions().customData

Tutorials

Migration guides

Reference documentation

Clone this wiki locally