NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

ConferenceJoinOptions

The ConferenceJoinOptions model defines how the application expects to join a conference. The ConferenceJoinOptions model is used in the join function and can be constructed using the ConferenceJoinOptions.Builder model.

ConferenceJoinOptions model returns:

Available in the package com.voxeet.sdk.services.builders.ConferenceJoinOptions.

Methods

getConstraints

getConstraints(): Constraints

Gets the conference WebRTC constraints.

Returns: @NonNull Constraints


getConferenceId

getConferenceId(): String

Gets the conference ID.

Returns: @Nullable String - the conference ID if it is set to a valid value, a null value otherwise.


getMaxVideoForwarding

getMaxVideoForwarding(): Integer

Provides the maximum number of video streams that may be transmitted to the local participant.

Returns: @Nullable Integer


getParamsHolder

getParamsHolder(): ParamsHolder

Gets conference parameters.

Returns: @Nullable ParamsHolder - the holder instance or a null value.


getConferenceParticipantType

getConferenceParticipantType(): ConferenceParticipantType

Gets the specified participant type.

Returns: @NonNull ConferenceParticipantType - the participant type.


getAccessToken

getAccessToken(): String

The conference access token received from the create or invite REST API. The conference access token is required to join a protected conference. For more information, see the Enhanced Conference Access Control article.

Returns: @Nullable String - access token or null.


isSpatialAudio

isSpatialAudio(): boolean

🚀

Closed Beta

This API is a part of the Beta program.

Returns true if spatial audio will be enabled for this conference. For more information, see the setSpatialAudio method.

Returns: @NonNull boolean - The spatial audio flag.


Did this page help you?