Mute and Unmute Other Participants

In a SIP call or a regular conference, anyone can mute or unmute themselves or others locally. If a client requires the ability to mute or unmute a participant globally in a channel so that no one can see and hear the person, they must have appropriate permissions assigned. To grant a client the permissions, see Grant Client Permissions.

To mute or unmute audio or video in a channel:

  1. Turn on or off the audio or video in the following channel configurations:

    • For all connections: channelConfig
    • For all connections belonging to a specific user: channelUserConfig
    • For all connections belonging to a specific user and device: channelDeviceConfig
    • For all connections belonging to a specific user, device, and client: channelClientConfig
    • For a specific connection belonging to a specific user, device, and client: channelConnectionConfig

  2. Pass the configurations to the following methods of the channel:

    • For all connections: update
    • For all connections belonging to a specific user: updateUser
    • For all connections belonging to a specific user and device: updateDevice
    • For all connections belonging to a specific user, device, and client: updateClient
    • For a specific connection belonging to a specific user, device, and client: udpateConnection
Note

About the code examples on this page:

  • For .NET MAUI and Unity, use the C# code.
  • For macOS, use the iOS code.
public Future<object> ToggleAudioMuted(bool audioMuted)
{
    var channelConfig = new ChannelConfig();
    channelConfig.AudioMuted = audioMuted;
    return _Channel.Update(channelConfig);
}

public Future<object> ToggleVideoMuted(bool videoMuted)
{
    var channelConfig = new ChannelConfig();
    channelConfig.VideoMuted = videoMuted;
    return _Channel.Update(channelConfig);
}

public Future<object> ToggleUserAudioMuted(string userId, bool audioMuted)
{
    var channelUserConfig = new ChannelUserConfig();
    channelUserConfig.AudioMuted = audioMuted;
    return _Channel.UpdateUser(userId, channelUserConfig);
}

public Future<object> ToggleUserVideoMuted(string userId, bool videoMuted)
{
    var channelUserConfig = new ChannelUserConfig();
    channelUserConfig.VideoMuted = videoMuted;
    return _Channel.UpdateUser(userId, channelUserConfig);
}

public Future<object> ToggleDeviceAudioMuted(string userId, string deviceId, bool audioMuted)
{
    var channelDeviceConfig = new ChannelDeviceConfig();
    channelDeviceConfig.AudioMuted = audioMuted;
    return _Channel.UpdateDevice(userId, deviceId, channelDeviceConfig);
}

public Future<object> ToggleDeviceVideoMuted(string userId, string deviceId, bool videoMuted)
{
    var channelDeviceConfig = new ChannelDeviceConfig();
    channelDeviceConfig.VideoMuted = videoMuted;
    return _Channel.UpdateDevice(userId, deviceId, channelDeviceConfig);
}

public Future<object> ToggleClientAudioMuted(string userId, string deviceId, string clientId, bool audioMuted)
{
    var channelClientConfig = new ChannelClientConfig();
    channelClientConfig.AudioMuted = audioMuted;
    return _Channel.UpdateClient(userId, deviceId, clientId, channelClientConfig);
}

public Future<object> ToggleClientVideoMuted(string userId, string deviceId, string clientId, bool videoMuted)
{
    var channelClientConfig = new ChannelClientConfig();
    channelClientConfig.VideoMuted = videoMuted;
    return _Channel.UpdateClient(userId, deviceId, clientId, channelClientConfig);
}

public Future<object> ToggleConnectionAudioMuted(string userId, string deviceId, string clientId, string connectionId, bool audioMuted)
{
    var channelConnectionConfig = new ChannelConnectionConfig();
    channelConnectionConfig.AudioMuted = audioMuted;
    return _Channel.UpdateConnection(userId, deviceId, clientId, connectionId, channelConnectionConfig);
}

public Future<object> ToggleConnectionVideoMuted(string userId, string deviceId, string clientId, string connectionId, bool videoMuted)
{
    var channelConnectionConfig = new ChannelConnectionConfig();
    channelConnectionConfig.VideoMuted = videoMuted;
    return _Channel.UpdateConnection(userId, deviceId, clientId, connectionId, channelConnectionConfig);
}

See also: