华为云用户手册

Token认证 Token是服务端生成的一串字符串，作为客户端进行请求的一个令牌。第一次登录后，服务器生成一个Token并将此Token返回给客户端，以后客户端只需带上这个Token前来请求数据即可，无需再次带上用户名和密码。Token有效期是24小时，从客户端获取开始算起（24小时是相对时间），需要使用同一个Token鉴权时，建议缓存起来使用，避免频繁调用。在Token过期前，务必刷新Token或重新 获取Token ，否则Token过期后会在服务端鉴权失败。 如果您获取Token多次，以最新的为准，前面的Token会被覆盖并失效。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 调用获取 IAM 用户Token（使用密码）接口获取Token，调用样例如下： POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 注：“username”即IAM用户名、“password”即登录华为云密码、“domainname”即账号名，“projectname”项目，您可以在我的凭证页面获取。 接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值为获取到的Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/{project_id}/products/{product_id} Content-Type: application/json X-Auth-Token: ABCDEFJ....

修订记录 发布日期 变更说明 2024-12-20 第二十五次正式发布。 本次变更如下： 优化批量查询SIM卡日用量接口的功能介绍及请求参数描述。 2024-11-19 第二十四次正式发布。 本次变更如下： 查询三网卡列表接口，新增请求参数“order_id”、“iccid”，表示订单号、SIM卡的ICCID。 结构体“SimDeviceMultiplyVO”中新增字段“iccid_mobile”，表示移动卡的ICCID。 结构体“SimDeviceMultiplyVO”中新增字段“iccid_unicom”，表示联通卡的ICCID。 结构体“SimDeviceMultiplyVO”中新增字段“iccid_telcom”，表示电信卡的ICCID。 结构体“SimDeviceMultiplyVO”中新增字段“order_id”，表示订单号。 2024-10-24 第二十三次正式发布。 本次变更如下： 优化SIM卡单卡停机、SIM卡单卡复机和激活实体卡接口的功能介绍描述。 2024-10-12 第二十二次正式发布。 本次变更如下： 查询流量池列表接口，新增成功状态的响应参数、请求参数“status”。 2024-09-12 第二十一次正式发布。 本次变更如下： 切换网络和SIM卡设置网络切换策略接口，新增请求参数“cid”及示例。 2024-09-11 第二十次正式发布。 本次变更如下： 新增批量查询SIM卡日用量接口。 2024-08-28 第十九次正式发布。 本次变更如下： 新增三网卡管理、三网卡策略管理接口组。 2024-08-16 第十八次正式发布。 本次变更如下： 优化查询SIM卡列表、查询SIM卡详情接口“device_status”、“device_model”、“device_status_date”、“dbm”、“signal_level”字段描述。 2023-11-21 第十七次正式发布。 本次变更如下： 批量查询实体卡流量接口，请求参数中新增“sim_card_ids”字段。 2023-11-21 第十六次正式发布。 本次变更如下： 批量查询实体卡流量接口，请求参数中新增“sim_card_ids”字段。 2022-11-15 第十五次正式发布。 本次变更如下： 新增后向流量池管理接口。 2022-07-28 第十四次正式发布。 本次变更如下： 新增月用量统计接口。 2022-06-10 第十三次正式发布。 本次变更如下： 新增标签管理、自定义属性接口。 2021-09-07 第十二次正式发布。 本次变更如下： 查询套餐列表信息接口，响应参数中新增参数price。 2021-06-24 第十一次正式发布。 本次变更如下： sim卡套餐列表查询接口，请求参数中新增可选参数limit和offset。 2021-05-25 新增 实体卡限速。 2021-05-14 第十次正式发布。 本次变更如下： 新增激活实体卡、SIM卡机卡重绑、清除实名认证信息接口。 查询SIM卡列表接口，响应参数中的sim_cards里的每条数据新增响应参数cut_net_flag（是否单独断网 true:断网，false:未断网 （当前仅电信卡支持）），exceed_cut_net_flag（是否达量断网 true:达量断网，false:未达量断网 （当前仅电信卡支持）），exceed_cut_net_quota（达量断网阈值（单位MB 当前仅电信卡支持）），imei_bind_remain_times（本月机卡绑定剩余次数（当前仅电信卡支持））。 查询SIM卡详情接口，新增响应参数cut_net_flag（是否单独断网 true:断网，false:未断网 （当前仅电信卡支持）），exceed_cut_net_flag（是否达量断网 true:达量断网，false:未达量断网 （当前仅电信卡支持）），exceed_cut_net_quota（达量断网阈值（单位MB 当前仅电信卡支持）），imei_bind_remain_times（本月机卡绑定剩余次数（当前仅电信卡支持））。 2021-04-22 第九次正式发布。 本次变更如下： 新增SIM卡申请断网/恢复在用、SIM卡达量断网/取消达量断网接口。 2021-04-22 第八次正式发布。 本次变更如下： 新增查询SIM卡实名认证信息接口。 2021-04-21 第七次正式发布。 本次变更如下： 查询SIM卡列表接口，新增查询参数real_named（是否已实名认证: true表示是，false表示否，系统SIM卡实名认证状态非实时），响应参数中的sim_cards里的每条数据新增响应参数real_named（是否已实名认证: true表示是，false表示否，系统SIM卡实名认证状态非实时）。 查询SIM卡详情接口，新增响应参数real_named（是否已实名认证: true表示是，false表示否，系统SIM卡实名认证状态非实时）。 2021-04-07 第六次正式发布。 本次变更如下： 新增查询流量池列表、查询流量池成员列表接口。 2021-04-06 第五次正式发布。 本次变更如下： 新增SIM卡单卡停机、SIM卡单卡复机接口。 2021-02-25 第四次正式发布。 本次变更如下： 新增批量查询实体卡流量接口。 2020-12-09 第三次正式发布。 本次变更如下： 查询SIM卡列表接口，新增查询参数msisdn,customer_attribute1(自定义属性一),customer_attribute2(自定义属性二),customer_attribute3(自定义属性三),customer_attribute4(自定义属性四),customer_attribute5(自定义属性五),customer_attribute6(自定义属性六)，新增返回参数sim_pool_id(流量池ID，如果该SIM卡组池的话会返回)，msisdn,imsi,customer_attribute1(自定义属性一),customer_attribute2(自定义属性二),customer_attribute3(自定义属性三),customer_attribute4(自定义属性四),customer_attribute5(自定义属性五),customer_attribute6(自定义属性六)。 查询SIM卡列表接口，新增返回参数sim_pool_id(流量池ID，如果该SIM卡组池的话会返回)，msisdn,imsi,customer_attribute1(自定义属性一),customer_attribute2(自定义属性二),customer_attribute3(自定义属性三),customer_attribute4(自定义属性四),customer_attribute5(自定义属性五),customer_attribute6(自定义属性六)。 2020-09-09 第二次正式发布。 本次变更如下： 查询SIM卡列表接口，新增参数排序属性（sort）和排序方向(order)字段，提供默认排序方式（按创建时间倒序）以外的排序。 2020-05-20 第一次正式发布。

