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

ConferenceJoinOptions.Builder

The ConferenceJoinOptions.Builder model allows setting:

This model also allows constructing the ConferenceJoinOptions model.

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

Constructors

Builder

Builder(@NonNull conference: Conference)

Creates a new builder.

Parameters

NameTypeDescription
conferenceConferencenon null valid conference.

Methods

build

build(): ConferenceJoinOptions

Constructs the corresponding ConferenceJoinOptions from the data set.

Returns: @NonNull ConferenceJoinOptions - a new valid instance of the conference join representation.


setConferenceAccessToken

setConferenceAccessToken(@NonNull conferenceAccessToken: String): ConferenceJoinOptions.Builder

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.

Parameters

NameTypeDescription
conferenceAccessTokenStringnon null the Conference Access Token

Returns: ConferenceJoinOptions.Builder - the builder instance.


setConferenceParticipantType

setConferenceParticipantType(@NonNull conferenceParticipantType: ConferenceParticipantType): ConferenceJoinOptions.Builder

Sets the type of the joining participant, from a local point of view.
There are the following participant types:

  • normal - the default value
  • broadcaster - a participant can actively participate in a conference and transmit media to the rest of conference participants
  • listener - a participant can only listen to a conference and cannot actively participate

Parameters

NameTypeDescription
conferenceParticipantTypeConferenceParticipantTypenon null specified type of the conference participant

Returns: ConferenceJoinOptions.Builder - the builder instance.


setConstraints

setConstraints(@NonNull constraints: Constraints): ConferenceJoinOptions.Builder

Parameters

NameTypeDescription
constraintsConstraintsnon null

Returns: ConferenceJoinOptions.Builder


setMaxVideoForwarding

setMaxVideoForwarding(max: int): ConferenceJoinOptions.Builder

Sets the maximum number of video streams that may be transmitted to the joining participant. The valid values are between 0 and 4.

Parameters

NameTypeDescription
maxintthe maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 4. The default value is 4. In the case of providing a value smaller than 0 or greater than 4, SDK triggers the IllegalStateException error.

Returns: ConferenceJoinOptions.Builder - the builder instance.


setSpatialAudio

setSpatialAudio(@NonNull spatialAudio: boolean): ConferenceJoinOptions.Builder

🚀

Closed Beta

This API is a part of the Beta program.

Allows the local participant to change remote participants' locations and experience spatial audio. By default, this parameter is set to false. When set to true, the application must place remote participants in a 3D space using the setSpatialPosition method.

❗️

Warning

Remote participants' audio is disabled until the participants are assigned to specific locations. We recommend calling setSpatialPosition from participantAddedEvent event to ensure that all participants are assigned to specific positions.

Parameters

NameTypeDescription
spatialAudiobooleannon nullA flag indicating if the local participant wants to join a conference with spatial audio enabled.

Returns: ConferenceJoinOptions.Builder - The builder instance.



Did this page help you?