检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
自动诊断 您可以实时查看应用下所有通话体验异常的用户信息及异常明细数据,快速识别通话异常的类型和影响因素。 注意事项 由于统计数据需要时间,可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。 支持查询的时间跨度最长为24小时。 操作步骤 登录实时音视频控制台。
文档基本使用技巧 技巧1:基本使用逻辑说明 用时序图展示各端接口使用顺序,单击相应接口可以快速查看相关接口使用方法。 技巧2:接口总览说明 包括SparkRTC接口总体功能流程图和接口列表,根据功能分类可以快速查找具体功能单个接口,方便接口对接。 技巧3:单个接口使用须知 接口使用时注意使用的
画布背景图地址,使用背景图功能需先上传图片到obs,填写此字段要求格式为s3://bucket/object,其中bucket和object指图片所在的桶和路径,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg。默认使用等比缩放裁剪,保证铺满。
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
础接口、房间功能、视频管理、屏幕共享、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。 单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。 初始化等基础接口 表1 初始化等基础接口 接口 描述 create 创建SparkRTC引擎实例
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/auto-record-mode
查询录制规则 功能介绍 调用此接口查询指定录制规则。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules/{rule_id}
HWRtcConnection按照其功能可分类为:初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理。 单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。 初始化等基础接口 表1 初始化等基础接口 接口 描述 destroyConnection 注销引擎 initWithRoomId
会前网络质量停止测试 自定义音频采集和渲染 表9 自定义音频采集和渲染接口 接口 描述 setExternalAudioCapture 设置是否开启外部音频采集 pushExternalAudioFrame 输入外部音频数据 自定义视频采集和渲染 表10 自定义视频采集和渲染接口 接口 描述
查询增值(录制)事件回调配置 功能介绍 调用此接口查询增值(录制)事件回调配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-callback
HRTCConnection按照其功能可分类为:初始化等基础接口、房间功能、音频管理、视频管理、屏幕共享。 单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。 表1 初始化等基础接口 接口 描述 release 释放Connection setEncryption 设置端到端加密模式
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/rtc/data/abnormal-events
//认证用的app_key和app_id硬编码至代码中或以明文形式存储会有极大风险。建议密文形式配置存储在文件或者环境变量中,使用时解密,以确保安全。本例以app_key和app_id存放至环境变量为例,运行前请先在本地环境中设置完成环境变量APP_KEY和APP_ID。 app_key
属性 类型 描述 streamType HRTCStreamType 视频流类型,根据HRTCStreamType和表14 不同分辨率下帧率和码率的推荐值设置需要的分辨率和宽高比 width int 视频宽度 height int 视频高度 frameRate int 视频帧率,可参考表14中的帧率进行设置
您也可以通过在“应用管理”页面的“操作”列,单击“用量”跳转到“用量统计”页面进行查看。 选择需要查看的时间和应用名称,即可查看到相关统计数据及明细。 统计图中展示了不同分辨率档位(标清/高清/超清)的视频通话时长和纯语音通话时长统计数据。在统计图中您可以进行如下操作: 单击如下图标可以选
功能、视频管理、辅流管理、屏幕共享、音频管理、音效文件播放管理、自采集自渲染、其他接口。 单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。 父主题: IHRTCEngine
分辨率、丢包率、音频采样率等信息怎么获取? SparkRTC是否支持设置本地采集音量?是否支持设置每个远端用户的播放音量? enableLocalVideo和muteLocalVideo有什么区别? enableLocalAudioStream和muteLocalAudio有什么区别?
查询OBS桶列表 功能介绍 查询OBS桶列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/rtc-ops/buckets 请求参数 表1 请求Header参数
请求示例 查询指定应用id和任务编号的单流任务状态 GET https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/individual-stream-jobs/{job_id} 响应示例 状态码: 200 查询成功,返回查询结果详情 {