你可以使用此接口查询指定抽帧截图任务的相关信息。
使用说明
接口行为
你可以调用GetSnapshotTask接口，指定你所属的 AppId，查询指定 RoomId 下的抽帧截图任务。
自动抽帧截图任务也支持查询。
通过此接口仅能查询距今 72 小时内开始的抽帧截图任务。
注意事项
请求频率：QPS 不得超过 60。
请求说明
- 请求方式：GET
- 请求地址：https://rtc.volcengineapi.com?Action=GetSnapshotTask&Version=2022-06-01
调试
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | GetSnapshotTask | 接口名称。当前 API 的名称为 GetSnapshotTask。 |
Version | String | 是 | 2022-06-01 | 接口版本。当前 API 的版本为 2022-06-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 | 任务状态。
|
StopReason | String | IdleTimeOut | 任务停止的原因
|
TargetStreams | Object | - | 需要截图的视频流。 |
StreamList | Object[] | 由 Stream组成的列表，可以为空。为空时，表示订阅房间内所有流。在一个 StreamList 中，Stream.Index 不能重复。 | |
Index | Integer | 0 | 在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。 |
UserId | String | Your_UserId | 用户Id，表示这个流所属的用户。 |
StreamType | Integer | 0 | 流的类型，值可以取 0或1，默认值为0。0表示普通音视频流，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，例如：
|
Region | Integer | 0 | 不同存储平台支持的 Region 不同，具体参看 Region对照表 默认值为0。 |
Bucket | String | Your_Bucket | 存储桶的名称。 |
VodConfig | Object | - | 当 Type = 1 时，需正确设置 VodConfig 的值，否则请求会报错 |
AccountId | String | Your_AccountId | 火山引擎平台账号 ID，例如：
|
Region | Integer | 不同存储平台支持的 Region 不同，具体参看 Region对照表 默认值为0。 | |
Space | String | Your_Space | 点播空间名称。 |
CustomConfig | Object | - | 当 Type = 2时，需正确设置 CustomConfig 的值，否则请求会报错 |
Vendor | Integer | 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，例如：
|
Region | Integer | 不同存储平台支持的 Region 不同，具体参看 Region对照表 默认值为0。 | |
ServiceId | String | Your_ServiceId |
请求示例
GET https://rtc.volcengineapi.com?Action=GetSnapshotTask&Version=2022-06-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": "2022-06-01", "Service": "rtc", "Region": "cn-north-1" } }
错误码
您可访问公共错误码，获取更多错误码信息。