调整通话音量

功能描述

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

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

示例项目

我们在 GitHub 上提供已实现调整录音、播放、耳返音量的开源示例项目 JoinChannelAudio。你可以下载体验并参考源代码。

实现方法

在调整通话音量前，请确保已在你的项目中实现基本的实时音视频功能。详见实现音视频通话或实现互动直播。

设置采集音量

采集是指音频信号由录音设备采集后传输到发送端的过程。

你可以通过 adjustRecordingSignalVolume 方法直接调节录制声音的信号幅度，由此实现调节录音的音量。

该方法中 volume 参数表示录音信号的音量，取值范围为 [0, 100]：

• 0: 静音。
• 100: （默认值）原始音量，即不对信号做缩放。

示例代码

// swift
// 将录音音量设置为 50。
agoraKit.adjustRecordingSignalVolume(50)

//objective-c
// 将录音音量设置为 50。
[agoraKit adjustRecordingSignalVolume: 50];

API 参考

• adjustRecordingSignalVolume

设置播放音量

播放是指音频信号从发送端进入到接收端，然后使用播放设备进行播放的过程。

你可以通过 adjustPlaybackSignalVolume 方法或 adjustUserPlaybackSignalVolume 方法直接调节播放声音的信号幅度，由此实现调节播放的音量。

• adjustPlaybackSignalVolume：
  • 用于调节本地播放的所有远端用户混音后的音量。
  • 该方法中 volume 参数表示播放音量，取值范围为 [0, 400]。
• adjustUserPlaybackSignalVolume：
  • 用于调节本地播放的指定远端用户混音后的音量。你可以多次调用该方法来调节不同远端用户在本地播放的音量，或对某个远端用户在本地播放的音量调节多次。
  • 该方法中 volume 参数表示播放音量，取值范围为 [0, 100]。

示例代码

// swift
// 将本地播放的所有远端用户音量设置为 50。
agoraKit.adjustPlaybackSignalVolume(50)
// 将本地播放的指定远端用户混音后的音量设置为 50。
agoraKit.adjustUserPlaybackSignalVolume(uid, volume: 50)

// objective-c
// 将本地播放的所有远端用户音量设置为 50。
[agoraKit adjustPlaybackSignalVolume: 50];
// 将本地播放的指定远端用户混音后的音量设置为 50。
[agoraKit adjustUserPlaybackSignalVolume: uid, volume: 50];

API 参考

• adjustPlaybackSignalVolume
• adjustUserPlaybackSignalVolume
• adjustAudioMixingPlayoutVolume

设置耳返音量

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

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

示例代码

// swift
// 开启耳返监听功能。
agoraKit.enableInearMonitoring(true)
// 将耳返音量设置为 50。
agoraKit.setInEarMonitoringVolume(50)

// objective-c
// 开启耳返监听功能。
[agoraKit enableInEarMonitoring(true)];
// 将耳返音量设置为 50。
[agoraKit setInEarMonitoringVolume: 50];

API 参考

• enableInEarMonitoring
• setInEarMonitoringVolume

获取用户音量（回调）

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

• 瞬时说话声音音量提示。reportAudioVolumeIndicationOfSpeakers 回调报告频道内瞬时音量最高的几个用户（即说话者）的用户 ID 及他们的音量。若返回的 uid 为 0，则表示返回的是本地用户的瞬时音量。

  你需要开启 enableAudioVolumeIndication 方法才能收到该回调。

示例代码

// swift
// 获取瞬时说话音量最高的几个用户（即说话者）的用户 ID、他们的音量及本地用户是否在说话。
// @param speakers 为一个数组，包含说话者的用户 ID 、音量及本地用户人声状态。音量的取值范围为 [0, 255]。
// @param totalVolume 指混音后频道内的总音量，取值范围为 [0, 255]。
func rtcEngine(_ engine: AgoraRtcEngineKit, reportAudioVolumeIndicationOfSpeakers speakers:
[AgoraRtcAudioVolumeInfo], totalVolume: Int) {
}

// objective-c
// 获取瞬时说话音量最高的几个用户（即说话者）的用户 ID、他们的音量及本地用户是否在说话。
// @param speakers 为一个数组，包含说话者的用户 ID 、音量及本地用户人声状态。音量的取值范围为 [0, 255]。
// @param totalVolume 指混音后频道内的总音量，取值范围为 [0, 255]。
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine reportAudioVolumeIndicationOfSpeakers:(NSArray<AgoraRtcAudioVolumeInfo*> *_Nonnull)speakers totalVolume:(NSInteger)totalVolume {
}

• 监测到活跃用户提示。activeSpeaker 回调报告特定时间段内累积音量最高的用户 ID。如果返回的 uid 为 0，则默认为本地用户。

  你需要开启 enableAudioVolumeIndication 方法才能收到该回调。

示例代码

// swift
// 获取当前时间段声音最大的用户 ID（仅 1 个）
func rtcEngine(_ engine: AgoraRtcEngineKit, activeSpeaker speakerUid: UInt) {
}

// objective-c
// 获取当前时间段声音最大的用户 ID（仅 1 个）
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine activeSpeaker:(NSUInteger)speakerUid {
}

API 参考

• reportAudioVolumeIndicationOfSpeakers
• activeSpeaker

开发注意事项

由于硬件设备的限制，当使用调节信号设置音量的方法将音量设置过大时，在某些设备上可能会出现失真的声音效果。

相关链接

实现调整通话音量过程中，你还可以参考如下文档：

• 如果想调整混音或音效文件的播放音量，可以参考播放音频文件。
• 如何处理音量太小问题？