RemoteAudio
The RemoteAudio model allows the local participant to locally mute and unmute remote participants.
This model is supported only in SDK 3.7 and later.
Methods
setOutputVolume
▸ setOutputVolume(volume: number): void
Sets the conference volume for the local participant. The method sets the volume of all remote participants to a preferred value between 0 and 1. If no value is specified, the default is 1. Providing an unsupported number results in the ParameterError. This method is supported in SDK 3.11 and later.
Parameters
| Name | Type | Description |
|---|---|---|
volume | number | The preferred volume level between 0 (no audio) and 1 (full volume). |
Returns: void
setVolume
▸ setVolume(participant: Participant,volume: number): void
Sets the volume of a selected remote participant in non-Dolby Voice conferences to a preferred value between 0 and 1. If no value is specified, the default is 1. Providing an unsupported number results in the ParameterError. Using the method in Dolby Voice conferences results in the UnsupportedError. Using the method for a selected participant after calling setOutputVolume overwrites the participant's volume. This method is supported in SDK 3.11 and later.
Parameters
| Name | Type | Description |
|---|---|---|
participant | Participant | The selected remote participant. |
volume | number | The preferred volume level between 0 (no audio) and 1 (full volume). |
Returns: void
start
▸ start(participant: Participant): Promise<void>
Allows the local participant to unmute a specific remote participant who is locally muted through the stop method. The start method does not impact the audio transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. This method is not available for listeners and triggers the UnsupportedError.
The SDK automatically manages audio rendering, which means that the application does not need to implement its own element. The application can use the selectAudioInput and selectAudioOutput methods to select the proper audio input and output devices.
The startAudio method requires a few seconds to become effective.
Parameters:
| Name | Type | Description |
|---|---|---|
participant | Participant | The selected remote participant who is locally muted through the stop method. |
Returns: Promise<void>
stop
▸ stop(participant: Participant): Promise<void>
Allows the local participant to locally mute specific remote participants. This method does not impact the audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. The method is not available for listeners and triggers UnsupportedError.
The stopAudio method requires a few seconds to become effective.
Parameters:
| Name | Type | Description |
|---|---|---|
participant | Participant | The selected remote participant who should be locally muted. |
Returns: Promise<void>
Updated about 2 months ago