startAudioMixing abstract method

Future<void> startAudioMixing({
  1. required String filePath,
  2. required bool loopback,
  3. required int cycle,
  4. int startPos = 0,
})

开始播放音乐文件。

该方法支持播放的音频文件格式见 RTC SDK 支持播放哪些格式的音频文件。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL,则 SDK 会报告 audioMixingReasonCanNotOpen。 使用该方法播放时长较短的音效文件可能会导致播放失败。如需播放音效文件,建议使用 playEffect 。 如需多次调用该方法,请确保调用间隔大于 500 ms。 在 Android 平台上调用该方法时,请注意如下事项: 请确保使用 Android 4.2 或以上设备,且 API Level 不低于 16。 如果播放的是在线音乐文件,建议不要使用重定向地址。重定向地址在某些机型上可能无法打开。 如果在模拟器上调用该方法,则请确保音乐文件在 /sdcard/ 目录下,且格式为 MP3。

  • filePath 文件路径: Android: 文件路径,需精确到文件名及后缀。支持在线文件的 URL 地址,本地文件的 URI 地址、绝对路径或以 /assets/ 开头的路径。通过绝对路径访问本地文件可能会遇到权限问题,建议使用 URI 地址访问本地文件。例如 content://com.android.providers.media.documents/document/audio%3A14441 。 Windows: 音频文件的绝对路径或 URL 地址,需精确到文件名及后缀。例如 C:\music\audio.mp4 。 iOS 或 macOS: 音频文件的绝对路径或 URL 地址,需精确到文件名及后缀。例如 /var/mobile/Containers/Data/audio.mp4 。
  • loopback 是否只在本地播放音乐文件: true :只在本地播放音乐文件,只有本地用户能听到音乐。 false :将本地播放的音乐文件发布至远端,本地用户和远端用户都能听到音乐。
  • cycle 音乐文件的播放次数。

0: 播放次数。例如,1 表示播放 1 次。 -1: 无限循环播放。

  • startPos 音乐文件的播放位置,单位为毫秒。

Returns 方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。

Implementation

Future<void> startAudioMixing(
    {required String filePath,
    required bool loopback,
    required int cycle,
    int startPos = 0});