音频常用操作和配置

1.1.音频编码模式（AliRtcAudioProfile）

1.2.音频场景模式（AliRtcAudioScenario）

1.3.示例代码

以下将为您提供一些常见场景的音频编码模式及应用场景的模式设置示例。

需要蓝牙采集

// 需要设置为AliRtcSceneDefaultMode场景
mAliRtcEngine.setAudioProfile(AliRtcEngineHighQualityMode, AliRtcSceneDefaultMode);

// 需要设置为AliRtcSceneDefaultMode场景
engine.setAudioProfile(AliRtcAudioProfile.engineHighQualityMode, audio_scene: AliRtcAudioScenario.sceneDefaultMode)

需要与 Web 端互通

// 需要设置为采样率48k的编码模式,例如AliRtcEngineHighQualityMode
mAliRtcEngine.setAudioProfile(AliRtcEngineHighQualityMode, AliRtcSceneMusicMode);

// 需要设置为采样率48k的编码模式，例如AliRtcEngineHighQualityMode
engine.setAudioProfile(AliRtcAudioProfile.engineHighQualityMode, audio_scene: AliRtcAudioScenario.sceneMusicMode)

需要双声道

// 设置为带Stereo的模式，例如AliRtcEngineStereoHighQualityMode
mAliRtcEngine.setAudioProfile(AliRtcEngineStereoHighQualityMode, AliRtcSceneMusicMode);

// 设置为带Stereo的模式，例如AliRtcEngineStereoHighQualityMode
engine.setAudioProfile(AliRtcAudioProfile.engineStereoHighQualityMode, audio_scene: AliRtcAudioScenario.sceneMusicMode)

2.1.静音麦克风

ARTC 提供muteLocalMic接口用于静音麦克风和外部输入音频，该接口可以在加入频道前后调用设置是否静音。

支持设置的模式AliRtcMuteLocalAudioMode如下：

示例代码如下：

// 静音全部
mAliRtcEngine.muteLocalMic(true, AliRtcEngine.AliRtcMuteLocalAudioMode.AliRtcMuteAllAudioMode);
// 取消静音全部
mAliRtcEngine.muteLocalMic(false, AliRtcEngine.AliRtcMuteLocalAudioMode.AliRtcMuteAllAudioMode);
// 仅静音麦克风
mAliRtcEngine.muteLocalMic(true, AliRtcEngine.AliRtcMuteLocalAudioMode.AliRtcMuteOnlyMicAudioMode);

2.2.关闭/恢复麦克风采集

@startuml
autonumber
actor "开发者客户端" as userA #cyan
participant "ARTC SDK" as artcsdk #orange

