调整通话音量

为方便用户在进行音视频通话或互动直播能有更好的听感，本文将介绍 SDK 采集到的声音如何进行调整，从而达到你想要的音量。

功能描述

RTC SDK 提供了一些接口，实现耳返、音效、混音到播放的过程中设置不同类型的音量，例如麦克风采集、音乐、扬声器等，以满足产品在声音上的个性化需求。

下图展示了用户可能需要调整音量的场景、各场景对应的 API 及其使用注意事项。

实现方法

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

设置采集音量

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

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

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

• 0: 静音。
• 100: （默认值）原始音量，即不对信号做缩放。
• 400: 原始音量的 4 倍（把信号放大到原始信号的 4 倍）。

示例代码

// swift
// 将录音音量设置为原始音量的 50%。
rtcKit.adjustRecordingSignalVolume(50)

//objective-c
// 将录音音量设置为原始音量的 50%。
[rtcKit adjustRecordingSignalVolume: 50];

API 参考

• adjustRecordingSignalVolume

设置播放音量

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

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

• adjustPlaybackSignalVolume：

  • 用于调节本地播放的所有远端用户混音后的音量。
  • 该方法中 volume 参数表示播放音量，取值范围为 [0, 400]。

• adjustUserPlaybackSignalVolume：

• 用于调节本地播放的指定远端用户混音后的音量。你可以多次调用该方法来调节不同远端用户在本地播放的音量，或对某个远端用户在本地播放的音量调节多次。

  • 该方法中 volume 参数表示播放音量，取值范围为 [0, 100]。

adjustPlaybackSignalVolume 接口仅支持调节所有远端用户的本地播放音量。静音本地音频请同时调用 adjustPlaybackSignalVolume(0) 和 adjustAudioMixingPlayoutVolume(0)。

adjustUserPlaybackSignalVolume 方法要在加入频道后调用。

示例代码

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

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

API 参考

• adjustPlaybackSignalVolume
• adjustUserPlaybackSignalVolume
• adjustAudioMixingPlayoutVolume

设置混音音量

混音 是指 SDK 从 App 获取一路音频数据，将 App 提供的音频数据与 SDK 采集的音频数据整合为一路音频数据；为了实现在通话或直播过程中，需要播放自定义的声音或者音乐文件并且让房间内的其他人也听到的需求。

混音功能常用于以下场景：

• 直播中的掌声
• 口哨等音效
• 播放背景音乐
• ...

你可以直接调用 adjustAudioMixingVolume，该方法调节混音里伴奏在本端和远端播放的音量大小。

该方法中 volume 参数表示音乐文件的音量，取值范围为 [0, 100]。默认值 100 表示原始文件音量，即不对信号做缩放。0 表示混音音乐文件播放静音。

示例代码

int volume = 60;
// 设置本地及远端用户听到的音乐文件音量为原始音量的 60%。
rtcKit.adjustAudioMixingVolume(volume);

你也可以通过 adjustAudioMixingPlayoutVolume 方法和 adjustAudioMixingPublishVolume 方法分别调节混音音量。

• adjustAudioMixingPlayoutVolume：

  • 用于调节音乐文件的本地播放的混音音量。
  • 该方法中 volume 参数表示音乐文件在本地播放的混音音量，取值范围为 0~100。默认 100 为原始文件音量。

• adjustAudioMixingPublishVolume：

  • 用于调节音乐文件的远端播放的混音音量。
  • 该方法中 volume 参数表示音乐文件在远端播放的混音音量，取值范围为 0~100。默认 100 为原始文件音量。

adjustAudioMixingPlayoutVolume 方法和 adjustAudioMixingPublishVolume 方法要在加入频道后调用。

示例代码

int volume = 60;
// 设置远端用户听到的音乐文件音量为原始音量的 60%。
[rtcKit adjustAudioMixingPublishVolume:volume];
// 设置本地用户听到的音乐文件音量为原始音量的 60%。
[rtcKit adjustAudioMixingPlayoutVolume:volume];

API 参考

• adjustAudioMixingPublishVolume
• adjustAudioMixingPlayoutVolume
• adjustAudioMixingVolume

设置音效音量

音效 是指播放时间较短的音频，如掌声、口哨等声音。在直播互动等娱乐场景中，为增加趣味性和互动性，支持对声音进行变声、混响、立体声等处理。

使用播放设备播放音效音量时，你可以通过 setEffectsVolume 方法或 setVolumeOfEffect 方法设置音效文件在本地的播放音量。

• setEffectsVolume：

  • 用于设置播放音效文件音量。
  • 该方法中 volume 参数表示音效文件的音量，取值范围为 [0.0, 100.0]。 100.0 为默认值。

• setVolumeOfEffect：

  • 用于实时调整播放音效文件音量。
  • 该方法有两个参数：
    • soundId :指定音效的 ID。每个音效均有唯一的 ID
    • volume： 表示音效文件的音量，取值范围为 [0.0, 100.0]。 100.0 为默认值

示例代码

...
// 设置音效音量为原始音量的 60%。
double volume = 60.0
// 设置所有音效的播放音量。
[rtcKit setEffectsVolume:volume];
// 设置单个音效的播放音量。
// soundId 是你在调用 playEffect 时设置的音效 ID。
[rtcKit setVolumeOfEffect:soundId withVolume:volume];

设置耳返音量

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

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

示例代码

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

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

API 参考

• enableInEarMonitoring
• setInEarMonitoringVolume

获取用户音量（回调）

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

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

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

  示例代码

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

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

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

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

示例代码

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

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

API 参考

• reportAudioVolumeIndicationOfSpeakers
• activeSpeaker

开发注意事项

由于硬件设备的限制，当音量设置过大时，在某些设备上可能会出现失真的声音效果。