RoomCallOptions

• static RoomCallOptions.Builder builder()
• boolean isAudio()
• AudioOptions getAudioOptions()
• boolean isVideo()
• VideoOptions getVideoOptions()
• RecordingOptions getRecordingOptions()
• Map<String, String> getCustomData()
• boolean isDataChannel()
• boolean isAutoRejoin()
• static class Builder

builder()

Description

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

Arguments

• none

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder();

isAudio()

Description

Getter for the audio field.

Arguments

• none

Returns

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

Example

RoomCallOptions roomCallOptions = RoomCallOptions.builder().audio(false).build();
boolean audio = roomCallOptions.isAudio();

getAudioOptions()

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

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

isVideo()

Description

Getter for the video field.

Arguments

• none

Returns

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

Example

RoomCallOptions roomCallOptions = RoomCallOptions.builder().video(true).build();
boolean video = roomCallOptions.isVideo();

getVideoOptions()

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

RoomCallOptions roomCallOptions = RoomCallOptions.builder()
        .videoOptions(VideoOptions.builder().cameraOrientation(VideoOptions.CameraOrientation.BACK).build())
        .build();
VideoOptions videoOptions = roomCallOptions.getVideoOptions();

getRecordingOptions()

Description

Getter for the recordingOptions field.

Arguments

• none

Returns

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

Example

RoomCallOptions roomCallOptions = RoomCallOptions.builder()
        .recordingOptions(RecordingOptions.builder().recordingType(RecordingType.AUDIO_AND_VIDEO).build())
        .build();
RecordingOptions recordingOptions = roomCallOptions.getRecordingOptions();

getCustomData()

Description

Getter for customData field.

Arguments

• none

Returns

• Map<String, String> - Value of the customData field representing the additional custom information added to the call options.

Example

RoomCallOptions roomCallOptions = RoomCallOptions.builder()
        .customData(Map.of("username", "Alice"))
        .build();
Map<String, String> customData = roomCallOptions.getCustomData();

isDataChannel()

Description

Getter for the dataChannel field.

Arguments

• none

Returns

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

Example

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

isAutoRejoin()

Description

Getter for the autoRejoin field.

Arguments

• none

Returns

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

Example

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

Builder

• Builder audio(boolean audio)
• Builder video(boolean video)
• Builder audioOptions(AudioOptions audioOptions)
• Builder videoOptions(VideoOptions videoOptions)
• Builder recordingOptions(RecordingOptions recordingOptions)
• Builder customData(Map<String, String> customData)
• Builder dataChannel(boolean dataChannel)
• Builder autoRejoin(boolean autoRejoin)
• RoomCallOptions build()

---

audio(audio)

Description

Setter for the audio field.

Arguments

• audio: boolean - true if the local audio should be enabled. Enabled by default.

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder().audio(false);

video(video)

Description

Setter for the video field.

Arguments

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

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder().video(true);

audioOptions(audioOptions)

Description

Setter for the audioOptions field.

Arguments

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

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

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

videoOptions(videoOptions)

Description

Setter for the videoOptions field.

Arguments

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

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

VideoOptions videoOptions = VideoOptions.builder().cameraOrientation(VideoOptions.CameraOrientation.BACK).build();
RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder().videoOptions(videoOptions);

recordingOptions(recordingOptions)

Description

Setter for the recordingOptions field.

Arguments

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

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

RecordingOptions recordingOptions = RecordingOptions.Builder.recordingType(RecordingType.AUDIO_AND_VIDEO).build();
RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder().recordingOptions(recordingOptions);

customData(customData)

Description

Setter for the customData field.

Arguments

• customData: Map<String, String> - Object containing custom additional information related to the outgoing call. Empty by default.

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

Map<String, String> customData = Map.of("username", "Alice");
RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder().customData(customData);

dataChannel(dataChannel)

Description

Setter for the dataChannel field.

Arguments

• dataChannel: boolean - true if the data channel should be enabled. Disabled by default.

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder().dataChannel(true);

autoRejoin(autoRejoin)

Description

Setter for the autoRejoin field.

Arguments

• autoRejoin: boolean - true if the the room call should initiate rejoining process when the connection is lost.

Returns

• RoomCallOptions.Builder - Instance of the builder.

Example

RoomCallOptions.Builder roomCallOptionsBuilder = RoomCallOptions.builder().autoRejoin(true);

build()

Description

Builds a new instance of the RoomCallOptions.

Arguments

• none

Returns

• RoomCallOptions - Instance of the RoomCallOptions.

Example

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