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

查询抽帧截图任务状态 GetSnapshotTask

最近更新时间2024.04.11 11:50:51

首次发布时间2024.01.03 20:25:18

本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本

你可以使用此接口查询指定抽帧截图任务的相关信息。

使用说明

接口行为

你可以调用GetSnapshotTask接口,指定你所属的 AppId,查询指定 RoomId 下的抽帧截图任务。

自动抽帧截图任务也支持查询。

通过此接口仅能查询距今 72 小时内开始的抽帧截图任务。

调用接口

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

注意事项

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

请求说明

  • 请求方式:GET
  • 请求地址:https://rtc.volcengineapi.com?Action=GetSnapshotTask&Version=2023-11-01

调试

请求参数

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

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
GetSnapshotTask
接口名称。当前 API 的名称为 GetSnapshotTask
Version
String
2023-11-01
接口版本。当前 API 的版本为 2023-11-01
AppId
String
Your_AppId
你的音视频应用的唯一标志
RoomId
String
Your_RoomId
房间的 ID,是房间的唯一标志
TaskId
String
Your_TaskId
要查询的抽帧截图任务 ID。自动抽帧任务下,该字段可传入用户 UserId。

返回参数

下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构

参数
类型
示例值
描述
SnapshotTask
Object
-
抽帧截图任务信息
StartTime
Long
1677227309000
任务开始时间戳,Unix 时间,单位为毫秒
EndTime
Long
1677227511000
任务结束时间戳,Unix 时间,单位为毫秒。0 表示任务未结束
Status
Long
3

任务状态。

  • 0: 未知异常状态
  • 1: 未开始
  • 2: 运行中
  • 3: 已结束
  • 4: 任务运行失败
StopReason
String
IdleTimeOut

任务停止的原因

  • 返回为空:表示任务未结束
  • UnknownStopReason:未知停止原因
  • StopByAPI:用户主动调用 服务端 OpenAPI 停止
  • StartTaskFailed:任务启动失败
  • IdleTimeOut:任务超过最大空闲时间
  • UserDisconnect:自动截图任务中,截图任务对应的客户端用户主动退房。
TargetStreams
Object
-
需要截图的视频流。
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
200
任务最大的空闲超时时间。
ImageConfig
Object
图片的相关配置:图片格式,尺寸和截图间隔时间。
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
StorageConfig
Object
-
存储平台设置。其中 AK、SK 字段不返回。
Type
Integer
0

存储平台类型

TosConfig
Object
-
当 Type = 0 时,需正确设置 TosConfig 的值,否则请求会报错
AccountId
String
Your_AccountId

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

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

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

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

Region
Integer
0

不同存储平台支持的 Region 不同,具体参看 Region对照表

默认值为0
Bucket
String
Your_Bucket
存储桶的名称。
VodConfig
Object
-
当 Type = 1 时,需正确设置 VodConfig 的值,否则请求会报错
AccountId
String
Your_AccountId

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

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

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

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

Region
Integer
0

不同存储平台支持的 Region 不同,具体参看 Region对照表

默认值为0
Space
String
Your_Space
点播空间名称。
StorageClass
Integer
1

上传到视频点播平台时, 文件的存储类型。枚举值为:

  • 1:标准存储。
  • 2:归档存储。
  • 3:低频存储。
默认值为 1
关于存储类型的详细说明,参看媒资存储存储类型
AutoSetFileExtension
Boolean
false

上传到视频点播平台时, 是否需要根据文件后缀自动设置 FileExtension。关于 FileExtension 的详细说明,参看 FileExtension

  • true:需要;
  • false:不需要。
默认值为 false
CustomConfig
Object
-
当 Type = 2时,需正确设置 CustomConfig 的值,否则请求会报错
Vendor
Integer
0

第三方云存储平台。

  • 0: Amazon S3
  • 1: 阿里云 OSS
  • 2:华为云 OBS
  • 3:腾讯云 COS
  • 4:七牛云 Kodo。
    默认值为 0
Region
Integer
0

不同存储平台支持的 Region 不同,具体参看 Region对照表

默认值为0
Bucket
String
Your_Bucket
存储桶的名称。
AccessKey
String
Your_AccessKey
第三方存储平台账号的密钥。需确保此账号对存储桶有写权限。不建议开启读权限
SecretKey
String
Your_SecretKey
第三方存储平台账号的密钥
VeImageXConfig
Object
-
当 Type = 3时,需正确设置 VeImageXConfig 的值,否则请求会报错
AccountId
String
Your_AccountId

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

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

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

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

Region
Integer
/

不同存储平台支持的 Region 不同,具体参看 Region对照表

默认值为0
ServiceId
String
Your_ServiceId

服务 ID。

  • 你可以在 veImageX 控制台 服务管理页面,通过创建好的图片服务中获取服务 ID。
    你也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息

请求示例

GET https://rtc.volcengineapi.com?Action=GetSnapshotTask&Version=2023-11-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId

返回示例

{ 
  "Result": {
    "SnapshotTask": {
      "StartTime": 1677227309000,
      "EndTime": 1677227511000,
      "Status": 3,
      "StopReason": "IdleTimeOut",
      "TargetStreams": {
        "StreamList": [
          {
            "Index": 0,
            "UserId": "user0",
            "StreamType": 1
          },
          {
            "Index": 1,
            "UserId": "user1",
            "StreamType": 1
          }
        ]
      },
      "MaxIdleTime": 200,
      "ImageConfig": {
        "Format": 0,
        "Width": 800,
        "Height": 800,
        "Interval": 2
      },
      "StorageConfig": {
        "Type": 0,
        "TosConfig": {
          "Region": 0
        },
        "VodConfig": {
          "Region": 0
        },
        "VeImageXConfig": {
          "Region": 0
        },
        "CustomConfig": {
          "Vendor": 0,
          "Region": 0
        }
      }
    }
  },
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "GetSnapshotTask",
    "Version": "2023-11-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  }
}

错误码

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