setAudioRoute method
@hidden(macOS)
@detail api
@author yezijian.me
@brief 强制切换当前的音频播放路由。默认使用 setDefaultAudioRoute:{@link #ByteRTCEngine#setDefaultAudioRoute} 中设置的音频路由。
音频播放路由发生变化时,会收到 rtcEngine:onAudioRouteChanged:{@link #ByteRTCEngineDelegate#rtcEngine:onAudioRouteChanged} 回调。
@param audioRoute 音频播放路由,参见 ByteRTCAudioRoute{@link #ByteRTCAudioRoute}。仅支持扬声器和默认路由设备。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明
@note
- 对于绝大多数音频场景,使用 setDefaultAudioRoute:{@link #ByteRTCEngine#setDefaultAudioRoute} 设置默认音频路由,并借助 RTC SDK 的音频路由自动切换逻辑即可完成。切换逻辑参见移动端设置音频路由。你应仅在例外的场景下,使用此接口,比如在接入外接音频设备时,手动切换音频路由。
- 本接口仅支持在 ByteRTCAudioScenarioCommunication 音频场景下使用。你可以通过调用 setAudioScenario:{@link #ByteRTCEngine#setAudioScenario} 切换音频场景。
- 不同音频场景中,音频路由和发布订阅状态到音量类型的映射关系详见 ByteRTCAudioScenarioType{@link #ByteRTCAudioScenarioType} 。
Implementation
FutureOr<int> setAudioRoute(ByteRTCAudioRoute audioRoute) async {
return await nativeCall('setAudioRoute:', [audioRoute.$value]);
}