检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。具体获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面,即可获取对应的账号ID信息。
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。
音视频输入设备通过设备ID(deviceId)标识,每个音视频设备均有一个唯一的设备ID,您可以通过getDevices方法获取。设备ID是随机生成的,部分情况下同一个设备的ID可能会改变,因此建议您每次切换设备时都先调用getDevices获取设备ID。
【回调参数】 roomid:房间ID。 userid:用户ID。
支持用户鉴权,华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在相应SDK的初始化或登录函数中提供“app_id”、“room_id”、“user_id”、“role”、“ctime”和“signature”等信息,才能接入华为SparkRTC服务。
URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id job_id 是 String 任务编号 请求参数 表2 请求Header参数 参数 是否必选
图1 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在相应的SDK的初始化或登录函数中提供“app_id”、“room_id”、“user_id”、“ctime”和“signature”等信息,才能接入华为SparkRTC服务。
URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id job_id 是 String 任务编号 请求参数 表2 请求Header参数 参数 是否必选
getRoomId virtual const char* getRoomId() 【功能说明】 获取当前连接对应的房间ID。 【请求参数】 无 【返回参数】 roomId:返回当前连接对应的房间ID。
URI DELETE /v2/apps/{app_id}/individual-stream-jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id job_id 是 String 任务ID 请求参数 表2 请求Header
X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。 响应参数 状态码: 204 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。
URI DELETE /v2/apps/{app_id}/record-rules/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id rule_id 是 String 规则id 请求参数 表2 请求Header参数 参数
URI POST /v2/apps/{app_id}/rooms/{room_id}/dismiss 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id 是 String 房间id 请求参数 表2 请求Header参数 参数 是否必选
URI POST /v2/apps/{app_id}/rooms/{room_id}/batch-remove-users 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id 是 String 房间id 请求参数 表2 请求Header
X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。
X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。
URI DELETE /v2/apps/{app_id}/mix-stream-jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id job_id 是 String 任务编号 请求参数 表2 请求Header参数 参数
表6 响应Body参数 参数 参数类型 描述 job_id String 任务编号 stream_name String 流名 app_id String 应用id room_id String 房间id user_id String 选看的用户id,单个录制任务内保证唯一 is_record_audio
AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):私有访问密钥。与访问密钥ID结合使用,对请求进行加密签名,可标识发送方,并防止请求被修改。
userid:用户ID。