已经使用 StartRecord 开始云端录制后,你可以使用 StopRecord 关闭云端录制。
你可以调用 StopRecord 接口,关闭指定的云端录制任务。
如果你已开通录制结束的消息通知功能,在云端录制结束时,你能够收到相关回调通知。关于消息通知服务,参看开通消息通知服务。
你已经使用 StartRecord 开始云端录制。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
QPS 不得超过 60。
使用 Post 方式发起请求。
以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | StopRecord | 接口名称,本接口取值:StopRecord |
| Version | String | 是 | 2022-06-01 | 接口版本,本接口取值:2022-06-01 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
| BusinessId | string | 否 | Your_BusinessId | 业务标识 |
| RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
| TaskId | String | 是 | Your_TaskId | 云端录制任务 ID。你必须对每个云端录制任务设定 TaskId,且在结束任务时也须使用该 TaskId。关于 TaskId 的详细说明,参看TaskId说明 。 关于 TaskId 及以上 Id 字段的命名规则,参看 ID。 |
TaskId 是任务的标识,在一个 AppId 的 RoomId 下 TaskId 是唯一的,不同 AppId 或者不同 RoomId 下 TaskId 可以重复,因此 AppId + RoomId + TaskId 是任务的唯一标识,可以用来标识指定 AppId 下某个房间内正在运行的任务,从而能在此任务运行中进行更新或者停止此任务。
https://rtc.volcengineapi.com?Action=StopRecord&Version=2022-06-01
{
"AppId" : "Your_AppId",
"RoomId" : "Your_RoomId",
"TaskId": "Your_TaskId"
}
返回值 Result 仅在请求成功时返回"ok",失败时为空。
{
"Result": "ok",
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "StopRecord",
"Version": "2022-06-01",
"Service": "rtc",
"Region": "cn-north-1"
}
}
json