# 音效文件播放管理 #### startAudioFile ``` public abstract int startAudioFile(String fullFilePath, int publish, int cycle, int replace); public abstract int startAudioFile(String fullFilePath, int publish, int cycle, int replace, int startPos); ``` 【**功能说明**】 开始播放音频文件。当前支持本端播放和在线播放。支持的格式包括：mp3、flac、mp4、m4a、aac、3gp、mkv、wav、amr、pcm、ogg。 【**请求参数**】 - fullFilePath：音频文件的本地全路径，支持播放本地文件或网络文件。 - publish：播放模式，0表示只有本端能听到播放的音频，1表示远端也能听到播放的音频。 - cycle：循环次数，0表示无限循环。 - replace：是否替代麦克风采集，等于1时用音频文件的声音替换麦克风采集的声音。 - startPos：音频文件开始播放的位置，单位为ms。 【**返回参数** 】 - 0：成功。 - \> 0：失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 ![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png) 会触发[onAudioMixStateChangedNotify](https://support.huaweicloud.com/csdk-rtc/rtc_05_0025.html#rtc_05_0025__section95482263396)回调。 #### stopAudioFile ``` public abstract int stopAudioFile(); ``` 【**功能说明**】 停止播放音频文件。 【**请求参数**】 无 【**返回参数** 】 - 0：成功。 - \> 0：失败。 ![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png) 会触发[onAudioMixStateChangedNotify](https://support.huaweicloud.com/csdk-rtc/rtc_05_0025.html#rtc_05_0025__section95482263396)回调。 #### pauseAudioFile ``` public abstract int pauseAudioFile(); ``` 【**功能说明**】 暂停播放音频文件。 【**请求参数**】 无 【**返回参数**】 - 0：成功。 - \>0：失败。 ![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png) 会触发[onAudioMixStateChangedNotify](https://support.huaweicloud.com/csdk-rtc/rtc_05_0025.html#rtc_05_0025__section95482263396)回调。 #### resumeAudioFile ``` public abstract int resumeAudioFile(); ``` 【**功能说明**】 恢复播放音频文件。 【**请求参数**】 无 【**返回参数** 】 - 0：成功。 - \>0：失败。 ![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png) 会触发[onAudioMixStateChangedNotify](https://support.huaweicloud.com/csdk-rtc/rtc_05_0025.html#rtc_05_0025__section95482263396)回调。 #### isPlayMixMyself ``` public abstract int isPlayMixMyself(boolean myself); ``` 【**功能说明**】 是否只有本地可以听到混音。 【**请求参数**】 myself：true表示只有本地可以听到混音， false表示本地和对方都可以听到混音，默认值为false。 【**返回参数** 】 - 0：成功。 - \> 0：失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### isMixWithMicrophone ``` public abstract int isMixWithMicrophone(boolean withMic); ``` 【**功能说明**】 是否需要替代采集。 【**请求参数**】 withMic：true表示替代采集，远端只能听到音乐，false表示不替代，远端可以同时听到音乐和MIC采集的声音，默认值为false。 【**返回参数** 】 - 0：成功。 - \> 0：失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### adjustAudioFileVolume ``` public abstract int adjustAudioFileVolume(int volume); ``` 【**功能说明**】 调整本地和远端音频播放的音量。 【**请求参数**】 volume：音量大小，范围为0-100，默认值为100。 【**返回参数** 】 - 0：方法调用成功。 - \> 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### adjustAudioFilePlayoutVolume ``` public abstract int adjustAudioFilePlayoutVolume(int volume); ``` 【**功能说明**】 调整本地音频播放的音量。 【**请求参数**】 volume：音量大小，范围为0-100，默认值为100。 【**返回参数** 】 - 0：方法调用成功。 - \> 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### adjustAudioFilePublishVolume ``` public abstract int adjustAudioFilePublishVolume(int volume); ``` 【**功能说明**】 调整远端音频播放的音量。 【**请求参数**】 volume：音量大小，范围0-100，默认值100。 【**返回参数** 】 - 0：方法调用成功。 - \> 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioFileVolume ``` public abstract int getAudioFileVolume(); ``` 【**功能说明**】 获取音频播放的音量。 【**请求参数**】 无 【**返回参数** 】 - \>=0：音量大小，范围为0-100。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioFilePlayoutVolume ``` public abstract int getAudioFilePlayoutVolume(); ``` 【**功能说明**】 获取音频本地播放的音量。 【**请求参数**】 无 【**返回参数** 】 - \>=0：音量大小，范围为0-100。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioFilePublishVolume ``` public abstract int getAudioFilePublishVolume(); ``` 【**功能说明**】 获取音频远端播放的音量。 【**请求参数**】 无 【**返回参数** 】 - \>=0：音量大小，范围为0-100。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioFileDuration ``` public abstract int getAudioFileDuration(); ``` 【**功能说明**】 获取音频文件的时长。 【**请求参数**】 无 【**返回参数** 】 - \>0：音频时长，单位为ms。 - \<= 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioFilePosition ``` public abstract int getAudioFilePosition(); ``` 【**功能说明**】 获取音频文件当前播放位置。 【**请求参数**】 无 【**返回参数** 】 - \>=0：播放位置，单位为ms。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### setAudioFilePosition ``` public abstract int setAudioFilePosition(int position); ``` 【**功能说明**】 设置音频文件播放位置。 【**请求参数**】 position：播放位置，单位为ms。 【**返回参数** 】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### playAudioClip ``` public abstract int playAudioClip(int soundId, String filePath, int loop, double pitch, double pan, double gain, int publish, int startPos); ``` 【**功能说明**】 播放音效文件并启动混音，需要在有joiner加入房间后调用。 【**请求参数**】 - soundId：音效ID，取值\>= 0。 - filePath：音效文件路径，支持本地文件和网络文件。 - loop：音效文件播放次数，0为循环播放。 - pitch：音调大小，当前不支持。 - pan：空间位置，当前不支持。 - gain：音量大小，取值范围0-100。 - publish：1表示将音效文件混音后发送到远端，0为本地播放，不发送到远端。 - startPos：起始播放位置，单位为ms。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 ![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png) soundId需要开发者自己生成并维护，保证不同的soundId对应不同的音效播放实例。同时音效播放完毕或者停止播放后，soundId最好主动回收，下一次播放音效的时候，尽量复用被回收的soundId。 #### stopAudioClip ``` public abstract int stopAudioClip(int soundId); ``` 【**功能说明**】 停止播放指定的音效文件。 【**请求参数**】 soundId：音效ID，取值\>= 0。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### pauseAudioClip ``` public abstract int pauseAudioClip(int soundId); ``` 【**功能说明**】 暂停播放指定的音效文件。 【**请求参数**】 soundId：音效ID，取值\>= 0。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### resumeAudioClip ``` public abstract int resumeAudioClip(int soundId); ``` 【**功能说明**】 恢复播放指定的音效文件。 【**请求参数**】 soundId：音效ID，取值\>= 0。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### stopAllAudioClips ``` public abstract int stopAllAudioClips(); ``` 【**功能说明**】 停止播放所有音效文件。 【**请求参数**】 无 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### pauseAllAudioClips ``` public abstract int pauseAllAudioClips(); ``` 【**功能说明**】 暂停播放所有音效文件。 【**请求参数**】 无 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### resumeAllAudioClips ``` public abstract int resumeAllAudioClips(); ``` 【**功能说明**】 恢复播放所有音效文件。 【**请求参数**】 无 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### setAudioClipsVolume ``` public abstract int setAudioClipsVolume(double volume); ``` 【**功能说明**】 设置音效播放的最大音量。 【**请求参数**】 volume：音量大小，范围为0-100。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioClipsVolume ``` public abstract int getAudioClipsVolume(); ``` 【**功能说明**】 获取音效播放的最大音量。 【**请求参数**】 无 【**返回参数**】 - \>= 0：音量大小，范围为0-100。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 ![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png) 音效文件支持同时播放多个，[setAudioClipsVolume]接口设置的音量是所有音频文件的最大音量，[setVolumeOfAudioClip]接口设置的是单个音效文件的音量，音效文件的实际播放音量 = 最大音量 \* 自身音量 / 100。例如，最大音量是50，单个音效音量是80，实际播放音量就是50 \* 80 / 100 = 40。 #### setVolumeOfAudioClip ``` public abstract int setVolumeOfAudioClip(int soundId, double volume); ``` 【**功能说明**】 设置指定音效的播放音量。 【**请求参数**】 - soundId：音效ID，取值\>= 0。 - volume：音量大小，范围为0-100，默认值为100。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getVolumeOfAudioClip ``` public abstract int getVolumeOfAudioClip(int soundId); ``` 【**功能说明**】 获取指定音效的播放音量。 【**请求参数**】 soundId：音效ID，取值\>= 0。 【**返回参数**】 - \>= 0：音量大小，范围为0-100，默认值为100。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 ![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png) 支持同时播放多个音效文件，[setAudioClipsVolume]接口设置的音量是所有音频文件的最大音量，[setVolumeOfAudioClip]接口设置的是单个音效文件的音量，音效文件的实际播放音量 = 最大音量 \* 自身音量 / 100。例如，最大音量是50，单个音效音量是80，实际播放音量就是50 \* 80 / 100 = 40。 #### setAudioClipPosition ``` public abstract int setAudioClipPosition(int soundId, int pos); ``` 【**功能说明**】 设置指定音效的播放位置。 【**请求参数**】 - soundId：音效ID，取值\>= 0。 - pos：播放位置，单位为ms。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioClipCurrentPosition ``` public abstract int getAudioClipCurrentPosition(int soundId); ``` 【**功能说明**】 获取指定音效文件当前的播放位置。 【**请求参数**】 soundId：音效ID，取值\>= 0。 【**返回参数**】 - \>= 0：播放位置，单位为ms。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### getAudioClipDuration ``` public abstract int getAudioClipDuration(String filePath); ``` 【**功能说明**】 获取音效的文件时长。 【**请求参数**】 filePath：音效文件路径，支持本地文件和网络文件。 【**返回参数**】 - \> 0：音效文件时长，单位为ms。 - \<= 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### preloadAudioClip ``` public abstract int preloadAudioClip(int soundId, String filePath); ``` 【**功能说明**】 预加载音效文件，当前不支持。 【**请求参数**】 - soundId：音效ID，取值\>= 0。 - filePath：音效文件路径。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。 #### unloadAudioClip ``` public abstract int unloadAudioClip(int soundId); ``` 【**功能说明**】 删除预加载的音效文件。 【**请求参数**】 soundId：音效ID，取值\>= 0。 【**返回参数**】 - 0：方法调用成功。 - \< 0：方法调用失败。具体请参见[客户端错误码](https://support.huaweicloud.com/csdk-rtc/rtc_05_0035.html)。