ConferenceListenOptions.Builder
The ConferenceListenOptions.Builder model is responsible for creating the ConferenceListenOptions instance.
Available in the package com.voxeet.sdk.services.builders.ConferenceListenOptions.Builder.
Methods
setVideoForwardingStrategy
▸ setVideoForwardingStrategy(@NonNull videoForwardingStrategy: VideoForwardingStrategy): ConferenceListenOptions.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: ConferenceListenOptions.Builder
setMaxVideoForwarding
▸ setMaxVideoForwarding(max: int): ConferenceListenOptions.Builder
Sets the maximum number of video streams that may be transmitted to the joining participant. The valid values are between 0 and 49.
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 49. 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 49, the Dolby.io server triggers an error. |
Returns: ConferenceListenOptions.Builder - the builder instance.
setConferenceAccessToken
▸ setConferenceAccessToken(@NonNull conferenceAccessToken: String): ConferenceListenOptions.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: ConferenceListenOptions.Builder - the builder instance.
setSpatialAudio
▸ setSpatialAudio(@NonNull spatialAudio: boolean): ConferenceListenOptions.Builder
Enables spatial audio for the local participant who joins a Dolby Voice conference. By default, this parameter is set to false.
Parameters
| Name | Type | Description |
|---|---|---|
| spatialAudio | boolean | non null A flag indicating if spatial audio should be enabled. |
Returns: ConferenceListenOptions.Builder - the builder instance.
build
▸ build(): ConferenceListenOptions
Constructs the corresponding ConferenceListenOptions from the data set.
Returns: @NonNull ConferenceListenOptions - a new valid instance of the conference listen representation.
Updated about 1 month ago