- 最新动态
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- 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接口为什么会调用异常?
- 问题排查
-
产品咨询
- 文档下载
- 通用参考
链接复制成功!
房间功能
joinRoom
virtual int joinRoom(const HRTCJoinParam &joinParam)
【功能说明】
加入房间。该方法让用户加入通话房间。
【请求参数】
joinParam:加入房间信息。具体请参见HRTCJoinParam。
【返回参数】
- 0:方法调用成功。
- >0:方法调用失败。具体请参见HRTCErrorCode。
会触发以下回调:
- onConnectStateChange:连接状态发送改变。
- onJoinRoomSuccess:加入房间成功。
- onJoinRoomFailure:加入房间失败。
- onRemoteUserOnline:远端用户收到当前用户加入房间的通知。
音频的自动订阅策略设置只在音频订阅模式下生效。
leaveRoom
virtual int leaveRoom()
【功能说明】
离开房间。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
【注意事项】
- onLeaveRoom:离开房间回调。
- onConnectStateChange:连接状态改变回调。
- onRemoteUserOffline:远端用户收到当前用户离开房间的通知。
renewAuthorization
virtual int renewAuthorization(const char* signature, long long ctime)
【功能说明】
鉴权签名过期,收到onAuthorizationExpired签名鉴权过期回调后,更新鉴权签名。
【请求参数】
- signature:鉴权签名字符串。
- ctime:过期时间。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
changeUserRole
virtual int changeUserRole(HRTCRoleType role, const char *authorization, long long ctime)
【功能说明】
设置用户在当前房间内的角色类型,角色切换时使用。
【请求参数】
- role:用户角色类型,joiner类型和player类型,具体请参见HRTCRoleType。
- authorization:预留参数,填null或者空字符串。
- ctime:预留参数,填0。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
- 加入房间前,可以通过joinRoom的joinParam参数确认角色信息。
- 加入指定房间后才可以在指定房间内进行角色切换,当前仅支持joiner和player角色切换。跨房场景下,通过对应connection连接下的changeUserRole接口实现在跨入房间中的角色类型切换。
- 切换成功触发onUserRoleChangedNotify回调。切换失败会触发onError回调,返回HRTC_ERR_CODE_USER_ROLE_CHANGE_FAIL错误码。
- 同一时间不同房间最多只能有一个joiner,player切换joiner的时候,需要将其他房间的joiner先切换成player。
- 不支持缺省用户昵称入会。
changeUserName
virtual int changeUserName(const char* userName)
【功能说明】
房间内设置用户自己的昵称。
【请求参数】
userName:变更的昵称。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
- 该接口仅支持房间内调用,更改的昵称会被实时同步到房间内其他用户的用户列表,退出房间不会保存,再次加入房间变更为加入房间时设置的昵称(参考joinRoom接口注意事项)。
- 会触发用户名变更的通知回调onUserNameChangedNotify。
createConnection
virtual IHRTCConnection* createConnection(const char* roomId, IHRTCConnectionEventHandler* eventHandler) = 0)
【功能说明】
通过此接口可以创建一个与房间关联的IHRTCConnection连接对象,可多次调用以创建多个IHRTCConnection连接对象。调用每个连接对象中的joinRoom方法等接口,可以实现同时加入到多个房间,完成订阅和选看多个连接房间中的用户等功能。具体请参见IHRTCConnection和事件回调(IHRTCConnectionEventHandler)目录下的有关接口和回调。
【请求参数】
- roomId:房间ID。
- eventHandler:IHRTCConnectionEventHandler,引擎回调句柄,指定一个回调事件。SDK通过指定的事件通知应用程序的运行事件,如加入或离开房间等。具体请参见5.3.4-事件回调(IHRTCConnectionEventHandler)。
【返回参数】
IHRTCConnection:成功返回连接对象指针,失败返回内容为空。
同一时间最多只能创建4个连接对象,每个连接对象对应的房间ID必须互不相同。加上IHRTCEngine对象,即同时最多可加入5个房间,且在这5个房间中最多只能同时有一个joiner角色,其他只能为player角色。如果使用IHRTCEngine对象加入房间,则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。
addMultiRoomMediaRelay
virtual int addMultiRoomMediaRelay(HRTCMultiRoomMediaRelayConfiguration roomMediaRelayConfiguration)
【功能说明】
添加单个跨房。发起跨房后由云侧单向将本端上行流推至目标房间,即只推流不收流。
【请求参数】
roomMediaRelayConfiguration:跨房信息,具体请参见HRTCMultiRoomMediaRelayConfiguration。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
removeMultiRoomMediaRelay
virtual int removeMultiRoomMediaRelay(HRTCMultiRoomMediaRelayConfiguration roomMediaRelayConfiguration)
【功能说明】
删除单个跨房。
【请求参数】
roomMediaRelayConfiguration:跨房信息,具体请参见HRTCMultiRoomMediaRelayConfiguration。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
stopMultiRoomMediaRelay
virtual int stopMultiRoomMediaRelay()
【功能说明】
停止所有跨房。
【请求参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。