ConferenceJoinOptions.Builder
The ConferenceJoinOptions.Builder model constructs the ConferenceJoinOptions model that defines how the application expects to join a conference.
Available in the package com.voxeet.sdk.services.builders.ConferenceJoinOptions.Builder.
Constructors
Builder
▸ Builder(@NonNull conference: Conference)
Creates a new builder.
Parameters
| Name | Type | Description |
|---|---|---|
| conference | Conference | non null valid conference. |
Methods
setConstraints
▸ setConstraints(@NonNull constraints: Constraints): ConferenceJoinOptions.Builder
Parameters
| Name | Type | Description |
|---|---|---|
| constraints | Constraints | non null |
Returns: ConferenceJoinOptions.Builder
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
| Name | Type | Description |
|---|---|---|
| conferenceParticipantType | ConferenceParticipantType | non null specified type of the conference participant |
Returns: ConferenceJoinOptions.Builder - the builder instance.
setVideoForwardingStrategy
▸ setVideoForwardingStrategy(@NonNull videoForwardingStrategy: VideoForwardingStrategy): ConferenceJoinOptions.Builder
Changes the video forwarding strategy for the local participant. This method is available only in SDK 3.6 and later.
Parameters
| Name | Type | Description |
|---|---|---|
| videoForwardingStrategy | VideoForwardingStrategy | non null The strategy that defines how the SDK should select conference participants whose videos will be received by the local participant. The selection can be either based on the participants' audio volume or the distance from the local participant. |
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 25.
This property is available in SDK 3.1 and later.
Parameters
| Name | Type | Description |
|---|---|---|
| max | int | The maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 25. The default value is 4. In the case of providing a value smaller than 0, SDK triggers the IllegalStateException error. In the case of providing a value greater than 25, the Dolby.io server triggers an error. |
Returns: ConferenceJoinOptions.Builder - the builder instance.
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
| Name | Type | Description |
|---|---|---|
| conferenceAccessToken | String | non null the Conference Access Token |
Returns: ConferenceJoinOptions.Builder - the builder instance.
setSpatialAudio
▸ setSpatialAudio(@NonNull spatialAudio: boolean): ConferenceJoinOptions.Builder
Enables spatial audio for the local participant who joins a Dolby Voice conference. By default, this parameter is set to false. When set to true in a conference that uses the individual spatial audio style, the application must place remote participants in a 3D space using the setSpatialPosition method.
Warning
In the individual spatial audio style, 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
| Name | Type | Description |
|---|---|---|
| spatialAudio | boolean | non null A flag indicating if the local participant wants to join a conference with spatial audio enabled. |
Returns: ConferenceJoinOptions.Builder - The builder instance.
build
▸ build(): ConferenceJoinOptions
Constructs the corresponding ConferenceJoinOptions from the data set.
Returns: @NonNull ConferenceJoinOptions - a new valid instance of the conference join representation.
Warning
In the individual spatial audio style, 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
| Name | Type | Description |
|---|---|---|
| spatialAudio | boolean | non null A flag indicating if the local participant wants to join a conference with spatial audio enabled. |
Returns: ConferenceJoinOptions.Builder - The builder instance.
build
▸ build(): ConferenceJoinOptions
Constructs the corresponding ConferenceJoinOptions from the data set.
Returns: @NonNull ConferenceJoinOptions - a new valid instance of the conference join representation.
Updated 7 months ago