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

开启抽帧截图 StartSnapshot

最近更新时间2024.02.29 19:30:22

首次发布时间2022.02.23 17:40:04

在你的音视频应用中,你可能会需要对房间内的实时音视频互动按一定时间间隔进行截图,供后续处理。比如,实现存证,鉴别非法信息。

你可以使用 StartSnapshot 这个 OpenAPI 实现这一功能。

你也可以在控制台上开启自动抽帧功能,开启该功能后,若未设置业务标识,默认对房间内每个用户都进行全程抽帧。截图结果会上传到对象存储(TOS)平台

使用说明

接口行为

你可以调用 StartSnapshot 接口,指定你所属的 AppId,对指定 roomId 房间中指定的一路或多路视频流进行截图。

截图结果会上传到对象存储(TOS)平台。你在控制台上设置的回调地址会收到每一张图片的元数据回调。有关回调结果的详细说明,参看SnapshotRealTimeData

前置条件

在使用抽帧截图功能前,你必须已经在控制台上开启抽帧截图服务。

调用接口

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

注意事项

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

请求说明

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

请求参数

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

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
StartSnapshot
接口名称。当前 API 的名称为 StartSnapshot
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 是任务的标识,在一个 AppIdRoomIdtaskId 是唯一的,不同 AppId 或者不同 RoomIdTaskId 可以重复,因此 AppId + RoomId + TaskId 是任务的唯一标识,可以用来标识指定 AppId 下某个房间内正在运行的任务,从而能在此任务运行中进行更新或者停止此任务。

关于 TaskId 及以上 Id 字段的命名规则符合正则表达式:[a-zA-Z0-9_@\-\.]{1,128}
TargetStreams
Object
-
你可以通过本参数设定需要截图的视频流。如果参数为空,默认对房间内所有人进行截图。最多17路视频流。
StreamList
Object[]
-
由Stream组成的列表,可以为空。为空时,表示订阅房间内所有流。在一个 StreamList 中,Stream.Index 不能重复。
Index
Integer
0
在自定义布局中,使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中,你需要使用 Index 指定对应流的布局设置。
UserId
String
Your_UserId
用户Id,表示这个流所属的用户。
StreamType
Integer
0
流的类型,值可以取01,默认值为00表示普通音视频流,1表示屏幕流。
MaxIdleTime
Integer
任务最大的空闲超时时间。如果抽帧截图任务订阅的所有流都已停止发布,那么任务会在空闲时间超过设定值后自动停止。值的范围为[1, 86400] ,单位为秒。默认值为 180秒。值不合法时,自动调整为默认值。
ImageConfig
Object
图片的相关配置:图片格式,尺寸和截图间隔时间。
如果在开启抽帧截图时指定了多路流,会对每一路流进行截图。如果对应流的发布者关闭了摄像头,则不会产生截图。
Format
String
0
图片的格式。值可取 0 或 1,默认为 0。选择 0 时,图片格式为 .jpeg;选择 1 时,图片格式为 .png。默认值为 0。值不合法时,自动调整为默认值。
Width
String
0
实际使用视频帧的宽度,单位为 px,取值范围为 [0, 1920]。默认值为 0,此时,和视频流的实际宽度相同。值不合法时,自动调整为默认值。
Height
String
0
实际使用视频帧的高度,单位为 px,取值范围为 [0, 1080],默认值为 0,此时,和视频流的实际高度相同。值不合法时,自动调整为默认值。
Interval
String
2
相邻截图之间的间隔时间,单位为 秒,取值范围为 [1, 600],默认值为 2。值不合法时,自动调整为默认值。
TosConfig
Object
TOS 的相关配置。
你必须在 TOS 处进行了相关配置后,才能使用抽帧截图功能。
UserAccountId
String
Your_UserAccountId

火山引擎平台账号 ID,例如:200000000

  • 火山引擎平台账号 ID 查看路径:控制台->账号管理->账号信息
    alt

  • 此账号 ID 为火山引擎主账号 ID。

  • 若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK,账号 ID 也必须为火山引擎主账号 ID,不能使用子用户账号 ID。

Region
String
Your_Region
Bucket 所在地域对应的 Region ID。参看 地域和访问域名
EndPoint
String
Your_EndPoint

Bucket 对应的访问域名。参看 地域和访问域名

该 API 下 EndPoint 只支持 S3 Endpoint 外网域名。
Bucket
String
Your_Bucket
存储桶名称。

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=StartSnapshot&Version=2020-12-01

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TargetStreams": {
        "StreamList": [
            {
                "UserId": "user1",
                "StreamType": 0
            },
            {
                "UserId": "user2",
                "StreamType": 1
            }
        ]
    },
    "MaxIdleTime": 180,
    "ImageConfig": {
        "Format": 0,
        "Width": 800,
        "Height": 800,
        "Interval": 2
    },
    "TosConfig": {
        "UserAccountId": "Your_AccountId",
        "Region": "Your_BucketRegion",
        "EndPoint": "Your_BucketEndPoint",
        "Bucket": "Your_Bucket"
    }
}

返回示例

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

错误码

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