检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询访问控制参数 功能介绍 典型场景 查询应用鉴权是否开启时使用此接口。 接口功能 查询鉴权配置参数 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 停止指定应用id和任务编号的合流录制任务 DELETE https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/
开关访问控制 功能介绍 典型场景 开启或关闭URL鉴权时调用此接口。 接口功能 URL鉴权 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 停止指定应用id和任务编号的单流任务 DELETE https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/in
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 查询指定应用id和任务编号的单流任务状态 GET https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/ind
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Exp
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 查询指定应用id和规则id的单个录制规则 GET https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-rules/{rule_id}
查询录制规则列表 功能介绍 调用此接口查询录制规则列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
object 保存录制文件所在的桶信息 record_formats 是 Array of strings 录制格式:支持HLS格式和MP4格式(HLS和MP4为大写)。 若配置HLS则必须携带HLSRecordConfig参数 若配置MP4则需要携带MP4RecordConfig hls_config
查询OBS桶列表 功能介绍 查询OBS桶列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/rtc-ops/buckets 请求参数 表1 请求Header参数
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
void release() 【功能说明】 释放IHRtcEngine对象资源。 如果资源已经释放,需要重新调用createHRtcEngine和initialize进行初始化。 logUpload virtual int logUpload() 【功能说明】 开启日志上传。 【返回参数】
OBS桶授权及取消授权 功能介绍 OBS桶授权及取消授权。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/rtc-ops/buckets/authentication
通过“audioSource”和“videoSource”设置音频和视频主流。这种模式下不支持大小流。 通过“audio/microphoneId”和“video/cameraId/facingMode”设置音频和视频主流。 如果未指定任何的音频源和视频源,则创建的流对象不包含音频流和视频流,无法播放。
查询OBS桶下对象列表 功能介绍 查询OBS桶下对象列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/rtc-ops/buckets/objects
object 保存录制文件所在的桶信息 record_formats 是 Array of strings 录制格式:支持HLS格式和MP4格式(HLS和MP4为大写)。 若配置HLS则必须携带HLSRecordConfig参数 若配置MP4则需要携带MP4RecordConfig hls_config
networkTestResult) 【功能说明】 加房间前网络探测结果回调。 【回调参数】 networkTestResult:主要包括测试成功与否、上行和下行的网络带宽、丢包、延时和抖动,具体请参见HRTCNetworkTestResult。 onUserVolumeStatsNotify virtual void
HRtcEngine按照其功能可分类为:初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。 单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。 初始化等基础接口 表1