音频路由
IsSpeakerphoneEnabled
SetDefaultAudioRouteToSpeakerphone
设置默认的音频路由。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker);
详情
信息
- 该方法仅适用于 Android 和 iOS 平台。
- 该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用 SetEnableSpeakerphone。
手机设备一般有两个音频路由,一个是位于顶部的听筒,播放声音偏小;一个是位于底部的扬声器,播放声音偏大。设置默认的音频路由,就是在没有外接设备的前提下,设置系统使用听筒还是扬声器播放音频。
不同场景下,系统默认的音频路由也不同。具体如下:
- 语音通话:听筒
- 语音直播:扬声器
- 视频通话:扬声器
- 视频直播:扬声器
调用该 API 可以改变上述默认音频路由。成功改变音频路由后,SDK 会触发 FOnAudioRoutingChanged 回调。
信息
当手机插入外接设备,如蓝牙设备或耳机时,系统的音频路由会发生改变。详细的路由变化规律请参考 音频路由。
参数
- defaultToSpeaker
- 是否使用扬声器作为默认的音频路由:
true
: 设置默认音频路由为扬声器。false
: 设置默认音频路由为听筒。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetEnableSpeakerphone
开启或关闭扬声器播放。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetEnableSpeakerphone(bool speakerOn);
详情
如果 SDK 默认的音频路由(见音频路由)或 SetDefaultAudioRouteToSpeakerphone 的设置无法满足你的需求,你可以调用 SetEnableSpeakerphone 切换当前的音频路由。成功改变音频路由后,SDK 会触发 FOnAudioRoutingChanged 回调。
该方法只设置用户在当前频道内使用的音频路由,不会影响 SDK 默认的音频路由。如果用户离开当前频道并加入新的频道,则用户还是会使用 SDK 默认的音频路由。
注意
- 该方法仅适用于 Android 和 iOS 平台。
- 该方法需要在加入频道后调用。
- 如果用户使用了蓝牙耳机、有线耳机等外接音频播放设备,则该方法的设置无效,音频只会通过外接设备播放。当有多个外接设备时,音频会通过最后一个接入的设备播放。
参数
- speakerOn
- 设置是否开启扬声器播放:
true
: 开启。音频路由为扬声器。false
: 关闭。音频路由为听筒。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
FOnAudioRoutingChanged
音频路由已发生变化回调。
C++
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnAudioRoutingChanged, int, routing);
详情
信息
该回调仅适用于 Android、iOS 和 macOS 平台。
参数
- routing
- 当前的音频路由:
- ROUTE_DEFAULT (-1):使用默认的音频路由。
- ROUTE_HEADSET (0):音频路由为带麦克风的耳机。
- ROUTE_EARPIECE (1):音频路由为听筒。
- ROUTE_HEADSETNOMIC (2):音频路由为不带麦克风的耳机。
- ROUTE_SPEAKERPHONE (3):音频路由为设备自带的扬声器。
- ROUTE_LOUDSPEAKER (4):(暂不支持)音频路由为外接的扬声器。
- ROUTE_BLUETOOTH (5):音频路由为蓝牙耳机。