Skip to main content

You are viewing Agora Docs forBetaproducts and features. Switch to Docs

  • Core Products
  • Add-Ons
  • Extensions Marketplace
Android
iOS
macOS
Web
Windows
Electron
Flutter
React Native
Python
React JS
Unity
Unreal Engine
Unreal (Blueprint)

Volume control and mute

This page shows you how to configure volume settings for audio recording, audio playback, and for the playback of music files.

Understand the tech​

Agora Voice SDK supports adjusting the audio volume for both recording and playback to meet practical application scenarios. For example, during a two-person call, you can mute a remote user by adjusting the playback volume setting to 0.

The figure below shows the workflow of adjusting the volume. VolumeControlMute

Playback refers to transmitting an audio signal from a sender to a recipient, where it is played back through a playback device.

In-ear monitoring refers to the process of playing audio captured by a device.

Recording refers to the process in which audio signals are captured by a recording device and then sent to the transmitter.

Caution
If you set the volume too high using the signal volume adjustment methods, it may lead to audio distortion on some devices.

Prerequisites​

Ensure that you have implemented the SDK quickstart in your project.

Implement volume control​

Use one or more of the following volume control methods to adjust volume settings.

Adjust the playback volume​

Call adjustPlaybackSignalVolume or adjustUserPlaybackSignalVolume to adjust the volume of the audio playback signal.


_6
int volume = 50;s
_6
int uid = 123456;
_6
// Set the local playback volume for all remote users
_6
mRtcEngine.adjustPlaybackSignalVolume(volume);
_6
// Set the local playback volume for a specific remote user. For example, a user with uid=123
_6
mRtcEngine.adjustUserPlaybackSignalVolume(uid, volume)

Adjust the in-ear monitoring volume​

During the process of audio capture, mixing, and playback, Agora enables you to adjust the in-ear monitoring volume. Enable and set the volume using enableInEarMonitoring and setInEarMonitoringVolume.


_5
// Enable in-ear monitoring
_5
mRtcEngine.enableInEarMonitoring(true);
_5
int volume = 50;
_5
// Adjust in-ear monitoring volume
_5
mRtcEngine.setInEarMonitoringVolume(volume);

Adjust the recording volume​

Call adjustRecordingSignalVolume to adjust the volume of the audio recording signal.


_6
ChannelMediaOptions options = new ChannelMediaOptions();
_6
options.clientRoleType = Constants.CLIENT_ROLE_BROADCASTER;
_6
mRtcEngine.joinChannel(token, channelName, 1234, options);
_6
// Adjust the recording signal volume to 50
_6
int vol = 50;
_6
mRtcEngine.adjustRecordingSignalVolume(vol);

When configuring audio settings, it's essential to understand the default behavior and the options available. Here are the key points to keep in mind:

  • The SDK defaults to a device volume of 85 when using the recording device to capture audio signals.
  • A volume of 0 means mute, and a volume of 255 represents the maximum volume of the device.
  • If the SDK detects that the recording volume is too low in the current environment, it automatically increases the volume of the recording device.
  • The volume of the recording device directly influences the global volume of the device.
  • If the default recording device volume does not meet your requirements, adjust it by regulating the signal amplitude captured by the microphone or sound card.

Mute and unmute users​

To mute or unmute the local audio stream, call muteLocalAudioStream:


_5
// Stop publishing the local audio stream
_5
mRtcEngine.muteLocalAudioStream(true);
_5
_5
// Resume publishing the local audio stream
_5
mRtcEngine.muteLocalAudioStream(false);

To mute or unmute a remote user, call muteRemoteAudioStream with the uid of the remote user:


_5
// Stop subscribing to the audio stream of the remote user
_5
mRtcEngine.muteRemoteAudioStream(remoteUid, true);
_5
_5
// Resume subscribing to the audio stream of the remote user
_5
mRtcEngine.muteRemoteAudioStream(remoteUid, false);

Get volume information of users​

Voice SDK enables you to obtain the user IDs and corresponding volumes of the three users with the highest instantaneous volumes in a channel during the process of audio recording, mixing, and playback. You use the onAudioVolumeIndication callback to obtain this information. A returned uid of 0 in the callback indicates the local user.


_9
private final IRtcEngineEventHandler mRtcEventHandler = new IRtcEngineEventHandler()
_9
{
_9
...
_9
// Retrieve the user IDs of the three users with the highest instantaneous speaking volume,
_9
// their respective volumes, and determine whether the local user is speaking.
_9
@Override
_9
public void onAudioVolumeIndication(AudioVolumeInfo[] speakers, int totalVolume) {
_9
}
_9
};

Note
Call enableAudioVolumeIndication to enable reporting of the users' volume in the callback.

_2
// Enable the onAudioVolumeIndication callback
_2
mRtcEngine.enableAudioVolumeIndication(1000, 3, true);

Reference​

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Voice Calling