实现步骤 请参见OBS帮助中心创建桶。若已有OBS桶，请直接执行步骤2。 创建的OBS桶所在区域必须为华北-北京四。 OBS桶授权。 登录 实时音视频 控制台。 在左侧导航树中选择“云资源授权”，进入桶授权页面。 在对应的OBS桶行单击“授权”，完成桶授权。 配置录制规则。 登录实时音视频控制台。 在左侧导航树中选择“应用管理”，进入应用管理页面。 在需要创建录制规则的应用行单击“录制配置”，进入录制配置页面。 在“录制规则”页签，单击“添加”，进入添加录制规则页面。 一个应用ID仅支持创建一个录制规则。 请您按照实际需求配置录制参数，参数说明如表1所示。 表1 录制参数说明 参数名 描述 存储-桶 存储录制文件的OBS桶。 目前录制文件仅支持存储到华北-北京四的OBS桶中。 区域 OBS桶所在的区域。 存储-路径 存储录制文件的OBS桶路径。 录制格式 录制文件的格式，支持HLS和MP4文件格式。 HLS规则 m3u8命名规则 录制m3u8文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。 录制周期 录制时长支持0-720分钟，最小录制周期为1分钟，最大录制周期为12小时，超过12小时，系统将按照命名规则生成新文件。如果录制周期为0，则整个流录制为一个文件。 最大断流合并时长 支持如下三种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 断流后不生成新文件：是指录制的直播流中断后，会和之前录制的文件合并为一个文件。最大断流合并时长为30天。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。 MP4规则 mp4命名规则 录制mp4文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。 录制周期 录制时长支持1-180分钟，最小录制周期为1分钟，最大录制周期为3小时，超过3小时，系统将按照命名规则生成新文件。 最大断流合并时长 支持如下两种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。 单击“确定”，在录制规则列表中会增加一条新的录制规则。 图2 录制规则 您可以在录制规则列表中，根据实际需求选择是否开启自动录制功能。自动录制功能开启后，若该应用下有新创建的房间，则会按照已配置的录制规则自动对该房间中的实时音视频互动过程进行录制。 自动录制功能开启后，仅对同一应用下新创建的房间生效，自动录制功能开启前已创建的房间不生效。 加入房间。 录制规则配置完成后，您可以通过SparkRTC APP加入某个SparkRTC房间进行音视频互动，SparkRTC服务会根据配置的录制规则对正在直播的音视频进行录制。 若配置录制规则时，未开启自动录制功能，则加入SparkRTC房间后，您需要调用实时音视频API开启云端录制任务，SparkRTC才会根据API中的录制规则ID对实时音视频互动画面进行录制。 回放录制文件。 录制完成后，您可以在OBS控制台中或通过回调消息查看录制文件。 通过OBS控制台查看录制文件 登录OBS控制台。 在左侧导航栏中，选择“桶列表”。 在桶列表中单击存储SparkRTC录制文件的桶，进入“概览”页面。 在左侧导航栏，单击“对象”，查看录制文件信息。 您还可以对录制文件进行下载、分享等操作，具体请参见OBS帮助中心。

