- 最新动态
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
-
客户端SDK参考
- 使用前必读
- SDK概述
- 隐私声明
- 合规使用指南
- Android SDK
- iOS/macOS SDK
- All Platform C++ SDK
- Web SDK
- 接入鉴权
- 附录
- 修订记录
-
常见问题
-
产品咨询
- SparkRTC支持哪些平台?
- SparkRTC Demo怎么体验?
- 在进行Windows的Demo使用或集成SDK时,提示微软C++标准库缺失,该如何获取?
- SparkRTC支持接入微信小程序吗?
- 实时音视频是什么?
- 实时音视频和直播有什么区别?
- SparkRTC是否支持在国外使用?
- SparkRTC RoomID是什么?取值区间值是多少?
- SparkRTC最多可以同时创建多少个房间?
- SparkRTC UserID是什么?取值范围是多少?
- 怎么理解SparkRTC的角色Role?
- SparkRTC最多可以支持多少个人同时视频通话?
- 实时音视频的时延是多少?
- SparkRTC是否支持连麦互动?
- SparkRTC是否支持双向的桌面推送?
- 实时音视频支持私有化部署吗?
- PC端实时音视频支持USB摄像头吗?
- 计费购买
- Signature相关
- 录制相关
-
SDK使用
- 移动端(Android/iOS)创建一个房间,是否支持PC端(MAC/Windows)接入?
- iOS平台如何缩减安装包体积?
- Android平台如何缩减安装包体积?
- iOS端是否可以监听远端离开房间?
- 背景音乐是否支持循环播放?
- SparkRTC是否支持调整背景音乐的播放进度?
- 支持监听房间成员进出房间吗?
- 如何监测断网和重连?
- 支持首帧渲染回调吗?能否监听画面开始渲染?
- 如何设置上行视频码率、分辨率和帧率?
- 有没有推荐的画面质量(码率、分辨率、帧率)相关参数配置?
- 如何实现横屏视频通话?
- 是否支持网络测速?如何操作?
- 是否支持音量大小提示?
- 自定义渲染支持哪些格式?
- SparkRTC支持iOS后台运行吗?
- 移动端如何实现录屏(屏幕分享)?
- 多人视频会议中,移动端和Web端可以进入同一房间吗?
- SparkRTC的Web端、移动端、PC端是不是同步的?
- Android SDK是否支持自定义采集数据?
- SparkRTC支持旁路推流吗?
- Windows端如何才能采集到被分享应用播放的声音?
- SDK是否支持断线重连机制?
- 如何创建房间?
- 两台手机同时运行SparkRTC APP,为什么无法互通?
- 鉴权是如何生成的?在什么时候生成?
- onVideoStats、onAudioStatus、onSubStreamStats回调触发时为什么程序会崩溃?
- 为什么本端听筒能听到自己的声音?
- setExternalAudioCapture(音频自采集)、setExternalVideoCapture(视频自采集)、setExternalMediaFrameOutput(视频自渲染)能在进入房间后开启吗?
- SparkRTC是否支持设置镜像画面?
- SparkRTC音视频过程中的上下行码率、分辨率、丢包率、音频采样率等信息怎么获取?
- SparkRTC是否支持设置本地采集音量?是否支持设置每个远端用户的播放音量?
- enableLocalVideo和muteLocalVideo有什么区别?
- enableLocalAudioStream和muteLocalAudio有什么区别?
- SparkRTC是否支持对房间进行权限校验?
- 接入PC端是否支持屏幕分享功能?
- SparkRTC是否支持将本地视频文件分享到实时音视频中?
- SparkRTC是否支持单纯的实时音频?
- 一个房间里可以同时有多路屏幕分享吗?
- SparkRTC是否支持1080P?
- 是否支持视频画面截图功能?
- 播放背景音乐是否支持在线音乐?
- 同一个页面中,可以创建N个RTC对象,通过N个UserID,分别登录到N个房间吗?
- Web端用宽高设置的推流分辨率适用于所有浏览器吗?
- Web端SDK在使用过程中拔掉摄像头,摄像头列表里面的数据如何清除?
- Web端SDK可以获取当前音量大小吗?
- Web端支持监听远端离开房间吗?
- Web端通话过程中为什么会出现回声、杂音、噪声、声音小?
- Web端如何切换摄像头和麦克风?
- SparkRTC支持白板功能吗?
- 相同UserID支持同时进入多个房间吗?
- SparkRTC房间的生命周期是多久?
- SparkRTC多人视频通话支持蓝牙耳机吗?
- SparkRTC多人视频通话支持仅订阅2/3/4人音频吗?
- 指定窗口分享,当窗口大小变化时,视频流的分辨率会跟着变化吗?
- 视频通话支持悬浮窗、大小画面切换功能吗?
- 发送自定义消息接口能实现聊天室、弹幕等功能吗?
- 支持查询所有的UserID吗?
- Web SDK中的checkSystemRequirements接口为什么会调用异常?
- 问题排查
-
产品咨询
- 文档下载
- 通用参考
- startAudioFile
- stopAudioFile
- pauseAudioFile
- resumeAudioFile
- adjustAudioFileVolume
- adjustAudioFilePlayoutVolume
- getAudioFileVolume
- getAudioFilePlayoutVolume
- getAudioFileDuration
- getAudioFilePosition
- setAudioFilePosition
- getAudioClipsVolume
- setAudioClipsVolume
- getVolumeOfAudioClip
- setVolumeOfAudioClip
- playAudioClip
- stopAudioClip
- stopAllAudioClips
- pauseAudioClip
- pauseAllAudioClips
- resumeAudioClip
- resumeAllAudioClips
- getAudioClipCurrentPosition
- setAudioClipPosition
- getAudioClipDuration
展开导读
链接复制成功!
音频文件播放管理
音频文件播放使用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。
stopAudioFile
virtual int stopAudioFile()
【功能说明】
停止播放音频文件,房间内调用。
【请求参数】
无
- 0:方法调用成功。
- < 0:方法调用失败。具体请参见HRTCErrorCode。
pauseAudioFile
virtual int pauseAudioFile()
【功能说明】
暂停播放音频文件,房间内调用。
【请求参数】
无
- 0:方法调用成功。
- <0:方法调用失败。具体请参见HRTCErrorCode。
resumeAudioFile
virtual int resumeAudioFile()
【功能说明】
恢复播放音频文件,房间内调用。
【请求参数】
无
- 0:方法调用成功。
- <0:方法调用失败。具体请参见HRTCErrorCode。
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。
- < 0:方法调用失败。具体请参见HRTCErrorCode。
setAudioClipPosition
virtual int setAudioClipPosition(int soundId, int pos)
【功能说明】
设置指定音效文件的播放位置。
【请求参数】
- soundId:音效ID,取值>=0。
- pos:播放位置,单位为ms。
【返回参数】
- 0:方法调用成功。
- < 0:方法调用失败。具体请参见HRTCErrorCode。
getAudioClipDuration
virtual int getAudioClipDuration(const char *filePath)
【功能说明】
获取音效的文件时长。
【请求参数】
filePath:音效文件路径,支持本地文件和网络文件。
【返回参数】
- > 0:音效文件时长,单位为ms。
- <= 0:方法调用失败。具体请参见HRTCErrorCode。