RoomCallOptions

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

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

Description

Creates an instance of RoomCallOptions.

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.
• recordingOptions: RecordingOptions - Optional recording configuration to be used when making a call.
• customData: CustomData - Optional object containing custom additional information related to the outgoing call. Empty by default.
• dataChannel: Bool - Flag indicating whether the data channel should be created for the call. Disabled by default.
• autoReconnect: Bool - Optional flag indicating whether reconnect should be enabled for the room call. Disabled by default.

Returns

• RoomCallOptions - Instance of the RoomCallOptions.

Example

let customData = ["userId": "bgxy-as45-ddf3"]
let roomCallOptions = RoomCallOptions(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 = RoomCallOptions().audio

audioOptions

Description

Getter for the audioOptions field.

Arguments

• none

Returns

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

Example

let audioOptions = RoomCallOptions().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 = RoomCallOptions().video

videoOptions

Description

Getter for the videoOptions field.

Arguments

• none

Returns

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

Example

let videoOptions = RoomCallOptions().videoOptions

recordingOptions

Description

Getter for the recordingOptions field.

Arguments

• none

Returns

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

Example

let recordingOptions = RoomCallOptions().recordingOptions

customData

Description

Getter for the customData field.

Arguments

• none

Returns

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

Example

let customData = RoomCallOptions().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 = RoomCallOptions().dataChannel

autoReconnect

Description

Getter for the autoReconnect field.

Arguments

• none

Returns

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

Example

let autoReconnect = RoomCallOptions().autoReconnect