实现流程 创建OBS桶：创建用于存储SparkRTC录制文件的OBS桶，若已有OBS桶，请直接执行2。 由于单AZ桶的可靠性低于多AZ桶，为避免因OBS服务异常导致录制失败，建议您创建多AZ桶用于录制文件的存储。 OBS桶授权：在SparkRTC服务中对存储录制文件的OBS桶进行授权，允许SparkRTC服务将录制文件存储在对应的OBS桶中。 配置录制规则：为实时音视频互动配置录制规则，并开启自动录制功能，加入SparkRTC房间后，与应用中的录制规则ID相同的录制模板会自动生效，录制内容按录制设置存储至OBS中。还可以通过设置回调地址获取录制任务状态通知。 加入房间：录制规则配置完成后，您可以通过SparkRTC APP加入某个SparkRTC房间进行音视频互动，SparkRTC会根据配置的录制规则对正在直播的音视频进行录制。 若配置录制规则时，未开启自动录制功能，则加入SparkRTC房间后，您需要调用实时音视频API开启、查询和控制云端录制任务。SparkRTC服务才会根据接口中的录制规则ID对实时音视频互动画面进行录制。 回放录制文件：录制完成后，在已配置的回调地址中会收到录制任务的回调消息，您可以获取到录制文件的基本信息，也可以在OBS中管理录制文件，如下载、分享、删除等。 录制文件的分辨率与推流分辨率相关，按推流原分辨率进行录制。

合流布局 在合流录制模式下，支持分屏九宫格模板和共享屏幕模板（主视窗居左/主视窗居右）两种预设合流布局。同时，也支持用户自定义合流布局样式（自定义视频窗格位置）。 九宫格模板 每个用户画面平铺在画布上，大小一致。根据用户数量，动态调整每个画面的大小和位置。最多支持25个画面。不同人数的实际布局效果如下图所示。 如果实际视频流的宽高比与视窗的宽高比不一致，视频画面会裁剪以适配视窗的大小。 中途有流退出房间，则该条流的画面会被后进入房间的流顶替。 如果房间内的人数不足，则剩余位置显示背景色。 如果用户只发送音频，仍然会占用画面位置。 支持背景图，如果房间内人数不足，显示背景图。 屏幕共享模板 屏幕分享（或者主讲人摄像头画面）始终占据屏幕左侧或者右侧大画面位置，其他用户依次垂直排列于旁边。最多支持17个画面。不同人数的实际布局效果如下图所示。 大视窗画面，可选择主讲摄像头流或共享屏幕流。 大视窗画面，显示指定的UID用户的视频，如果未指定或者指定用户未进入频道，大视窗区域显示背景色。 左侧大视窗为了保持内容的完整性采用缩放方式处理，右侧小视窗采用裁剪方式适配视窗的大小。 右侧小视窗画面按照加入房间的时间先后顺序排列。 右侧小视窗有流退出房间，则该条流的画面会被后进入房间的流顶替。 如果房间内的人数不足，则剩余位置显示背景色。 如果用户只发送音频，仍然会占用画面位置。 支持背景图，如果房间内人数不足，显示背景图。 自定义布局模板 支持用户自定义合流布局样式，可灵活设置用户画面的大小，指定用户画面在视频画布上的相对位置。 可自定义各个视频窗格在画布上的位置。 可自定义各个视频窗格的宽和高。 针对每一个窗格，可通过user_id指定显示房间内某一用户。 针对窗格，可自定义选择呈现摄像头流或者屏幕分享流。 如果实际视频流的宽高比与视窗的宽高比不一致，自定义布局场景下支持选择裁剪和缩放两种模式。 如果房间内的人数不足，则剩余位置显示背景色。 如果用户只发送音频，仍然会占用画面位置。 支持背景图，如果房间内人数不足，则显示背景图。

