You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

更新抽帧参数 UpdateSnapshot

最近更新时间：2024.02.29 19:30:25

首次发布时间：2023.01.11 18:58:00

我的收藏

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

使用说明

接口行为

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

前置条件

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

请求频率：QPS 不得超过 150。

请求说明

  • 请求方式：POST
  • 请求地址：https://rtc.volcengineapi.com?Action=UpdateSnapshot&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
是
UpdateSnapshot
接口名称。当前 API 的名称为 UpdateSnapshot。
Version
String
是
2020-12-01
接口版本。当前 API 的版本为 2020-12-01。

Body

参数
类型
是否必选
示例值
描述
AppId
String
是
Your_AppId
你的音视频应用的唯一标志
BusinessId
String
否
Your_BusinessId
业务标识
RoomId
String
是
Your_RoomId
房间的 ID，是房间的唯一标志
TaskId
String
是
Your_TaskId

截图任务 ID。你可以自行设定 TaskId 以区分不同的切片任务，且在后续进行任务更新和结束时也须使用该 TaskId。

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

关于 TaskId 及以上 Id 字段的命名规则符合正则表达式：[a-zA-Z0-9_@\-\.]{1,128}
ImageConfig
Object
否
目前仅支持设置 ImageConfig.Interval 参数，对截图间隔进行动态更新。该字段其他参数设置无效。
Format
Integer
否
0
图片的格式。值可取 0 或 1，默认为 0。选择 0 时，图片格式为 JEPG；选择 1 时，图片格式为 PNG。默认值为 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=2020-12-01

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

返回示例

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

错误码

您可访问公共错误码，获取更多错误码信息。