开启抽帧截图后，你可以使用 StopSnapshot 关闭抽帧截图。

接口行为

你可以调用 StopSnapshot接口，关闭已启动的抽帧截图任务。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

请求方式

使用 Post 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	string	是	`StopSnapshot`	接口名称，本接口取值：`StopSnapshot`
Version	string	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`

Body

参数名	类型	必填	示例值	描述
AppId	string	是	`Your_AppId`	应用的唯一标志
BusinessId	string	否	`Your_BusinessId`	业务标识
RoomId	string	是	`Your_RoomId`	房间 ID，是房间的唯一标志
TaskId	string	是	`Your_TaskId`	你需要关闭的抽帧截图任务的 ID

请求示例代码

Query

https://rtc.volcengineapi.com?Action=StopSnapshot&&Version=2020-12-01

Body

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId"
}

返回调用结果

返回值 Result 仅在请求成功时返回"ok",失败时为空。

正常返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopSnapshot",
        "Version": "`2020-12-01`",
        "Service": "rtc",
        "Region": "cn-north-1"
        }
}