检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口总览 本章节介绍了iOS/macOS SDK的HWRtcConnection接口详情。 HWRtcConnection按照其功能可分类为：初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理。 单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。 初始化等基础接口
创建或更新录制规则 功能介绍 调用此接口创建或更新录制规则。 若当前app在请求的location中无录制规则，则会创建新的录制规则 若当前app在请求的location中已有录制规则，则会更新原来的录制规则 接口约束 一个app在一个location最多创建一个录制规则。 调试
辅流管理 setRemoteAuxiliaryStreamViewRotation virtual int setRemoteAuxiliaryStreamViewRotation(const char *userId, HRTCVideoRotation rotation) 【功能说明
appId获取方法请参见应用管理。
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs
修订记录 表1 修订记录 修改时间 修改说明 2023-11-30 第十三次正式发布 本次变更如下： 客户端对象（Client）新增旁路推流接口：startLiveStreaming、updateLiveStreaming和stopLiveStreaming。 2022-06-29
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
视频管理 setupRemoteView virtual int setupRemoteView(const char* userId, view_t view) 【功能说明】 设置远端流渲染视图（新选看接口），该接口不影响收流。 【请求参数】 userId：远端用户的唯一标识。
合流录制 场景说明 将房间中的多路音视频进行云端混流，再将混合后的音视频流录制成一个文件。 合流布局 在合流录制模式下，支持分屏九宫格模板和共享屏幕模板（主视窗居左/主视窗居右）两种预设合流布局。同时，也支持用户自定义合流布局样式（自定义视频窗格位置）。 九宫格模板 每个用户画面平铺在画布上
客户端错误码 本章节介绍了Web SDK的客户端错误码RtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因或建议处理方式 RTC_ERR_CODE_SUCCESS 0 success 成功。 RTC_ERR_CODE_RTC_SDK_ERROR 90000001
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第十八次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay
查询异常事件用户分布 功能介绍 查询指定APP下指定时间内的通话异常明细数据分布情况。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第十七次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/rtc/data
主入口（HRTC） 本章节介绍了Web SDK的HRTC接口详情。 表1 主入口接口 接口 描述 checkSystemRequirements 检测浏览器是否兼容SparkRTC Web SDK。 须知： 如果Web SDK版本在2.0.2到2.0.9.300之间，需要在2023
数据类型 本章节列出了Android SDK的所有数据类型，您可以结合HRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HRTCLogInfo 日志信息 HRTCCameraConfig 相机配置 HRTCEncryptionConfig 端到端加密参数 HRTCUserInfo
流对象（Stream） 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
事件回调（HWRtcConnection） 本章节介绍了iOS/macOS SDK的回调接口HWRtcConnectionDelegate的详情。 表1 事件回调说明 接口 描述 connection:onJoinSuccess 成功加入跨房房间回调 connection:onJoinRoomFailure
数据类型 本章节列出了iOS/macOS SDK的所有数据类型，您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
事件回调（HWRtcEngine） 本章节介绍了iOS/Mac SDK的回调接口HWRtcEngineDelegate的详情。 表1 事件回调说明 接口 描述 onJoinSuccess 成功加入房间回调 onJoinRoomFailure 加入房间失败回调 onRejoinRoomSuccess
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
