ApplicationCallOptions

• static ApplicationCallOptions.Builder builder()
• boolean isAudio()
• AudioOptions getAudioOptions()
• boolean isVideo()
• VideoOptions getVideoOptions()
• Map<String, String> getCustomData()
• boolean isDataChannel()
• PlatformOptions getPlatformOptions()
• static class Builder

builder()

Description

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

Arguments

• none

Returns

• ApplicationCallOptions.Builder - Instance of the builder.

Example

ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.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

ApplicationCallOptions applicationCallOptions = ApplicationCallOptions.builder().audio(false).build();
boolean audio = applicationCallOptions.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

ApplicationCallOptions applicationCallOptions = ApplicationCallOptions.builder()
        .audioOptions(AudioOptions.builder().lowDataMode(true).build())
        .build();
AudioOptions audioOptions = applicationCallOptions.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

ApplicationCallOptions applicationCallOptions = ApplicationCallOptions.builder().video(true).build();
boolean video = applicationCallOptions.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

ApplicationCallOptions applicationCallOptions = ApplicationCallOptions.builder()
        .videoOptions(VideoOptions.builder().cameraOrientation(VideoOptions.CameraOrientation.BACK).build())
        .build();
VideoOptions videoOptions = applicationCallOptions.getVideoOptions();

getCustomData()

Description

Getter for the customData field.

Arguments

• none

Returns

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

Example

ApplicationCallOptions options = ApplicationCallOptions.builder().customData(Map.of("username", "Alice")).build();
Map<String, String> customData = options.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

ApplicationCallOptions applicationCallOptions = ApplicationCallOptions.builder().dataChannel(true).build();
boolean dataChannel = applicationCallOptions.isDataChannel();

getPlatformOptions()

Description

Getter for the platformOptions field.

Arguments

• none

Returns

• PlatformOptions - Value of the platformOptions field. For more details, see documentation.

Example

ApplicationCallOptions applicationCallOptions = ApplicationCallOptions.builder()
        .platformOptions(PlatformOptions.builder().applicationId("my-application-id").entityId("my-entity-id").build())
        .build();
PlatformOptions platformOptions = applicationCallOptions.getPlatformOptions();

Builder

• Builder audio(boolean audio)
• Builder video(boolean video)
• Builder audioOptions(AudioOptions audioOptions)
• Builder videoOptions(VideoOptions videoOptions)
• Builder customData(Map<String, String> customData)
• Builder dataChannel(boolean dataChannel)
• Builder platformOptions(PlatformOptions platformOptions)
• ApplicationCallOptions build()

---

audio(audio)

Description

Setter for the audio field.

Arguments

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

Returns

• ApplicationCallOptions.Builder - Instance of the builder.

Example

ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.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

• ApplicationCallOptions.Builder - Instance of the builder.

Example

ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.builder().video(true);

audioOptions(audioOptions)

Description

Setter for the audioOptions field.

Arguments

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

Returns

• ApplicationCallOptions.Builder - Instance of the builder.

Example

AudioOptions audioOptions = AudioOptions.builder().lowDataMode(true).build();
ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.builder().audioOptions(audioOptions);

videoOptions(videoOptions)

Description

Setter for the videoOptions field.

Arguments

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

Returns

• ApplicationCallOptions.Builder - Instance of the builder.

Example

VideoOptions videoOptions = VideoOptions.builder().cameraOrientation(VideoOptions.CameraOrientation.BACK).build();
ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.builder().videoOptions(videoOptions);

customData(customData)

Description

Setter for the customData field.

Arguments

• customData: Map<String, String> - Object containing custom additional information. Empty by default. This object will be forwarded to the backend application.

Returns

• ApplicationCallOptions.Builder - Instance of the builder.

Example

Map<String, String> customData = Map.of("username", "Alice");
ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.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

• ApplicationCallOptions.Builder - Instance of the builder.

Example

ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.builder().dataChannel(true);

platformOptions(platformOptions)

Description

Setter for the platformOptions field.

Arguments

• platformOptions: PlatformOptions - Configuration of the application and entity that the call should be associated with.

Returns

• ApplicationCallOptions.Builder - Instance of the builder.

Example

ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.builder()
        .platformOptions(PlatformOptions.builder().applicationId("my-application-id").entityId("my-entity-id").build());

build()

Description

Builds a new instance of the ApplicationCallOptions.

Arguments

• none

Returns

• ApplicationCallOptions - Instance of the ApplicationCallOptions.

Example

ApplicationCallOptions.Builder applicationCallOptionsBuilder = ApplicationCallOptions.builder();
ApplicationCallOptions applicationCallOptions = applicationCallOptionsBuilder.build();