You need to enable JavaScript to run this app.
导航

更新抽帧参数 UpdateSnapshot

最近更新时间2024.01.12 17:07:37

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

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

使用说明

接口行为

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

前置条件

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

调用接口

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringUpdateSnapshot接口名称。当前 API 的名称为 UpdateSnapshot
VersionString2022-06-01接口版本。当前 API 的版本为 2022-06-01

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId你的音视频应用的唯一标志
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId房间的 ID,是房间的唯一标志

TaskId

String

Your_TaskId

截图任务 ID。你必须对每个截图任务,设定 TaskId,且在进行任务更新时也须使用该 TaskId。
TaskId 是任务的标识,在一个 AppIdRoomIdtaskId 是唯一的,不同 AppId 或者不同 RoomIdTaskId 可以重复,因此 AppId + RoomId + TaskId 是任务的唯一标识,可以用来标识指定 AppId 下某个房间内正在运行的任务,从而能在此任务运行中进行更新或者停止此任务。
关于 TaskId 及以上 Id 字段的命名规则符合正则表达式:[a-zA-Z0-9_@\-\.]{1,128}

ImageConfigObject of ImageConfig目前仅支持设置 ImageConfig.Interval 参数,对截图间隔进行动态更新。该字段其他参数设置无效。

ImageConfig

参数类型是否必选示例值描述
FormatInteger0图片的格式。值可取 0 或 1,默认为 0。选择 0 时,图片格式为 JEPG;选择 1 时,图片格式为 PNG。默认值为 0。值不合法时,自动调整为默认值。
WidthInteger0实际使用视频帧的宽度,单位为像素,取值范围为 [0, 1920]。默认值为 0,此时,和视频流的实际宽度相同。值不合法时,自动调整为默认值。
HeightInteger0实际使用视频帧的高度,单位为像素,取值范围为 [0, 1920],默认值为 0,此时,和视频流的实际高度相同。值不合法时,自动调整为默认值。
IntervalInteger2相邻截图之间的间隔时间,单位为秒,取值范围为 [1, 600],默认值为 2。值不合法时,自动调整为默认值。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=UpdateSnapshot&Version=2022-06-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": "2022-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

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