The ConferenceJoinOptions model contains constraints, the conference ID, conference parameters, specific type of conference participants, and the maximum number of video streams that may be transmitted to the local participant. The ConferenceJoinOptions model is used in the join function and can be constructed using the ConferenceJoinOptions.Builder model.

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

Methods

getConstraints

▸ getConstraints(): 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. It is used locally.

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.