Skip to content

CallOptions

Adnan Arnautović edited this page Jan 26, 2023 · 1 revision

CallOptions(video, _ videoOptions, recordingOptions, _ customData)

Description

Creates an instance of CallOptions.

Arguments

  • 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.
  • recordingOptions: RecordingOptions - Optional recording configuration to be used when making a call.
  • customData: [String: Any] - Optional object containing custom additional information. Empty by default. This object will be forwarded to the other peer in the incoming call event.

Returns

Example

let customData = ["userId": "bgxy-as45-ddf3"]
let callOptions = CallOptions(video: true, VideoOptions(CameraOrientation.back), recordingOptions: RecordingOptions(true), 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 = CallOptions().video

videoOptions

Description

Getter for the videoOptions field.

Arguments

  • none

Returns

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

Example

let videoOptions = CalllOptions().videoOptions

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

  • [String: Any] - Value of the customData field containing custom additional information.

Example

let customData = CallOptions().customData
Clone this wiki locally