实现步骤 请参见OBS帮助中心创建桶。若已有OBS桶，请直接执行步骤2。 创建的OBS桶所在区域必须为华北-北京四。 OBS桶授权。 登录实时音视频控制台。 在左侧导航树中选择“云资源授权”，进入桶授权页面。 在对应的OBS桶行单击“授权”，完成桶授权。 配置录制规则。 登录实时音视频控制台。 在左侧导航树中选择“应用管理”，进入应用管理页面。 在需要创建录制规则的应用行单击“录制配置”，进入录制配置页面。 在“录制规则”页签，单击“添加”，进入添加录制规则页面。 一个应用ID仅支持创建一个录制规则。 请您按照实际需求配置录制参数，参数说明如表1所示。 表1 录制参数说明 参数名 描述 存储-桶 存储录制文件的OBS桶。 目前录制文件仅支持存储到华北-北京四的OBS桶中。 区域 OBS桶所在的区域。 存储-路径 存储录制文件的OBS桶路径。 录制格式 录制文件的格式，支持HLS和MP4文件格式。 HLS规则 m3u8命名规则 录制m3u8文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。 录制周期 录制时长支持0-720分钟，最小录制周期为1分钟，最大录制周期为12小时，超过12小时，系统将按照命名规则生成新文件。如果录制周期为0，则整个流录制为一个文件。 最大断流合并时长 支持如下三种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 断流后不生成新文件：是指录制的直播流中断后，会和之前录制的文件合并为一个文件。最大断流合并时长为30天。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。 MP4规则 mp4命名规则 录制mp4文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。 录制周期 录制时长支持1-180分钟，最小录制周期为1分钟，最大录制周期为3小时，超过3小时，系统将按照命名规则生成新文件。 最大断流合并时长 支持如下两种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。 单击“确定”，在录制规则列表中会增加一条新的录制规则。 图3 录制规则 您可以在录制规则列表中，根据实际需求选择是否开启自动录制功能。自动录制功能开启后，若该应用下有新创建的房间，则会按照已配置的录制规则自动对该房间中的实时音视频互动过程进行录制。 自动录制功能开启后，仅对同一应用下新创建的房间生效，自动录制功能开启前已创建的房间不生效。 加入房间。 录制规则配置完成后，您可以通过SparkRTC APP加入某个SparkRTC房间进行音视频互动，SparkRTC服务会根据配置的录制规则对正在直播的音视频进行录制。 若配置录制规则时，未开启自动录制功能，则加入SparkRTC房间后，您需要调用实时音视频API开启云端录制任务，SparkRTC才会根据API中的录制规则ID对实时音视频互动画面进行录制。 回放录制文件。 录制完成后，您可以在OBS控制台中或通过回调消息查看录制文件。 通过OBS控制台查看录制文件 登录OBS控制台。 在左侧导航栏中，选择“桶列表”。 在桶列表中单击存储SparkRTC录制文件的桶，进入“概览”页面。 在左侧导航栏，单击“对象”，查看录制文件信息。 您还可以对录制文件进行下载、分享等操作，具体请参见OBS帮助中心。

实现流程 创建OBS桶：创建用于存储SparkRTC录制文件的OBS桶，若已有OBS桶，请直接执行2。 由于单AZ桶的可靠性低于多AZ桶，为避免因OBS服务异常导致录制失败，建议您创建多AZ桶用于录制文件的存储。 OBS桶授权：在SparkRTC服务中对存储录制文件的OBS桶进行授权，允许SparkRTC服务将录制文件存储在对应的OBS桶中。 配置录制规则：为实时音视频互动配置录制规则，并开启自动录制功能，加入SparkRTC房间后，与应用中的录制规则ID相同的录制模板会自动生效，录制内容按录制设置存储至OBS中。还可以通过设置回调地址获取录制任务状态通知。 加入房间：录制规则配置完成后，您可以通过SparkRTC APP加入某个SparkRTC房间进行音视频互动，SparkRTC会根据配置的录制规则对正在直播的音视频进行录制。 若配置录制规则时，未开启自动录制功能，则加入SparkRTC房间后，您需要调用实时音视频API开启、查询和控制云端录制任务。SparkRTC服务才会根据接口中的录制规则ID对实时音视频互动画面进行录制。 回放录制文件：录制完成后，在已配置的回调地址中会收到录制任务的回调消息，您可以获取到录制文件的基本信息，也可以在OBS中管理录制文件，如下载、分享、删除等。 录制文件的分辨率与推流分辨率相关，按推流原分辨率进行录制。

为什么无法打开摄像头？ 摄像头打开失败有多种原因，建议您参照如下方面进行初步排查： 确认摄像头权限是否已打开。Android和iOS系统都有权限管理，请在系统设置中进行检查。同时Android的部分安全软件也会进行权限管理。 检查是否有其他应用占据了摄像头。若有请关闭后，重启手机再打开摄像头。 摄像头硬件问题。打开系统自带的拍摄视频程序看是否可以录像。 若上述方法均无法解决问题，建议您提交工单，申请华为云技术客服协助解决问题。 父主题： 问题排查

为什么视频会出现卡顿？ 网络、设备性能等原因都可能导致视频出现卡顿。若出现视频播放卡顿问题，您可以先参考如下方法进行初步排查。 自检操作，您可以从以下几方面进行排查。 判断是持续性的还是一次性的卡顿。一次性的卡顿是由网络和设备的随机性导致，属于正常现象。 检查网络状态，判断连接是否正常。 如果网络连接正常但依然卡顿，请尝试更换网络连接，检查在网络状态良好的条件下是否依然卡顿。 如果网络良好且条件允许，请尝试更换设备。 如果有视频前处理，例如美颜等，请先关闭前处理，检查卡顿是否由于前处理导致。 通过视镜功能进行端到端链路检查。 若上述方法均无法解决问题，建议您提交工单，申请华为云技术客服协助解决问题。 父主题： 问题排查

如何处理视频黑屏问题？ 常见的视频黑屏问题有以下三种情况： 本地视频黑屏远端视频正常。 本地视频正常远端视频黑屏。 本地远端视频都黑屏。 可能导致出现视频黑屏的原因如下： 本地网络信号差或者信号中断。 通话中有一方的网络出现问题，其他人也会看不到此用户的视频。 用户主动关闭了视频。 您可以通过视镜功能进行端到端链路检查。 若问题仍未解决，建议您提交工单，申请华为云技术客服协助解决问题。 父主题： 问题排查

