playEffect abstract method

Future<int> playEffect(
  1. int effectId,
  2. NERtcAudioEffectOptions options
)

播放指定音效文件。

该方法播放指定的本地或在线音效文件。

调用时机

请在引擎初始化之后调用此接口,且该方法仅可在加入房间后调用。

说明

  • 您可以多次调用该方法,通过传入不同的音效文件的 effectId 和option ,同时播放多个音效文件,实现音效叠加。为获得最佳用户体验,建议同时播放的音效文件不超过 3 个。
  • 若通过此接口成功播放某指定音效文件后,反复停止或重新播放该 effectId 对应的音效文件,仅首次播放时设置的 option 有效,后续的 option 设置无效。
  • 支持的音效文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式,支持本地文件和在线 URL。

参数说明

effectId 指定音效的 ID,每个音效均应有唯一的 ID。

options 音效相关参数 ,包括混音任务类型、混音文件路径等。详细信息请参考 NERtcAudioEffectOptions

相关回调

返回值

  • 0(OK):方法调用成功。
  • 其他:方法调用失败。
    • 30005(invalidState):状态错误,比如引擎尚未初始化或已经加入房间。

Implementation

Future<int> playEffect(int effectId, NERtcAudioEffectOptions options);