文档首页/ 实时音视频 SparkRTC/ 客户端SDK参考/ All Platform C++ SDK/ 接口参考/ IHRTCEngine/ 音频文件播放管理
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

音频文件播放管理

音频文件播放使用ffmpeg能力，在播放在线url时受windows平台自身特性影响，断网时会立刻停止播放（SparkRTC内部无缓存设计），若对该场景体验有要求，建议业务通过先下载到本地再播放的形式使用。

startAudioFile

virtual int startAudioFile(const char *filePath, int publish, int cycle, int replace)
virtual int startAudioFile(const char *filePath, int publish, int cycle, int replace, unsigned int startPos)

【功能说明】

播放音频文件，房间内调用。当前仅支持本端播放。

【请求参数】

  • filePath：音频文件的本地全路径。
  • publish：播放模式，0表示只有本端能听到播放的音频，1表示远端也能听到播放的音频。
  • cycle：循环次数，0表示无限循环。
  • replace：远端模式下面是否需要和麦克风做混音。
  • startPos：音频文件开始播放的位置，单位为ms。
【返回参数】
  • 0：方法调用成功。
  • > 0：方法调用失败。具体请参见HRTCErrorCode。

会触发onAudioMixStateChangedNotify回调。

stopAudioFile

virtual int stopAudioFile()

【功能说明】

停止播放音频文件，房间内调用。

【请求参数】

无

【返回参数】
  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

会触发onAudioMixStateChangedNotify回调。

pauseAudioFile

virtual int pauseAudioFile()

【功能说明】

暂停播放音频文件，房间内调用。

【请求参数】

无

【返回参数】
  • 0：方法调用成功。
  • <0：方法调用失败。具体请参见HRTCErrorCode。

会触发onAudioMixStateChangedNotify回调。

resumeAudioFile

virtual int resumeAudioFile()

【功能说明】

恢复播放音频文件，房间内调用。

【请求参数】

无

【返回参数】
  • 0：方法调用成功。
  • <0：方法调用失败。具体请参见HRTCErrorCode。

会触发onAudioMixStateChangedNotify回调。

adjustAudioFileVolume

int adjustAudioFileVolume(unsigned int volume)

【功能说明】

调节混音里伴奏在本端和远端播放的⾳量。

【请求参数】

volume：音量大小，范围为0-100。默认音量为100。

【返回参数】
  • 0：方法调用成功。
  • <0：方法调用失败。具体请参见HRTCErrorCode。

adjustAudioFilePlayoutVolume

int adjustAudioFilePlayoutVolume(unsigned int volume)

【功能说明】

调节混音里伴奏在本端播放的⾳量⼤⼩。

【请求参数】

volume：音量大小，范围为0-100。默认音量为100。

【返回参数】
  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

getAudioFileVolume

int getAudioFileVolume()

【功能说明】

获取音频播放的音量。

【请求参数】

无

【返回参数】
  • >=0：音量大小，音量范围为0-100。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

getAudioFilePlayoutVolume

int getAudioFilePlayoutVolume()

【功能说明】

获取本地音频播放的音量。

【请求参数】

无

【返回参数】
  • >=0：音量大小，音量范围为0-100。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

getAudioFileDuration

int getAudioFileDuration()

【功能说明】

获取音频播放的时长。

【请求参数】

无

【返回参数】
  • >0：音频时长，单位为ms。
  • <= 0：方法调用失败。具体请参见HRTCErrorCode。

getAudioFilePosition

int getAudioFilePosition()

【功能说明】

获取音频文件当前播放位置。

【请求参数】

无

【返回参数】
  • >=0：音频时长，单位为ms。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

setAudioFilePosition

int setAudioFilePosition(unsigned long long position)

【功能说明】

设置音频文件播放位置。

【请求参数】

position：播放位置，单位为ms。

【返回参数】
  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

getAudioClipsVolume

virtual int getAudioClipsVolume()

【功能说明】

获取音效总音量。

【请求参数】

无

【返回参数】

  • >=0：音量大小，范围为0-100。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

音效文件支持同时播放多个，setAudioClipsVolume接口设置的音量是所有音频文件的最大音量，setVolumeOfAudioClip接口设置的是单个音效文件的音量，音效文件的实际播放音量 = 最大音量 * 自身音量 / 100。例如，最大音量是50，单个音效音量是80，实际播放音量就是50 * 80 / 100 = 40