userA -> artcsdk:  创建ARTC引擎
userA -> artcsdk: joinChannel加入频道并推送音频流
userA -[#red]> artcsdk: <color:#red>stopAudioCapture停止麦克风采集
userA -[#red]> artcsdk: <color:#red>startAudioCapture恢复麦克风采集
@enduml

SDK 加入频道默认开启麦克风采集，如果需要关闭麦克风采集，可以调用stopAudioCapture停止麦克风采集，此接口会释放麦克风资源停止采集音频。如果需要恢复麦克风采集，请调用startAudioCapture接口。

// 停止麦克风采集
mAliRtcEngine.stopAudioCapture();
// 恢复麦克风采集
mAliRtcEngine.startAudioCapture();

3.1.静音远端用户

ARTC 提供muteRemoteAudioPlaying接口停止/恢复远端指定用户音频播放，接口定义如下：

public abstract int muteRemoteAudioPlaying(String uid, boolean mute);

• 这里的静音不影响音频拉流和解码，可以在入会前后设置。

• 这里的静音仅影响远端用户音频在本端的播放，不影响远端用户采集。

3.2.设置指定远端用户播放音量

ARTC 提供setPlayoutVolume接口控制本端播放音量。

/**
 * @brief 设置播放音量
 * @param volume 播放音量，取值范围[0,400]
 * - 0：静音
 * - <100：减小音量
 * - >100：放大音量
 * @return
 * - 0: 成功
 * - 非0: 失败
 */
public abstract int setPlayoutVolume(int volume);

ARTC 提供setRemoteAudioVolume接口用于控制指定的远端用户音频播放音量，当传入 volume 参数为 0 时等同于muteRemoteAudioPlaying接口。

/**
 * @brief 调节本地播放的指定远端用户音量
 * @param uid 用户ID，从App server分配的唯一标示符
 * @param volume 播放音量，取值范围[0,100] 0：静音；100：原始音量
 * @return
 * - 0: 成功
 * - 非0: 失败
 */
public abstract int setRemoteAudioVolume(String uid, int volume);

4.1.开启耳返

可以在加入频道前后调用enableEarBack接口开启耳返功能。如果需要关闭耳返功能，请再次调用enableEarBack并将参数置为 false。

rtcEngine.enableEarBack(true);

engine.enableEarBack(true)

4.2.设置耳返音量

调用setEarBackVolume接口调整耳返的音量，参数volume表示音量大小，范围为 [0~100]，其中 0 表示静音，100 表示正常音量，默认值为 100。

rtcEngine.setEarBackVolume(60);

rtcEngine?.setEarBackVolume(volume)

5.1. 开启回调功能

调用enableAudioVolumeIndication 开启功能并设置回调频率、平滑系数等，参数如下：

• interval：回调频率间隔，单位为 ms。建议设置为 300～500ms，最小不能低于 10ms，如果设置为负值表示关闭此功能。

• smooth：平滑系数，数值越大表示平滑程度越高，反之平滑程度低实时性好，建议设置为 3，取值范围为 [0-9]。

• reportVad：说话人检测开关，0 表示关闭，1 表示开启。

mAliRtcEngine.enableAudioVolumeIndication(500, 3,1);

// 用户音量回调和说话人检测
engine.enableAudioVolumeIndication(500, smooth: 3, reportVad: 1)

5.2. 实现并注册相关回调

调用registerAudioVolumeObserver接口注册相关回调，之后系统会根据设置的间隔回调：

• onAudioVolume 回调负责提供周期性的音频音量信息，用于实时掌握各用户的发言强度。系统会定时上报当前检测到的所有用户（包括本地和远端）的音量级别，开发者可用于实现声波动画、音量指示条或静音检测等 UI 反馈。其中，当 mUserId 为 "0" 时，表示该条目为本地采集音量；mUserId 为“1”时表示所有远端用户的混音音量，其他值表示指定用户的音量信息。 totalVolume 表示所有远端用户混音后的总体音量。

• onActiveSpeaker 是语音激励（Voice Activity Detection, VAD）触发的主讲人回调。当系统检测到某个用户成为当前最活跃的发言人（说话音量和持续时间超过阈值）时，会通过此回调通知应用层。开发者可利用该事件实现“自动聚焦发言人”的交互体验，例如会议场景讲说话人视频窗口置为大屏等。

private final AliRtcEngine.AliRtcAudioVolumeObserver mAliRtcAudioVolumeObserver = new AliRtcEngine.AliRtcAudioVolumeObserver() {
    // 用户音量回调
    @Override
    public void onAudioVolume(List<AliRtcEngine.AliRtcAudioVolume> speakers, int totalVolume){
        handler.post(() -> {
            if(!speakers.isEmpty()) {
                for(AliRtcEngine.AliRtcAudioVolume volume : speakers) {
                    if("0".equals(volume.mUserId)) {
                        // 本地当前用户音量

                    } else if ("1".equals(volume.mUserId)) {
                        // 远端用户整体音量

                    } else {
                        // 远端用户音量

                    }
                }
            }
        });
    }

    // 说话人检测回调
    @Override
    public void onActiveSpeaker(String uid){
        // 说话人
        handler.post(() -> {
            String mag = "onActiveSpeaker uid:" + uid;
            ToastHelper.showToast(AudioBasicUsageActivity.this, mag, Toast.LENGTH_SHORT);
        });
    }
};
// 注册回调
mAliRtcEngine.registerAudioVolumeObserver(mAliRtcAudioVolumeObserver);

func onAudioVolumeCallback(_ array: [AliRtcUserVolumeInfo]?, totalVolume: Int32) {
    // 用户音量回调
    "onAudioVolumeCallback, totalVolume: \(totalVolume)".printLog()
}

func onActiveSpeaker(_ uid: String) {
    // 说话人回调
    "onActiveSpeaker, uid: \(uid)".printLog()
}

6.1.默认音频路由

默认音频路由用于在入会前设置默认的音频路由设备，在听筒和扬声器之间选择。如果没有设置该功能，将默认使用扬声器。

/**
* @brief 设置默认音频输出是否从扬声器出声，默认从扬声器出声
* @param defaultToSpeakerphone
* - true: 扬声器模式(默认扬声器)
* - false: 听筒模式
* @return
* - 0: 成功
* - <0: 失败
*/
public int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

6.2.当前音频路由

当前音频路由用于在会议当中设置当前播放的音频设备，在听筒和扬声器之间选择。如果没有设置该功能， 将使用默认音频路由所设置的设备进行播放。

在没有外置设备的情况下，用户可以调用enableSpeakerphone设置当前是否使用扬声器，设置为否则使用听筒。如果需要检查当前的音频设备为扬声器或听筒，可以调用isSpeakerOn接口。

/**
 * @brief 设置音频输出为听筒还是扬声器
 * @param enable   true:扬声器模式(默认扬声器)；false:听筒模式
 * @return
 * - 0: 成功
 * - <0: 失败
 */
public int enableSpeakerphone(boolean enable);
/**
* @brief 获取当前音频输出为听筒还是扬声器
* @return 
* - true: 扬声器模式；
* - false: 听筒模式
*/
public boolean isSpeakerOn();

6.3.音频路由设备变化回调

如果想获取音频播放设备切换时的回调需要注册并监听以下回调。

public abstract class AliRtcEngineEventListener {
    /**
     * @brief 警告通知
     * @details 如果engine出现warning，通过这个回调通知app
     * @param warn 警告类型
     * @param message 警告消息
     */
    public void onOccurWarning(int warn, String message);
}

warn返回值和设备类型对应关系如下表：