音频路由
isSpeakerphoneEnabled
setDefaultAudioRouteToSpeakerphone
设置默认的音频路由。
Future<void> setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker);
详情
- 该方法仅适用于 Android 和 iOS 平台。
- 该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用 setEnableSpeakerphone。
手机设备一般有两个音频路由,一个是位于顶部的听筒,播放声音偏小;一个是位于底部的扬声器,播放声音偏大。设置默认的音频路由,就是在没有外接设备的前提下,设置系统使用听筒还是扬声器播放音频。
- 语音通话:听筒
- 语音直播:扬声器
- 视频通话:扬声器
- 视频直播:扬声器
调用该 API 可以改变上述默认音频路由。成功改变音频路由后,SDK 会触发 onAudioRoutingChanged 回调。
当手机插入外接设备,如蓝牙设备或耳机时,系统的音频路由会发生改变。详细的路由变化规律请参考 音频路由。
参数
- defaultToSpeaker
- 是否使用扬声器作为默认的音频路由:
true
: 设置默认音频路由为扬声器。false
: 设置默认音频路由为听筒。
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类setEnableSpeakerphone
开启或关闭扬声器播放。
Future<void> setEnableSpeakerphone(bool speakerOn);
详情
如果 SDK 默认的音频路由或 setDefaultAudioRouteToSpeakerphone 的设置无法满足你的需求,你可以调用 setEnableSpeakerphone 切换当前的音频路由。成功改变音频路由后,SDK 会触发 onAudioRoutingChanged 回调。
不同场景下 SDK 默认的音频路由见音频路由。
该方法只设置用户在当前频道内使用的音频路由,不会影响 SDK 默认的音频路由。如果用户离开当前频道并加入新的频道,则用户还是会使用 SDK 默认的音频路由。
- 该方法仅适用于 Android 和 iOS 平台。
- 该方法需要在加入频道后调用。
- 如果用户使用了蓝牙耳机、有线耳机等外接音频播放设备,则该方法的设置无效,音频只会通过外接设备播放。当有多个外接设备时,音频会通过最后一个接入的设备播放。
参数
- speakerOn
- 设置是否开启扬声器播放:
true
: 开启。音频路由为扬声器。false
: 关闭。音频路由为听筒。
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类setRouteInCommunicationMode
选择通话音量模式下的音频路由。
Future<void> setRouteInCommunicationMode(int route);
详情
该方法用于在通话音量模式(MODE_IN_COMMUNICATION)下,将音频路由从蓝牙耳机切换为听筒、有线耳机或扬声器。该方法调用成功后,SDK 会触发 onAudioRoutingChanged 回调,报告修改后的路由。
- 该方法仅适用于 Android。
- 该方法与 setEnableSpeakerphone 同时使用时可能引起冲突。声网建议你单独使用 setRouteInCommunicationMode。
参数
- route
- 期望使用的音频路由:
- -1:系统默认的音频路由。
- 0:带麦克风的耳机。
- 1:听筒。
- 2:不带麦克风的耳机。
- 3:设备自带的扬声器。
- 4:(暂不支持)外接的扬声器。
- 5:蓝牙耳机。
- 6:USB 设备。
返回值
无实际意义。
所属接口类onAudioRoutingChanged
音频路由已发生变化回调。
final void Function(int routing)? onAudioRoutingChanged;
详情
该回调仅适用于 Android、iOS 和 macOS 平台。
参数
- routing
当前的音频路由。详见 AudioRoute。