RoomCallOptions

• static builder(): RoomCallOptionsBuilder
• audio(): boolean
• audioOptions(): AudioOptions
• video(): boolean
• videoOptions(): VideoOptions
• recordingOptions(): RoomCallRecordingOptions
• customData(): CustomData
• autoRejoin(): boolean
• dataChannel(): boolean

static builder()

Description

Creates a builder instance used to build a new instance of RoomCallOptions.

Arguments

• none

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

let roomCallOptionsBuilder = RoomCallOptions.builder();

audio()

Description

Getter for the audio field.

Arguments

• none

Returns

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

Example

let roomCallOptions = RoomCallOptions.builder().setAudio(false).build();
let audio = roomCallOptions.audio;

audioOptions()

Description

Getter for the audioOptions field.

Arguments

• none

Returns

• AudioOptions - Value of the audioOptions field indicating what configuration should be used for the audio.

Example

let roomCallOptions = RoomCallOptions.builder()
    .setAudioOptions(AudioOptions.builder().lowDataMode(true).build())
    .build();
let audioOptions = roomCallOptions.audioOptions;

video()

Description

Getter for the video field.

Arguments

• none

Returns

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

Example

let roomCallOptions = RoomCallOptions.builder().setVideo(true).build();
let video = roomCallOptions.video;

videoOptions()

Description

Getter for the videoOptions field.

Arguments

• none

Returns

• VideoOptions - Value of the videoOptions field indicating what configuration should be used for the local video.

Example

let roomCallOptions = RoomCallOptions.builder()
    .setVideo(true)
    .setVideoOptions(VideoOptions.builder().setCameraOrientation(CameraOrientation.BACK).build())
    .build();
let videoOptions = roomCallOptions.videoOptions;

recordingOptions()

Description

Getter for the recordingOptions field.

Arguments

• none

Returns

• RoomCallRecordingOptions - Value of the recordingOptions field representing the recording configuration to be used for this room call.

Example

let recordingOptions = new RoomCallRecordingOptions("AUDIO_AND_VIDEO");
let roomCallOptions = RoomCallOptions.builder().setRecordingOptions(recordingOptions).build();
let roomCallRecordingOptions = roomCallOptions.recordingOptions;

customData()

Description

Getter for the customData field.

Arguments

• none

Returns

• CustomData - Value of the customData field that is defined as an object of key-value string pairs.

Example

let roomCallOptions = RoomCallOptions.builder().setCustomData({"city": "New York"}).build();
let customData = roomCallOptions.customData;

autoRejoin()

Description

Getter for the autoRejoin field.

Arguments

• none

Returns

• boolean - Value of the autoRejoin field indicating whether the room call should initiate rejoining process when connection is lost.

Example

let roomCallOptions = RoomCallOptions.builder().setAutoRejoin(true).build();
let isAutoRejoin = roomCallOptions.autoRejoin;

dataChannel()

Description

Getter for the dataChannel field.

Arguments

• none

Returns

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

Example

let roomCallOptions = RoomCallOptions.builder().setDataChannel(true).build();
let isDataChannel = roomCallOptions.dataChannel;