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

获取截图结果

最近更新时间2024.01.08 17:26:44

首次发布时间2022.03.18 21:36:32

此接口用于获取某个视频的截图结果。

使用说明

此接口的返回结果中包含截图下载地址。此外,您也可以通过自行拼接的方式获取图片地址。图片地址的拼接说明如下:

  • 规则:http(s)://{domain}/{store_uri}~tplv-vod-noop.image
  • 说明:http(s)://点播封面加速域名/截图存储地址~模板配置.图片输出格式。其中模板配置详情请参见封面图处理模板
  • 示例:http://www.example.com/tos-cn-v-abcd/example~tplv-vod-noop.image

请求说明

请求地址:https://vod.volcengineapi.com?Action=ListSnapshots&Version=2021-01-01

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringListSnapshots接口名称。当前 API 的名称为 ListSnapshots
VersionString2021-01-01接口版本。当前 API 的版本为 2021-01-01

Vid

String

v0dc24g10***s1v0ipljnh4h0

音视频 ID。获取的方式如下所示。

  • 通过控制台上传的视频,可以登录视频点播控制台,进入空间,选择媒资管理 > 视频管理查看音视频 ID。
  • 音视频上传后,可通过 GetMediaList 接口查询音视频 Vid,为返回参数 Vid 的值。
  • 音视频上传后,如果开启了上传回调,会在 FileUploadComplete 中返回 Vid 的值。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
SpaceNameStringtest点播空间名称。
VidStringv0dc24g10001cm***pljnh4h0视频 ID。
PosterSnapshotsArray of PosterSnapshots-静态图。
DynpostSnapshotsArray of DynpostSnapshots-动态图。
AnimatedPosterSnapshotsArray of AnimatedPosterSnapshots-反复循环动图。
AiDynpostSnapshotsArray of AiDynpostSnapshots-AI 动图。
SpriteSnapshotsArray of SpriteSnapshots-雪碧图。
VSamplePosterSnapshotsArray of VSamplePosterSnapshots-采样截图。

PosterSnapshots

参数类型示例值描述
FormatStringjpeg文件格式。
HeightInteger360高度。
WidthInteger958宽度。
StoreUriStringtos-vod-cn-v-03e4***3112705/12d74b97e37944***e524a7398c6图片 URI。
UrlStringhttps://example.test.com/tos-vod-cn-v-03e4d54***112705/12d74b97e3794***83e524a7398c6~noop.image图片地址。

DynpostSnapshots

参数类型示例值描述
FormatStringwebp文件格式。
HeightInteger360高度。
WidthInteger958宽度。
StoreUriStringtos-vod-cn-v-03e4d54ef3***5/35d9efb1adf3***381e1d07e19图片 URI。
UrlStringhttps://example.test.com/tos-vod-cn-v-03e4d54***2705/35d9efb1adf345***81e1d07e19~noop.image图片地址。

AnimatedPosterSnapshots

参数类型示例值描述
FormatStringwebp文件格式。
HeightInteger360高度。
WidthInteger958宽度。
StoreUriStringtos-vod-cn-v-03e4d***12705/ee230f69d69b45***8ef5843d5d8图片 URI。
UrlStringhttps://example.test.com/tos-vod-cn-v-03e4d54***12705/ee230f69d69b4***48ef5843d5d8~noop.image图片地址。

AiDynpostSnapshots

参数类型示例值描述
FormatStringwebp文件格式。
HeightInteger240高度。
WidthInteger360宽度。
StoreUriStringtos-vod-cn-v-03e4d***12705/ee230f69d69b45***8ef5843d5d8图片 URI。
UrlStringhttps://example.test.com/tos-vod-cn-v-03e4d54***12705/ee230f69d69b4***48ef5843d5d8~noop.image图片地址。

SpriteSnapshots

参数类型示例值描述
FormatStringjpeg文件格式。
ImgXLenInteger5水平方向小图个数。
ImgYLenInteger5垂直方向小图个数。
CellWidthInteger240小图宽。
CellHeightInteger90小图高。
IntervalFloat2截图间隔。
CaptureNumInteger6截图总数限制。
StoreUrisArray of String["tos-vod-cn-v-03e4d54***12705/33b783a01d7a4***4a04f1f28b3436"]图片 URI 列表。
UrlsArray of String["https://example.test.com/tos-vod-cn-v-03e4d***2705/33b783a01d7a4***04f1f28b3436~noop.image"]图片地址列表。

VSamplePosterSnapshots

