startAudioMixing abstract method
开始播放音乐文件
该方法指定本地或在线音频文件来和录音设备采集的音频流进行混音。
- 支持的音乐文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式,支持本地文件或在线 URL。
- 成功调用该方法后,如果播放状态改变,本地会触发 onAudioMixingStateChanged 回调。
使用前提
发送伴音前必须调用 NERtcEngine.enableLocalAudio 方法开启本地音频采集。
调用时机
请在引擎初始化之后调用此接口,该方法在加入房间前后均可调用。
说明
-
若您在通话中途调用此接口播放音乐文件时,手动设置了伴音播放音量或发送音量,则当前通话中再次调用时默认沿用此设置。
-
开启或关闭本地音频采集的操作不再影响音乐文件播放,即 enableLocalAudio(false) 后仍旧可以播放音乐文件。
参数说明
options
创建混音任务配置的选项,包括混音任务类型、混音文件全路径或 URL 等,详细信息请参考 NERtcAudioMixingOptions。
相关回调
- NERtcAudioMixingEventCallback.onAudioMixingStateChanged:本地用户的伴音文件播放状态改变时,本地会触发此回调;可通过此回调接收伴音文件播放状态改变的相关信息,若播放出错,可通过对应错误码排查故障,详细信息请参考
AudioMixingError
。 - NERtcAudioMixingEventCallback.onAudioMixingTimestampUpdate:本地用户的伴音文件播放进度回调。
返回值
- 0(OK):方法调用成功。
- 其他:方法调用失败。
- 30003(invalidParam):参数错误。
- 30005(invalidState):状态错误,比如引擎尚未初始化。
Implementation
Future<int> startAudioMixing(NERtcAudioMixingOptions options);