如果你已经启用抽帧截图，你可以使用 UpdateSnapshot 更新已设置的截图任务参数。

接口行为

你可以调用 UpdateSnapshot 接口，覆盖此前在 StartSnapshot 或 UpdateSnapshot 中设定的ImageConfig.Interval参数，对截图间隔进行动态更新。

前置条件

在使用 UpdateSnapshot 前，你必须已经使用 StartSnapshot 开启截图任务。

调用接口

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

接口限制

QPS 不得超过 150。

请求方式

使用 Post 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	必填	示例值	描述
Action	String	是	`UpdateSnapshot`	接口名称，本接口取值：`UpdateSnapshot`
Version	String	是	`2022-06-01`	接口版本，本接口取值：`2022-06-01`

Body

参数名	类型	必填	示例值	描述
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。
ImageConfig	ImageConfig	否	/	目前仅支持设置 `ImageConfig.Interval` 参数，对截图间隔进行动态更新。该字段其他参数设置无效。

TaskId 说明：
TaskId 是任务的标识，在一个 AppId 的 RoomId 下 taskID 是唯一的，不同 AppId 或者不同 RoomId 下 TaskId 可以重复，因此 AppId + RoomId + TaskId 是任务的唯一标识，可以用来标识指定 AppId 下某个房间内正在运行的任务，从而能在此任务运行中进行更新或者停止此任务。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=UpdateSnapshot&Version=2022-06-01

Body

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "ImageConfig": {
        "Interval": 2
    }
}
json

返回调用结果

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

正常返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "UpdateSnapshot",
        "Version": "2022-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}
json