本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。
在实时音视频通话场景中，你可以通过调用此接口实现截图间隔的动态更新。
你可以调用 UpdateSnapshot 接口，覆盖此前在 StartSnapshot 或 UpdateSnapshot 中设定的ImageConfig.Interval参数，对截图间隔进行动态更新。
请求频率：QPS 不得超过 150。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | UpdateSnapshot | 接口名称。当前 API 的名称为 UpdateSnapshot。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
AppId | String | 是 | 661e****543cf | 你的音视频应用的唯一标志，参看获取 AppId。 |
BusinessId | String | 否 | B****23 | 业务标识 |
RoomId | String | 是 | Room1 | 房间的 ID，是房间的唯一标志 |
TaskId | String | 是 | Task1 | 截图任务 ID。你必须对每个截图任务，设定 TaskId，且在进行任务更新时也须使用该 TaskId。
[a-zA-Z0-9_@\-\.]{1,128} |
ImageConfig | Object | 否 | - | 目前仅支持设置 ImageConfig.Interval 参数，对截图间隔进行动态更新。该字段其他参数设置无效。 |
Format | Integer | 否 | 0 | 图片的格式。支持取值及含义如下：
0。 |
Width | Integer | 否 | 0 | 实际使用视频帧的宽度，取值范围为 [0, 1920]，单位为像素。默认值为 0，表示和视频流的实际宽度相同。 |
Height | Integer | 否 | 0 | 实际使用视频帧的高度，取值范围为 [0, 1920]，单位为像素，默认值为 0，此时，和视频流的实际高度相同。 |
Interval | Integer | 否 | 2 | 相邻截图之间的间隔时间，取值范围为 [1, 600]，单位为秒，默认值为 2。 |
本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。
POST https://rtc.volcengineapi.com?Action=UpdateSnapshot&Version=2023-11-01 { "AppId": "661e****543cf", "BusinessId": "B****23", "RoomId": "Room1", "TaskId": "Task1", "ImageConfig": { "Interval": 2 } }
{ "Result": "ok", "ResponseMetadata": { "RequestId": "20230****10420", "Action": "UpdateSnapshot", "Version": "2023-11-01", "Service": "rtc", "Region": "cn-north-1" } }
您可访问公共错误码，获取更多错误码信息。