参数类型示例值描述
StoreUrisArray of String["tos-vod-cn-v-03e4d54***12705/737f0b92faf84***fecb9493290","tos-vod-cn-v-03e4d5***12705/403810e1f986***61314bbf5b330","tos-vod-cn-v-03e4d***12705/e7fc3fdde31***7a279f20e908"]多张采样截图地址。
ImgNumInteger6采样截图数量。
CellWidthInteger1436采样截图宽。
CellHeightInteger540采样截图高。
IntervalFloat2截图间隔。
FormatStringjpeg格式。目前默认为 jpg
DurationFloat11.4视频时长。
UrlsArray of String["https://example.test.com/tos-vod-cn-v-03e4d54***2705/737f0b92faf***7231fecb9493290~noop.image","https://example.test.com/tos-vod-cn-v-03e4d54***2705/403810e1f9***561314bbf5b330~noop.image","https://example.test.com/tos-vod-cn-v-03e4d54***2705/e7fc3fdd***eaa7a279f20e908~noop.image"]图片地址列表。
LargeSnapshotUriStringtos-vod-cn-v-03e4d54***2705/737f0b92faf***7231fecb9493290~noop.image大量截图结果文件 URI。
LargeSnapshotDownloadUrlStringhttps://example.test.com/tos-vod-cn-v-03e4d54***2705/737f0b92faf***7231fecb9493290~noop.image大量截图结果文件下载地址。
LargeSnapshotFillTypeStringnoop.image大量截图结果处理模板。
OffsetsArray of Float5采样截图自定义时间。

请求示例

https://vod.volcengineapi.com?Action=ListSnapshots&Version=2021-01-01&Vid=v0dc24g10***s1v0ipljnh4h0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202312211758***DEB895D4F863495B9",
        "Action": "ListSnapshots",
        "Version": "2021-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "SpaceName": "test",
        "Vid": "v0dc24g10001cm***pljnh4h0",
        "PosterSnapshots": [
            {
                "Format": "jpeg",
                "Height": 360,
                "Width": 958,
                "StoreUri": "tos-vod-cn-v-03e4***3112705/12d74b97e37944***e524a7398c6",
                "Url": "https://example.test.com/tos-vod-cn-v-03e4d54***112705/12d74b97e3794***83e524a7398c6~noop.image"
            }
        ],
        "DynpostSnapshots": [
            {
                "Format": "webp",
                "Height": 360,
                "Width": 958,
                "StoreUri": "tos-vod-cn-v-03e4d54ef3***5/35d9efb1adf3***381e1d07e19",
                "Url": "https://example.test.com/tos-vod-cn-v-03e4d54***2705/35d9efb1adf345***81e1d07e19~noop.image"
            }
        ],
        "AnimatedPosterSnapshots": [
            {
                "Format": "webp",
                "Height": 360,
                "Width": 958,
                "StoreUri": "tos-vod-cn-v-03e4d***12705/ee230f69d69b45***8ef5843d5d8",
                "Url": "https://example.test.com/tos-vod-cn-v-03e4d54***12705/ee230f69d69b4***48ef5843d5d8~noop.image"
            }
        ],
        "AiDynpostSnapshots": [],
        "SpriteSnapshots": [
            {
                "Format": "jpeg",
                "ImgXLen": 5,
                "ImgYLen": 5,
                "CellWidth": 240,
                "CellHeight": 90,
                "Interval": 2,
                "CaptureNum": 6,
                "StoreUris": [
                    "tos-vod-cn-v-03e4d54***12705/33b783a01d7a4***4a04f1f28b3436"
                ],
                "Urls": [
                    "https://example.test.com/tos-vod-cn-v-03e4d***2705/33b783a01d7a4***04f1f28b3436~noop.image"
                ]
            }
        ],
        "VSamplePosterSnapshots": [
            {
                "StoreUris": [
                    "tos-vod-cn-v-03e4d54***12705/737f0b92faf84***fecb9493290",
                    "tos-vod-cn-v-03e4d5***12705/403810e1f986***61314bbf5b330",
                    "tos-vod-cn-v-03e4d***12705/e7fc3fdde31***7a279f20e908"
                ],
                "ImgNum": 6,
                "CellWidth": 1436,
                "CellHeight": 540,
                "Interval": 2,
                "Format": "jpeg",
                "Duration": 11.4,
                "Urls": [
                    "https://example.test.com/tos-vod-cn-v-03e4d54***2705/737f0b92faf***7231fecb9493290~noop.image",
                    "https://example.test.com/tos-vod-cn-v-03e4d54***2705/403810e1f9***561314bbf5b330~noop.image",
                    "https://example.test.com/tos-vod-cn-v-03e4d54***2705/e7fc3fdd***eaa7a279f20e908~noop.image"
                ],
                "LargeSnapshotUri": "",
                "LargeSnapshotDownloadUrl": "",
                "LargeSnapshotFillType": "",
                "Offsets": []
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: