实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考抽帧截图更新抽帧截图参数 UpdateSnapshot
复制全文
下载 pdf更新抽帧截图参数 UpdateSnapshot
文档反馈
问问助手调用 UpdateSnapshot 接口，在抽帧截图任务进行中，动态更新截图的时间间隔。
注意事项
请求频率：QPS 不得超过 150。
请求说明
- 请求方式：POST
- 请求地址：https://rtc.volcengineapi.com?Action=UpdateSnapshot&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：UpdateSnapshot
接口名称。当前 API 的名称为 UpdateSnapshot。
Version String 必选 示例值：2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
AppId String 必选 示例值：66****3cf
BusinessId String 可选 示例值：B****3
RoomId String 必选 示例值：Room1
房间 ID。
TaskId String 必选 示例值：Task1
需要更新的抽帧截图任务 ID。
ImageConfig Object 可选 示例值：-
目前仅支持设置 ImageConfig.Interval 参数，对截图间隔进行动态更新。该字段其他参数设置无效。
Format Integer 可选 示例值：0
图片的格式：
- 0（默认值）：JPEG
- 1：PNG
Width Integer 可选 示例值：0
截图的宽度，单位为像素。取值范围：[0,1920]，默认值为 0，表示和视频流的实际宽度相同。
Height Integer 可选 示例值：0
截图的高度，单位为像素。取值范围：[0,1080]，默认值为 0，表示和视频流的实际高度相同。
Interval Float 可选 示例值：2.0
相邻两次截图之间的间隔时间，单位为秒，支持传入浮点数，精度为毫秒（0.001s）。
- 取值范围：[0.1, 600]。
- 默认值：2.0。
- 传入值如果超过 3 位小数，会被截断。
返回参数
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。
请求示例
POST https://rtc.volcengineapi.com?Action=UpdateSnapshot&Version=2023-11-01
{
"AppId": "66****3cf",
"RoomId": "Room1",
"TaskId": "Task1"
}
返回示例
{
"Result": "ok",
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "UpdateSnapshot",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
}
}
错误码
最近更新时间：2026.07.27 21:55:58
这个页面对您有帮助吗？
有用
有用
无用
无用