音效文件播放
playEffect
播放指定的本地或在线音效文件。
ArkTS
public abstract playEffect(soundId:number,filePath:string,loopCount:number,pitch:number,pan:number,gain:number,publish:boolean,startPos?:number):number;
你可以多次调用该方法，传入不同的 soundID 和 filePath，同时播放多个音效文件。为获得最佳用户体验，建议同时播放的音效文件不超过 3 个。
调用时机
该方法在加入频道前后均可调用。
相关回调
音效文件播放结束后，SDK 会触发 onAudioEffectFinished 回调。
参数
- soundId
- 音效的 ID。每个音效的 ID 具有唯一性。
- filePath
播放文件的地址。
- loopCount
- 音效循环播放的次数。
- ≥ 0: 循环播放次数。例如，1 表示循环播放 1 次，即总计播放 2 次。
- -1: 无限循环播放。
- pitch
- 音效的音调，取值范围为 [0.5,2.0]。默认值为 1.0，表示原始音调。取值越小，则音调越低。
- pan
- 音效的空间位置。取值范围为 [-1.0,1.0]，例如：
- -1.0：音效出现在左边
- 0.0：音效出现在正前方
- 1.0：音效出现在右边
- gain
- 音效的音量。取值范围为 [0.0,100.0]。默认值为 100.0，表示原始音量。取值越小，则音量越低。
- publish
- 是否将音效发布至远端：
true: 将音效发布至远端。本地用户和远端用户都能听到音效。false: 不将音效发布至远端。只有本地用户能听到音效。
- startPos
音效文件的播放位置，单位为毫秒。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
stopEffect
停止播放指定音效文件。
ArkTS
public abstract stopEffect(soundId:number):number;
调用时机
该方法需要在 playEffect 之后调用。
调用限制
无。
参数
- soundId
- 指定音效文件的 ID。每个音效文件均有唯一的 ID。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。