音效文件播放
- HarmonyOS
更新时间不可用
playEffect
播放指定的本地或在线音效文件。
public abstract playEffect(soundId:number,filePath:string,loopCount:number,pitch:number,pan:number,gain:number,publish?:boolean,startPos?:number):Promise<number>;你可以多次调用该方法，传入不同的 soundID 和 filePath，同时播放多个音效文件。为获得最佳用户体验，建议同时播放的音效文件不超过 3 个。
调用时机
该方法在加入频道前后均可调用。
调用限制
无。
相关回调
音效文件播放结束后，SDK 会触发 onAudioEffectFinished 回调。
参数
| 参数名 | 描述 |
|---|---|
soundId | |
filePath | |
loopCount | |
pitch | |
pan | |
gain | |
publish | |
startPos |
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
stopEffect
停止播放指定音效文件。
public abstract stopEffect(soundId:number):number;调用时机
该方法需要在 playEffect 之后调用。
调用限制
无。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
playAllEffects
播放所有音效文件。
public abstract playAllEffects(loopCount:number,pitch:number,pan:number,gain:number,publish:boolean):number;详情
多次调用 preloadEffect 预加载多个音效文件后，你可以调用本方法播放所有预加载的音效文件。
参数
| 参数名 | 描述 |
|---|---|
loopCount | |
pitch |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
unloadAllEffects
从内存释放所有预加载音效文件。
public abstract unloadAllEffects():number;返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
onAudioEffectFinished
本地音效文件播放已结束回调。
onAudioEffectFinished?:(soundId:number) => void;详情
当播放音效结束后，会触发该回调。
参数
所属接口类
getEffectsVolume
获取音效文件的播放音量。
public abstract getEffectsVolume():number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
setEffectsVolume
设置音效文件的播放音量。
public abstract setEffectsVolume(volume:number):number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
preloadEffect
将音效文件加载至内存。
public abstract preloadEffect(soundId:number,filePath:string,startPos?:number):Promise<number>;参数
返回值
Promise 完成时返回操作结果。
setVolumeOfEffect
设置指定音效文件的播放音量。
public abstract setVolumeOfEffect(soundId:number,volume:number):number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
pauseEffect
暂停音效文件播放。
public abstract pauseEffect(soundId:number):number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
pauseAllEffects
暂停所有音效文件播放。
public abstract pauseAllEffects():number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
resumeEffect
恢复播放指定音效文件。
public abstract resumeEffect(soundId:number):number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
resumeAllEffects
恢复播放所有音效文件。
public abstract resumeAllEffects():number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
stopAllEffects
停止播放所有音效文件。
public abstract stopAllEffects():number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
unloadEffect
从内存释放某个预加载的音效文件。
public abstract unloadEffect(soundId:number):number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。
getVolumeOfEffect
获取指定音效文件的播放音量。
public abstract getVolumeOfEffect(soundId:number):number;参数
返回值
0：方法调用成功；小于 0：方法调用失败。