音频路由
isSpeakerphoneEnabled
检查扬声器状态启用状态。
Objective-C
- (BOOL)isSpeakerphoneEnabled;
调用时机
该方法在加入频道前后都能调用。
调用限制
无。
返回值
YES
: 扬声器已开启,语音会输出到扬声器。NO
: 扬声器未开启,语音会输出到非扬声器(听筒,耳机等)。
setDefaultAudioRouteToSpeakerphone:
设置默认的音频路由。
Objective-C
- (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeaker;
手机设备一般有两个音频路由,一个是位于顶部的听筒,播放声音偏小;一个是位于底部的扬声器,播放声音偏大。设置默认的音频路由,就是在没有外接设备的前提下,设置系统使用听筒还是扬声器播放音频。
不同场景下,系统默认的音频路由也不同。具体如下:
- 语音通话:听筒
- 语音直播:扬声器
- 视频通话:扬声器
- 视频直播:扬声器
调用该 API 可以改变上述默认音频路由。
信息
在调用该方法设置默认音频路由后,系统实际音频路由会随着外接音频设备(有线耳机或蓝牙耳机)的连接发生改变。详见音频路由。
调用时机
该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用 setEnableSpeakerphone:。
调用限制
无。
相关回调
成功改变音频路由后,SDK 会触发 rtcEngine:didAudioRouteChanged: 回调,报告当前的音频路由。
参数
- defaultToSpeaker
- 是否使用扬声器作为默认的音频路由:
YES
: 设置默认音频路由为扬声器。NO
: 设置默认音频路由为听筒。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setEnableSpeakerphone:
开启或关闭扬声器播放。
Objective-C
- (int)setEnableSpeakerphone:(BOOL)enableSpeaker;
不同场景下 SDK 默认的音频路由见音频路由。
适用场景
如果 SDK 默认的音频路由或 setDefaultAudioRouteToSpeakerphone: 的设置无法满足你的需求,你可以调用该方法切换当前的音频路由。
调用时机
该方法需要在加入频道后调用。
调用限制
- 该方法只设置用户在当前频道内使用的音频路由,不会影响 SDK 默认的音频路由。如果用户离开当前频道并加入新的频道,则用户还是会使用 SDK 默认的音频路由。
- 如果用户使用了蓝牙耳机、有线耳机等外接音频播放设备,则该方法的设置无效,音频只会通过外接设备播放。当有多个外接设备时,音频会通过最后一个接入的设备播放。
相关回调
成功改变音频路由后,SDK 会触发 rtcEngine:didAudioRouteChanged: 回调,报告当前的音频路由。
参数
- enableSpeaker
- 设置是否开启扬声器播放:
YES
: 开启。音频路由为扬声器。NO
: 关闭。音频路由为听筒。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
rtcEngine:didAudioRouteChanged:
音频路由已发生变化回调。
Objective-C
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioRouteChanged:(AgoraAudioOutputRouting)routing;
参数
- engine
- AgoraRtcEngineKit 对象。
- routing
当前的音频路由。详见 AgoraAudioOutputRouting。