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.

Available in the package



getConstraints(): Constraints

Gets the conference WebRTC constraints.

Returns: @NonNull Constraints


getConferenceId(): String

Gets the conference ID.

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


getVideoForwardingStrategy(): VideoForwardingStrategy

Gets the video forwarding strategy that the local participant uses in the current conference. This method is available only in SDK 3.6 and later.

Returns: @NonNull VideoForwardingStrategy


getMaxVideoForwarding(): Integer

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

Returns: @Nullable Integer


getParamsHolder(): ParamsHolder

Gets conference parameters.

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


getConferenceParticipantType(): ConferenceParticipantType

Gets the specified participant type.

Returns: @NonNull ConferenceParticipantType - the participant type.


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(): boolean

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

Returns: boolean - The spatial audio flag.