操作步骤 登录实时音视频控制台。 在左侧导航树中选择“用量统计”，进入用量统计页面。 您也可以通过在“应用管理”页面的“操作”列，单击“用量”跳转到“用量统计”页面进行查看。 选择需要查看的时间和应用名称，即可查看到相关统计数据及明细。 统计图中展示了不同分辨率档位（标清/高清/超清）的视频通话时长和纯语音通话时长统计数据。在统计图中您可以进行如下操作： 单击如下图标可以选看或取消选看不同规格的音视频通话时长统计情况。 图1 规格图标 将鼠标指针停留在统计数值线上，可以查看各规格的音视频通话时长。 将鼠标指针停留在统计图上，滚动鼠标滚轮可针对某时间跨度范围内的统计图时间横轴进行拉大或缩小整体占比。 图2 音视频时长统计 “用量统计”中记录的通话时长仅供数据分析和参考使用，计费数据请以账单为准。

看板 您可以在看板页签中查看项目的整体状态，包含当前房间/用户数、5秒加入房间成功率和音视频流畅度，以及通话的异常数据。 图1 看板 当前房间数：从第一个用户加入房间到最后一个用户离开房间，计为一个通话房间。 当前用户数：当前在线用户数（同用户名不同房间，计为多人）。 5秒加入房间成功率：5秒内加入房间成功人数/尝试加入房间人数。 音频流畅度：（总音频时长- 音频卡顿时长 ）/总音频时长。音频卡顿达到200ms，即被计入卡顿时长。 视频流畅度：（总视频时长- 视频卡顿时长 ）/总视频时长。视频卡顿达到600ms，即被计入卡顿时长。 中国地图：展示各地域的在线用户数。 报警：动态显示栏，仅在发生异常事件时显示，最多展示6条报警信息。异常事件及对应的阈值如表1所示。 表1 异常事件说明 异常事件 检测阈值 系统CPU占用高 80% App CPU占用高 70% 音频上行网络延时 500ms 音频上行网络抖动 500ms 视频上行网络延时 500ms 视频上行网络抖动 500ms 音频下行网络延时 500ms 音频下行网络抖动 500ms 视频下行网络延时 500ms 视频下行网络抖动 500ms 上行音频丢包 20% 上行视频丢包 20% 下行音频丢包 20% 下行视频丢包 20% 下行视频卡顿 5% 下行音频卡顿 3%

网络 您可以在网络页签中查看客户端音视频上行优质传输率，及各地域的上行优质传输率。 您可以在页面上方调整需要查看的时间范围，以及指定是否实时更新图表数据。 总览：展示客户端音视频上行优质传输率。 图12 总览 客户端视频上行优质传输率：从发送端到SparkRTC的视频优质传输率。 客户端音频上行优质传输率：从发送端到SparkRTC的音频优质传输率。 分布：将地域按在线用户数降序排列，并显示各地域的客户端音视频上行优质传输率。各数据项说明请参见网络总览。

查看通话体验质量 在通话体验质量区域中展示的是各个用户作为接收端的通话体验质量（通过接收到的音视频码率进行判断）。将鼠标指针停留在通话体验质量图上，滚动鼠标滚轮可针对某时间跨度范围内的质量图时间横轴进行拉大或缩小整体占比。 说明：通话体验质量面板默认显示所有的发送端数据，若发送端较多，您可以通过在当前面板的下拉框中选择只显示您关注的发送端。 图3 通话体验质量面板 在通话体验质量面板中，横轴表示通话时间，以横轴为界上下分别显示视频和音频的通话体验： 横轴以上为视频接收码率，若有多个发送端，则每个发送端会占一条线，以不同颜色区分。 红色向上的毛刺表示视频卡顿。 横轴以下为音频接收码率，若有多个发送端，则每个发送端会占一条线，以不同颜色区分。 红色向下的毛刺表示音频卡顿。 若发现某个发送端的通话体验质量有问题，您可以通过单击面板右上角的查看详情，进入用户详情页面。分别在视频选看、音频选看和辅流选看页签中选择该发送端，查看相关音视频质量指标详情。各质量指标说明请参见分析通话质量问题。

分析通话质量问题 在用户详情页面可查看通话基本信息、用户画像信息、视频选看数据和音频选看数据和辅流选看数据，如图4所示。 图4 用户详情页面 其中，音视频选看和辅流选看页签中展示的是从特定发送端到接收端的音视频质量指标详情，您可以通过分析各项质量指标，找到通话体验质量问题所在。 通话基本信息：可查看房间ID、应用ID、 域名 、房间状态、整段通话的起止时间。 用户画像信息：可查看用户在线时长、5s加入房间失败次数、推拉流失败次数。 视频选看：展示选定视频通话的发送端与接收端的质量监控数据，包含视频分辨率、丢包率、卡顿率、帧率、码率数据。 音频选看：展示选定音频通话的发送端与接收端的质量监控数据，包含音频丢包率、卡顿率、码率。 辅流选看：展示选定的发送端用户与对应接收端用户共享屏幕（窗口）的质量监控数据。包含码率、帧率、卡顿率、丢包率、分辨率、抖动和时延。

