已经使用 StartRecord 开始云端录制后,你可以使用 StopRecord 关闭云端录制。
你可以调用 StopRecord 接口,关闭指定的云端录制任务。
如果你已开通录制结束的消息通知功能,在云端录制结束时,你能够收到相关回调通知。关于消息通知服务,参看开通消息通知服务。
你已经使用 StartRecord 开始云端录制。
关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法。
请求频率:QPS 不得超过 60。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数名称 | 数据类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | StopRecord | 接口名称。当前 API 的名称为 StopRecord。 |
Version | String | 是 | 2022-06-01 | 接口版本。当前 API 的版本为 2022-06-01。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
BusinessId | String | 否 | Your_BusinessId | 业务标识 |
RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
TaskId | String | 是 | Your_TaskId | 云端录制任务 ID。你必须对每个云端录制任务设定 TaskId,且在结束任务时也须使用该 TaskId。
[a-zA-Z0-9_@\-\.]{1,128} |
本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。
POST https://rtc.volcengineapi.com?Action=StopRecord&Version=2022-06-01
{
"AppId": "Your_AppId",
"RoomId": "Your_RoomId",
"TaskId": "Your_TaskId"
}
json{
"Result": "ok",
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "StopRecord",
"Version": "2022-06-01",
"Service": "rtc",
"Region": "cn-north-1"
}
}
json您可访问公共错误码,获取更多错误码信息。