RoomCallOptionsBuilder

• setAudio(audio: boolean): RoomCallOptionsBuilder
• setAudioOptions(audioOptions: AudioOptions): RoomCallOptionsBuilder
• setVideo(video: boolean): RoomCallOptionsBuilder
• setVideoOptions(videoOptions: VideoOptions): RoomCallOptionsBuilder
• setRecordingOptions(recordingOptions: RoomCallRecordingOptions): RoomCallOptionsBuilder
• setCustomData(customData: CustomData): RoomCallOptionsBuilder
• setAutoRejoin(autoRejoin: boolean): RoomCallOptionsBuilder
• setDataChannel(dataChannel: boolean): RoomCallOptionsBuilder
• build(): RoomCallOptions

setAudio(audio)

Description

Setter for the audio field.

Arguments

• audio: boolean - true if the local audio should be enabled. Enabled by default. Note, access to the microphone will still be requested even if audio is false.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

let roomCallOptionsBuilder = RoomCallOptions.builder();
roomCallOptionsBuilder.setAudio(false);

setAudioOptions(audioOptions)

Description

Setter for the audioOptions field.

Arguments

• audioOptions: AudioOptions - Configuration used for the audio in the call.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

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

setVideo(video)

Description

Setter for the video field.

Arguments

• video: boolean -true if the video should be enabled. Disabled by default.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

let roomCallOptionsBuilder = RoomCallOptions.builder();
roomCallOptionsBuilder.setVideo(true);

setVideoOptions(videoOptions)

Description

Setter for the videoOptions field.

Arguments

• videoOptions: VideoOptions - Configuration used for the local video in the room call.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

let videoOptions = VideoOptions.builder().setCameraOrientation(CameraOrientation.BACK).build()
let roomCallOptionsBuilder = RoomCallOptions.builder();
roomCallOptionsBuilder.setVideoOptions(videoOptions);

setRecordingOptions(recordingOptions)

Description

Setter for the recordingOptions field.

Arguments

• recordingOptions: RoomCallRecordingOptions - Recording configuration to be used for the call.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

let recordingOptions = new RoomCallRecordingOptions("AUDIO_AND_VIDEO");
let roomCallOptionsBuilder = RoomCallOptions.builder();
roomCallOptionsBuilder.setRecordingOptions(recordingOptions);

setCustomData(customData)

Description

Setter for the customData field.

Arguments

• customData: CustomData - Object containing custom additional information related to the outgoing call. Empty by default.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

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

setAutoRejoin(autoRejoin)

Description

Setter for the autoRejoin field.

Arguments

• autoRejoin: boolean -true if the call should initiate rejoining process when the connection is lost. If successful, the call will be rejoined in the state that it was in when rejoining was initiated. For example, if the call was muted and had no video at the moment rejoining started, the rejoined call will have that same configuration. Disabled by default.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

let roomCallOptionsBuilder = RoomCallOptions.builder();
roomCallOptionsBuilder.setAutoRejoin(true);

setDataChannel(dataChannel)

Description

Setter for the dataChannel field.

Arguments

• dataChannel: boolean - true if the data channel should be created for the room call. Disabled by default.

Returns

• RoomCallOptionsBuilder - Instance of the builder.

Example

let roomCallOptionsBuilder = RoomCallOptions.builder();
roomCallOptionsBuilder.setDataChannel(true);

build()

Description

Builds a new instance of the RoomCallOptions.

Arguments

• none

Returns

• RoomCallOptions - Instance of the RoomCallOptions.

Example

let roomCallOptionsBuilder = RoomCallOptions.builder();
let roomCallOptions = roomCallOptionsBuilder.build();