setAudioClipsVolume

virtual int setAudioClipsVolume(double volume)

【功能说明】

设置音效总音量。

【请求参数】

volume：音量值大小，范围为0-100。默认音量为100。

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

getVolumeOfAudioClip

virtual int getVolumeOfAudioClip(int soundId)

【功能说明】

获取指定音效的播放音量。

【请求参数】

soundId：音效ID，取值>=0。

【返回参数】

  • >=0：音量大小，范围为0-100。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

支持同时播放多个音效文件，setAudioClipsVolume接口设置的音量是所有音频文件的最大音量，setVolumeOfAudioClip接口设置的是单个音效文件的音量，音效文件的实际播放音量 = 最大音量 * 自身音量 / 100。例如，最大音量是50，单个音效音量是80，实际播放音量就是50 * 80 / 100 = 40

setVolumeOfAudioClip

virtual int setVolumeOfAudioClip(int soundId, double volume)

【功能说明】

设置指定音效音量。

【请求参数】

  • soundId：音效ID，取值>=0。
  • volume：音量大小，范围为0-100。默认音量为100。

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

playAudioClip

virtual int playAudioClip(int soundId, const char *filePath,int loop, double pitch, double pan, double gain, int publish, int startPos)

【功能说明】

播放音效文件并启动混音，需要在有joiner加入房间后调用。

【请求参数】

  • soundId：音效ID，取值>=0。
  • filePath：音效文件路径，支持本地文件和网络文件。
  • loop：音效文件播放次数，0为不播放，-1为循环播放。
  • pitch：音调大小，当前不支持。
  • pan：空间位置，当前不支持。
  • gain：音量大小，取值范围为0-100。
  • publish：1表示将音效文件混音后发送到远端，0为本地播放，不发送到远端。
  • startPos：起始播放位置，单位为ms。

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

soundId需要开发者自己生成并维护，保证不同的soundId对应不同的音效播放实例。同时音效播放完毕或者停止播放后，soundId最好主动回收，下一次播放音效的时候，尽量复用被回收的soundId。

stopAudioClip

virtual int stopAudioClip(int soundId)

【功能说明】

停止播放指定的音效文件。

【请求参数】

soundId：音效ID，取值>=0。

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

stopAllAudioClips

virtual int stopAllAudioClips()

【功能说明】

停止播放所有音效文件。

【请求参数】

无

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

pauseAudioClip

virtual int pauseAudioClip(int soundId)

【功能说明】

暂停播放指定的音效文件。

【请求参数】

soundId：音效ID，取值>=0。

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

pauseAllAudioClips

virtual int pauseAllAudioClips()

【功能说明】

暂停播放所有音效文件。

【请求参数】

无

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

resumeAudioClip

virtual int resumeAudioClip(int soundId)

【功能说明】

暂停播放指定的音效文件。

【请求参数】

soundId：音效ID，取值>=0。

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

resumeAllAudioClips

virtual int resumeAllAudioClips()

【功能说明】

恢复播放所有音效文件。

【请求参数】

无

【返回参数】

  • 0：方法调用成功。
  • < 0：方法调用失败。具体请参见HRTCErrorCode。

getAudioClipCurrentPosition

virtual int getAudioClipCurrentPosition(int soundId)

【功能说明】

获取指定音效文件当前的播放位置。

【请求参数】

soundId：音效ID，取值>=0。

【返回参数】

  • >= 0：播放位置，单位为ms。

setAudioClipPosition

virtual int setAudioClipPosition(int soundId, int pos)

【功能说明】

设置指定音效文件的播放位置。

【请求参数】

  • soundId：音效ID，取值>=0。
  • pos：播放位置，单位为ms。

【返回参数】

  • 0：方法调用成功。

getAudioClipDuration

virtual int getAudioClipDuration(const char *filePath)

【功能说明】

获取音效的文件时长。

【请求参数】

filePath：音效文件路径，支持本地文件和网络文件。

【返回参数】

  • > 0：音效文件时长，单位为ms。
父主题： IHRTCEngine

相关文档