查看用户操作事件 分别在视频选看、音频选看和辅流选看页签的右侧操作列单击“事件”，可以查看用户在通话过程中的所有操作事件详情。通过分析用户在客户端的操作步骤，复现相应的场景，辅助定位软件问题和分析bug。具体事件类型及ID如表1所示。 图5 操作事件详情 表1 用户操作事件说明 事件ID 事件类型 1 加入房间 2 离开房间 3 视频选看/批量选看 5 静音/取消静音 6 切换网络 7 开启/关闭摄像头 9 切换设备 10 DNS查询、TCP/TLS建链、首帧显示起止时间 11 切换角色 12 开始发送媒体流 13 媒体出流成功 14 辅流共享 16 音频选看/取消选看 17 跨房间 18 信令/媒体通道连接 19 上行视频设置 20 下行音频设置 21 服务器调度失败 22 推流成功率打点 23 拉流成功率打点

步骤五：查看录制文件 录制完成后，您可以在OBS控制台中或通过回调消息查看录制文件。 通过OBS控制台查看录制文件 登录OBS控制台。 在左侧导航栏中，选择“桶列表”。 在桶列表中单击存储SparkRTC录制文件的桶，进入“概览”页面。 在左侧导航栏，单击“对象”，查看录制文件信息。 您还可以对录制文件进行下载、分享等操作，具体请参见OBS帮助中心。 通过回调消息查看录制文件 若您设置了录制回调地址，则每生成一个录制文件都将收到录制回调消息。具体录制回调配置方法及消息字段说明请参见配置录制回调。

