检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
返回结果 状态码 请求发送以后，您会收到响应，其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps
修订记录 表1 修订记录 修改时间 修改说明 2023-08-28 第二十次正式发布 本次变更如下： 新增OBS桶管理接口组。 新增查询详情事件接口和查询指定项目用户异常体验事件接口。 2023-07-06 第十九次正式发布 本次变更如下： 删除启动单流任务、更新单流任务和启动合
如何对录制回调进行鉴权？ 为保证录制回调通信安全，租户可以配置录制回调参数“回调秘钥”，对录制回调消息进行鉴权。本章节介绍录制回调鉴权签名的生成方法。 参数说明 表1 参数说明 参数 说明 X-Rtc-Rand 消息请求头中的随机数。 X-Rtc-Timestamp 消息请求头中的时间戳。
状态码 调用实时音视频API时，可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。
停止单流任务 功能介绍 调用此接口停止单流任务 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/individual
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第十七次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay：停止所有跨房
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{ro
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
自定义视频采集和渲染 setExternalVideoCapture - (int)setExternalVideoCapture:(BOOL)enabled format:(HWRtcVideoImageFormat)format; 【功能说明】 设置是否开启外部视频采集。需要在加入房间前调用。
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后，新房间无法新增和加入，已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
删除录制规则 功能介绍 调用此接口删除录制规则，对于正在使用的录制规则，不允许删除。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/
解散房间 功能介绍 调用此接口解散房间，将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/r
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在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-callback
更新自动录制配置 功能介绍 更新自动录制配置，租户可以开启自动单流录制或者停用自动单流录制（仅支持单流录制）。 接口约束 开启自动单流录制功能之后，只针对新创建的房间有效，对开启自动录制功能之前已经创建的房间不生效。 单流自动录制任务的流名规则： {appid}_{roomid}
流对象（Stream） 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况，暂不支持查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/ap
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
