Class RemoteAudioService
The remote audio service allows to mute selected remote participants (Non-Dolby Voice conferences only) and stop and start receiving audio from remote participants.
Inherited Members
Namespace: DolbyIO.Comms.Services
Assembly: DolbyIO.Comms.Sdk.dll
Syntax
public sealed class RemoteAudioService
Examples
try
{
await _sdk.Audio.Remote.StartAsync(participantId);
await _sdk.Audio.Remote.StopAsync(participantId);
await _sdk.Audio.Remote.MuteAsync(true, participantId);
}
catch
{
// Error handling
}
Methods
| Improve this Doc View SourceMuteAsync(Boolean, String)
Stops playing the specified remote participants' audio to the local participant. The mute method does not notify the server to stop audio stream transmission. To stop receiving an audio stream from the server, use the StopAsync method.
Declaration
public async Task MuteAsync(bool muted, string participantId)
Parameters
Type | Name | Description |
---|---|---|
Boolean | muted | A boolean value that indicates the required mute state. True mutes the remote participant, false un-mutes the remote participant. |
String | participantId | The identifier of the remote participant whose audio should not be played. |
Returns
Type | Description |
---|---|
Task | A Task that represents the asynchronous operation. |
Remarks
Attention: This method is only available in non-Dolby Voice conferences.
StartAsync(String)
Start receiving the audio from a remote participant.
Declaration
public async Task StartAsync(string participantId)
Parameters
Type | Name | Description |
---|---|---|
String | participantId | The identifier of the remote participant whose audio should be sent to the local participant. |
Returns
Type | Description |
---|---|
Task | A Task that represents the asynchronous operation. |
StopAsync(String)
Stop receiving the audio from a remote participant.
Declaration
public async Task StopAsync(string participantId)
Parameters
Type | Name | Description |
---|---|---|
String | participantId | The identifier of the remote participant whose audio should not be sent to the local participant. |
Returns
Type | Description |
---|---|
Task | A Task that represents the asynchronous operation. |