步骤三：配置录制规则 登录实时音视频控制台。 在左侧导航栏中，选择“应用管理”，进入“应用管理”页面。 在需要创建录制规则的应用行，单击“配置”，进入录制配置页面。 在“录制规则”区域，单击“添加”，进入添加录制规则页面。 一个应用ID在相同区域仅支持创建一个录制规则。 请您按照实际需求配置录制参数，参数说明如表1所示。 表1 录制参数说明 参数名 描述 存储-桶 存储录制文件的OBS桶。 目前录制文件仅支持存储到华北-北京四的OBS桶中。 区域 OBS桶所在的区域。 存储-路径 存储录制文件的OBS桶路径。 录制格式 录制文件的格式，支持HLS和MP4文件格式。 HLS规则 m3u8命名规则 录制m3u8文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。 录制周期 录制时长支持0-720分钟，最小录制周期为1分钟，最大录制周期为12小时，超过12小时，系统将按照命名规则生成新文件。如果录制周期为0，则整个流录制为一个文件。 最大断流合并时长 支持如下三种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 断流后不生成新文件：是指录制的直播流中断后，会和之前录制的文件合并为一个文件。最大断流合并时长为30天。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。 MP4规则 mp4命名规则 录制mp4文件的存储路径和文件的前缀。 默认命名格式： {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下： app_id：应用ID。 record_format：录制格式。 stream：流名。 file_start_time：文件生成时间。 录制周期 录制时长支持1-180分钟，最小录制周期为1分钟，最大录制周期为3小时，超过3小时，系统将按照命名规则生成新文件。 最大断流合并时长 支持如下两种配置： 断流后生成新文件：是指录制的直播流中断后，会立即生成新的录制文件。 其他数值：是指录制的直播流中断时间在设置范围内，则和之前录制的文件合并为一个文件，否则，生成新的录制文件。 单击“确定”，在录制规则列表中会增加一条新的录制规则。 图2 录制规则 您可以在录制规则列表中，根据实际需求选择是否开启自动录制功能。自动录制功能开启后，若该应用下有新创建的房间，则会按照已配置的录制规则自动对该房间中的实时音视频互动过程进行单流录制。 自动录制功能开启后，仅对同一应用下新创建的房间生效，自动录制功能开启前已创建的房间不生效。

编辑应用 您可以对应用进行启用、停用和删除操作，还支持生成临时Token。 登录实时音视频控制台。 在左侧导航栏中，选择“应用管理”，进入“应用管理”页面。 在需要编辑的应用行单击应用名称，进入应用详情页面。 在应用详情页面，您可以查看到该应用的ID、名称、对应域名、创建时间、鉴权密钥等信息。 图2 编辑应用 在应用编辑页面，您可以根据实际需求进行如下操作： 单击“启停应用”，启用或停用应用。 单击“删除”，删除已不再使用的应用。

创建应用 登录实时音视频控制台。 在左侧导航栏中，选择“应用管理”，进入“应用管理”页面。 单击“创建应用”，进入“创建应用”页面。 参数配置说明，如表1所示。 图1 创建应用 表1 参数说明 参数 说明 应用名称 应用的名称。可由字母、数字和“-”、“_”组成，长度不能超过64个字符。 应用类型 应用的类型。 包含如下选项： 教育 文娱 金融 其他 专属场景A 专属场景B 专属场景C 须知： 专属场景为特殊场景，不建议勾选，否则当前应用无法正常使用。 单击“创建”，完成应用的创建。 应用成功创建后，您可以在应用列表中查看到新创建的应用信息，包括应用名称、应用ID、域名、创建时间和状态。您还可以根据实际情况进行如下操作： 单击，根据不同状态筛选应用。 单击，刷新应用的列表信息。 单击，自定义应用的列表项。 单击，复制应用ID。 编辑应用：启用、停用或删除应用，生成临时Token。 查询通话质量信息：查询各房间的音视频通话质量等数据详情。 查询通话用量统计：查询近90天的音视频互动时长。 配置录制：创建录制规则，将实时音视频互动内容进行录制并将录制的内容存储到OBS桶中。

回调示例 录制文件生成事件回调示例如下。回调消息体字段如表1所示。 { "event_type": "RECORD_FILE_COMPLETE", "stream_name": "mystream", "record_format": "HLS", "download_url": "https://abc-rtc-bucket2.obs.cn-north-4.myhuaweicloud.com/Record/Record/5fcdf5651xxxxxx6f835d0d4.SparkRTC.myhuaweicloud.com/live/continuous_record/hls/mystream_2021-04-28-08-57-07/mystream_2021-04-28-08-57-07.m3u8", "file_size": 26254952, "record_duration": 65, "start_time": "2021-04-28T08:56:57Z", "end_time": "2021-04-28T08:58:02Z", "width": 1280, "height": 720, "obs_location": "http://obs.cn-north-4.myhuaweicloud.com", "obs_bucket": "abc-rtc-bucket2", "obs_object": "Record/Record/5fcdf5651xxxxxx6f835d0d4.SparkRTC.myhuaweicloud.com/live/continuous_record/hls/mystream_2021-04-28-08-57-07/mystream_2021-04-28-08-57-07.m3u8", "app_id": "5fcdf5651xxxxxx6f835d0d4", "job_id": "608196a2fa1xxxxxx515147f32ef463b", "room_id": "room01" }

操作步骤 登录实时音视频控制台。 在左侧导航栏中，选择“应用管理”，进入“应用管理”页面。 在需要创建录制回调的应用行，单击“配置”，进入录制配置页面。 在“回调配置”区域，单击“编辑”，配置回调信息，如图1所示。 图1 添加录制回调地址 回调地址：接收回调信息的服务器地址，仅支持HTTP和HTTPS协议。 回调秘钥：录制回调的鉴权密钥，鉴权串长度范围：[32,64]。录制回调鉴权签名的生成方法，请参考《常见问题》的“如何对录制回调进行鉴权？”章节。

接口总览 本章节介绍了Android SDK的HRTCConnection接口详情。 HRTCConnection按照其功能可分类为：初始化等基础接口、房间功能、音频管理、视频管理、屏幕共享。 单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。 表1 初始化等基础接口 接口 描述 release 释放Connection setEncryption 设置端到端加密模式 setNetworkBandwidth 设置网络带宽限制 表2 房间功能接口 接口 描述 joinRoom 加入房间 leaveRoom 离开房间 getRoomId 获取房间id renewAuthorization 更新签名 changeUserRole 切换角色 changeUserName 修改用户昵称 表3 视频管理接口 接口 描述 setPriorRemoteVideoStreamType 设置优先选看档位 pullRemoteVideo 订阅或取消订阅远端用户 setupRemoteView 设置远端用户窗口 startRemoteStreamView 按档位选看远端用户，并设置用户窗口 stopRemoteStreamView 取消订阅远端用户，并清除此用户的窗口 pullAllRemoteVideo 订阅或取消订阅全部远端用户，对未入会用户也有影响 setRemoteVideoStreamType 切换用户指定档位的视频 updateRemoteRenderMode 设置远端视频渲染模式，镜像模式 setRemoteVideoAdjustResolution 远端流自动调整分辨率开关 startAllRemoteView 批量设置远端流视图 表4 音频管理接口 接口 描述 muteRemoteAudio 远端用户静音开关 muteAllRemoteAudio 所有远端用户静音开关 adjustPlaybackVolume 调整单个用户播放音量 表5 自定义渲染接口 接口 描述 setExternalAudioFrameOutputEnable 音频流第三方播放开关（音频自渲染） setExternalVideoFrameOutputEnable 视频流第三方渲染开关（视频自渲染） setExternalDataFrameOutputEnable 辅流第三方渲染开关（辅流自渲染） 表6 辅流管理接口 接口 描述 startRemoteAuxiliaryStreamView 订阅远端用户辅流，并设置窗口 stopRemoteAuxiliaryStreamView 取消订阅远端用户辅流，并清除用户窗口 updateRemoteAuxiliaryStreamRenderMode 设置辅流渲染填充方式，镜像模式 setRemoteAuxiliaryStreamViewRotation 设置辅流旋转角度 父主题： HRTCConnection

基本使用逻辑 创建新的项目工程，导入 SDK 后，需要创建客户端并获取本地音视频设备信息。 创建本地流并初始化。 当用户加入房间后，将通过回调的方式通知房间内的其他用户，收到用户加入的回调后，可以对音视频流进行订阅、取消订阅等其它操作。 在会中，也可以对本地录音或播放设备等进行配置。 用户离开房间后，房间内其他用户会收到该用户离开的回调信息，离开房间后，需销毁对应资源。 在时序图中，单击相应接口名称可快速跳转到相应接口位置查看其使用方法。 父主题： Web SDK

鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式，需要在SDK加入房间时设置“signature”和“ctime”。“signature”为标识签名，由租户使用华为云SparkRTC提供的“app_key”，“app_id”以及当前的“room_id”，“user_id”，“ctime”，按照华为SparkRTC的签名生成样例自行生成。具体参数说明请参见表1。 //认证用的app_key和app_id硬编码至代码中或以明文形式存储会有极大风险。建议密文形式配置存储在文件或者环境变量中，使用时解密，以确保安全。本例以app_key和app_id存放至环境变量为例，运行前请先在本地环境中设置完成环境变量APP_KEY和APP_ID。 app_key = System.getenv("APP_KEY"); app_id = System.getenv("APP_ID"); signature = hmacSha256(app_key,(app_id + room_id + user_id + ctime)) 表1 参数说明 参数 说明 app_key 华为云SparkRTC针对每个app生成的鉴权密钥，需要安全保存，谨防泄漏。 app_key的获取方法请参见如何获取密钥？。 app_id 华为云SparkRTC生成的应用ID。 app_id请在实时音视频控制台的“应用管理”中获取。 room_id 租户自行创建的房间ID。 user_id 租户接入华为云SparkRTC系统的用户ID。 ctime 签名鉴权的过期时间。是系统当前UTC时间（unix时间戳）加上鉴权过期时间（推荐2小时，最长需要小于12小时）。单位为秒。 说明： ctime为创建时间+过期时间，例如，当前时间为9点，鉴权过期时间为30分钟，则ctime为9点30分。即超过9点30分后，signature签名将失效。 建议租户构建自己的应用签名分发服务器，以防止“app_key”下沉到终端APP的过程中造成不必要的泄漏，鉴权原理如图1所示。 图1 鉴权原理

环境要求 OHOS SDK需要集成到APP工程中，建议您在如下推荐环境中进行集成开发。 准备DevEco，推荐使用4.0.0(10) SDK及以上。 准备Android运行环境：API 21、Android 5.0以上设备。 支持的终端CPU架构：armeabi-v7a、arm64-v8a。 手机的CPU架构可通过以下方式查询。 手机开启USB调试，连接上电脑，然后打开Windows操作系统中的cmd程序，输入如下命令： adb shell getprop ro.product.cpu.abi

基本使用逻辑 创建新的项目工程，导入SDK后，需要先创建引擎。 您可以在入会前进行视频编码、声音播放模式等参数的配置。 设置本地视图。 加入房间后，将通过回调的方式通知房间内的其他用户，收到用户加入的回调后，可以为其设置远端视图。 在会中，也可以进行切换摄像头等参数的配置。 离开房间后，需销毁对应资源。 在时序图中，单击相应接口名称可快速跳转到相应接口位置查看其使用方法。 父主题： All Platform C++ SDK

设备管理 表11 设备管理接口 接口 描述 setSpeakerModel 设置声音播放模式（只支持iphone） setCameraConfig 设置摄像头相关参数 switchCamera 切换前后镜头（只支持iphone） recordingDeviceTest 音频采集设备测试（只支持macOS） finishRecordingDeviceTest 结束音频采集设备测试（只支持macOS） playbackDeviceTest 音频播放设备测试（只支持macOS） finishPlaybackDeviceTest 结束音频播放设备测试（只支持macOS） echoTest 音频设备回路测试（只支持macOS） finishEchoTest 结束音频设备回路测试（只支持macOS） cameraDeviceTest 视频采集设备测试 finishCameraDeviceTest 结束视频采集设备测试

音效文件播放管理 表7 音频文件播放管理接口 接口 描述 startAudioFile 开始播放音频文件 stopAudioFile 停止播放音频文件 pauseAudioFile 暂停播放音频文件 resumeAudioFile 恢复播放音频文件 adjustAudioFileVolume 调节音频文件播放音量 adjustAudioFilePlayoutVolume 设置本地播放音频音量 getAudioFileVolume 获取音频文件播放音量 getAudioFilePlayoutVolume 获取音频文件本地播放音量 getAudioFileDuration 获取音频文件时长 getAudioFileCurrentPosition 获取当前音频播放位置 setAudioFilePosition 设置音频播放位置 getAudioClipsVolume 获取音效总音量 getVolumeOfAudioClip 获取指定音效音量 setAudioClipsVolume 设置音效总音量 setVolumeOfAudioClip 设置指定音效音量 playAudioClip 播放音效文件 stopAudioClip 停止播放指定音效 stopAllAudioClips 停止播放所有音效 pauseAudioClip 暂停播放指定音效 pauseAllAudioClips 暂停播放所有音效 resumeAudioClip 恢复播放指定音效 resumeAllAudioClips 恢复播放所有音效 getAudioClipCurrentPosition 获取指定音效当前播放位置 setAudioClipPosition 设置指定音效播放位置 getAudioClipDuration 获取音效文件时长

自定义视频采集和渲染 表10 自定义视频采集和渲染接口 接口 描述 setExternalVideoCapture 设置是否开启外部视频采集 pushExternalVideoFrame 输入外部视频数据 setExternalMediaFrameOutput 设置媒体数据自渲染 setExternalVideoFrameOutputWithFormat 带Format参数设置媒体数据自渲染 pushAuxExternalVideoFrame 辅流输入外部视频数据