检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
事件回调（HWRtcEngine） 本章节介绍了iOS/Mac SDK的回调接口HWRtcEngineDelegate的详情。 表1 事件回调说明 接口 描述 onJoinSuccess 成功加入房间回调 onJoinRoomFailure 加入房间失败回调 onRejoinRoomSuccess
屏幕共享 startScreenShare - (int)startScreenShare; 【功能说明】 开启屏幕共享功能。 【请求参数】 无 【返回参数】 0：成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 目前可支持多路辅流共享，若需开启多辅流，请提交工单联系技术支持处理。
查询实时规模分布 功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。 Token认证：通过Token认证调用请求。
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/rtc/data/abnormal-events
辅流管理 setAuxiliaryVideoEncodeSmooth public abstract int setAuxiliaryVideoEncodeSmooth(boolean enabled); 【功能说明】 设置是否开启辅流的流畅度优先。 【请求参数】 enable：
aRelayConfiguration roomMediaRelayConfiguration) 【功能说明】 添加单个跨房。发起跨房后由云侧单向将本端上行流推至目标房间，即只推流不收流。 【请求参数】 roomMediaRelayConfiguration：跨房信息，具体请参见
自动诊断 您可以实时查看应用下所有通话体验异常的用户信息及异常明细数据，快速识别通话异常的类型和影响因素。 注意事项 由于统计数据需要时间，可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。 支持查询的时间跨度最长为24小时。 操作步骤 登录实时音视频控制台。
常用概念 应用标识 应用标识或应用ID，简称appID，是SparkRTC用来区分不同应用的唯一标识，在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间，同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念，用于用户之间的相互隔离。
主入口（HRTC） 本章节介绍了Web SDK的HRTC接口详情。 表1 主入口接口 接口 描述 checkSystemRequirements 检测浏览器是否兼容SparkRTC Web SDK。 须知： 如果Web SDK版本在2.0.2到2.0.9.300之间，需要在2023年10月29日前更新至2
onRoomStreamStatusNotify(IHRTCConnection* conn, int audienceState) 【功能说明】 房间流状态通知，业务调用云侧暂停/恢复接口后，端侧收到该通知。 【回调参数】 conn：连接对象。 audienceState: 0表示暂停 ，1表示恢复 onDestroyConnection
常见问题 加入房间时，userName必须填吗？ 非必填。userName、userId由App自定义，但可以相同。 userId：必填，string[64]类型，用户标识，userId需要保证应用内唯一。userId支持的字符包括：a-z、A-Z、0-9、连接符 '-'、下划线
视频管理 enableLocalVideo - (int)enableLocalVideo:(BOOL)enable; 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable：YES表示开启，NO表示关闭。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。
请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据，mid 不为null，查询实时数据时，查询起止时间不超过24个小时，每次查询单个用户时，支持跨天查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自
客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK内部系统错误
通话调查 您可以查看各房间的用户通话质量指标详情，对通话体验和端到端数据进行问题定位和原因分析，有效解决通话质量问题。 注意事项 “通话调查”中的数据仅供数据分析和质量问题查询，计费数据请以账单为准。 由于统计数据需要时间，可能会有5分钟以内的延迟。 查询说明 支持查询的时间跨度最长为14天。
视频管理 enableLocalVideo virtual int enableLocalVideo(bool enabled) 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable：true表示开启。false表示关闭。 【返回参数】 0：方法调用成功。 >
本地流对象（LocalStream） 该对象继承自Stream对象，并有如下新增接口。 表1 LocalStream接口 接口 描述 initialize 本地流初始化。 setAudioProfile 设置音频流配置。 setVideoProfile 设置视频流配置。 setScreenProfile
客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时，SDK无法自动恢复，需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ER
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
