功能描述

在使用我们 SDK 时,开发者可以对 SDK 采集到的声音及 SDK 播放到声卡的声音音量进行调整,以满足产品在声音上的个性化需求。比如进行双人通话时,想实现静音操作,可以通过调整播放音量的接口将音量设置为 0。

本文梳理了在使用 SDK 从音频采集到播放各阶段中,用户可能需要调整音量的场景、各场景对应的 API 及其使用注意事项。

实现方法

开始前请确保你已完成环境准备、安装包获取等步骤,详见集成客户端

设置采集音量

采集是指音频信号由录音设备采集后传输到发送端的过程。这个过程中你可以使用 SDK 的接口直接调整录制声音的信号幅度,以调整录音的音量。

调节音量的参数值范围是 0 - 400,默认值 100 表示原始音量,即不对信号做缩放,400 表示原始音量的 4 倍(把信号放大到原始信号的 4 倍)。

int volume = 200;
// 设置录音信号音量
rtcEngine.adjustRecordingSignalVolume(volume);

API 参考

设置播放音量

播放是指音频信号从发送端进入到接收端,然后使用播放设备进行播放的过程。这个过程中你可以使用 SDK 的接口直接调整播放声音的信号幅度,以调整播放的音量。

调节音量的参数值范围是 0 - 400,默认值 100 表示原始音量,即不对信号做缩放,400 表示原始音量的 4 倍(把信号放大到原始信号的 4 倍)。

int volume = 200;
// 设置播放信号音量
rtcEngine.adjustPlaybackSignalVolume(volume);

API 参考

设置混音音量

混音是指播放本地或者在线音乐文件,同时让频道内的其他人听到此音乐。你可以参考音乐混音开启混音功能。

调节混音音量的参数值范围是 0 - 100,默认值 100 表示原始文件音量,即不对信号做缩放。0 表示混音文件播放静音。

int volume = 50;
// 设置远端用户听到的音乐文件音量
rtcEngine.adjustAudioMixingPublishVolume(volume);
// 设置本地用户听到的音乐文件音量
rtcEngine.adjustAudioMixingPlayoutVolume(volume);

你也可以直接调用 adjustAudioMixingVolume,同时设置本地及远端用户听到的音乐文件音量。

int volume = 50;
// 设置本地及远端用户听到的音乐文件音量
rtcEngine.adjustAudioMixingVolume(volume);

API 参考

设置音效音量

播放音效是指播放短小的音频,如鼓掌、子弹撞击的声音等。你可以参考播放音效开启音效播放。

调节音效音量的参数值范围是 0.0 - 100.0,默认值 100.0 表示原始音效音量,即不对信号做缩放。0.0 表示音效文件播放静音。

// 获取全局的音效管理类
IAudioEffectManager manager = rtcEngine.getAudioEffectManager();
...
// 设置音效音量为原始音量的 50%
double volume = 50.0
// 设置所有音效的播放音量
manager.setEffectsVolume(volume);
// 设置单个音效的播放音量
// soundId 是你在调用 playEffect 时设置的音效 ID
manager.setVolumeOfEffect(soundId, volume);

API 参考

设置耳返音量

在音频采集、混音、播放的整个过程中,你都可以使用 setInEarMonitoringVolume 调整耳返的音量。

调节耳返音量的参数值范围是 0 - 100,默认值 100 表示原始音效音量,即不对信号做缩放。0 表示耳返静音。

// 开启耳返监听功能
rtcEngine.enableInEarMoniroting(true);
int volume = 50;
// 设置耳返音量为原始音量的 50%
rtcEngine.setInEarMonitoringVolume(volume);

API 参考

获取用户音量(回调方法)

在音频采集、混音、播放的整个过程中,你都可以使用下面的接口获取用户音量。

  • 瞬时说话声音音量提示。如下回调获取瞬时说话音量最大的用户 ID,及音量大小。如果返回的用户 ID 为 0,则表示瞬时说话音量最大的是本地用户。
/**
 * 获取瞬时说话音量最大的几个用户 ID
 * @param speakers 为一个数组,包含说话者的用户 ID 及音量,音量范围为 0 - 255
 * @param totalVolume 指混音后频道内的总音量,范围为 0 - 255
 */
public void onAudioVolumeIndication(AudioVolumeInfo[] speakers, int totalVolume) {
}
  • 当前时间内累积音量最大者。如下回调获取获取特定时间段内,累积音量最大的用户 ID。如果返回的 uid 是 0,则默认为本地用户。
// 获取当前时间段声音最大的用户 ID(仅 1 个)
public void onActiveSpeaker(int uid) {
}

API 参考

开发注意事项

  • 所有相关的方法都有返回值。返回值小于 0 表示方法调用失败
  • 如果信号音量设置太大,由于硬件设备的限制,在某些设备上可能会出现声音不自然的效果。