产品文档



视频点播



帮助中心 > 视频点播 > 查询截图模板

搜本产品



getSnapshotTemplate

描述

查询截图模板

请求方式

GET

请求地址

https://vod.jdcloud-api.com/v1/snapshotTemplates/{templateId}

请求参数

名称	类型	是否必需	默认值	描述
templateId	String	True		模板ID

返回参数

名称	类型	描述
result	Result	查询截图模板信息结果
requestId	String	请求ID

Result

名称	类型	描述
templateId	String	模板ID

返回参数

名称	类型	描述
result	Result	查询截图模板信息结果
requestId	String	请求ID

Result

名称	类型	描述
templateId	String	模板ID
templateName	String	模板标题。长度不超过 128 个字节。UTF-8 编码。
snapshotType	String	模板类型。取值范围： sample - 采样截图模板 sprite - 雪碧图模板
imageSampleConfig	ImageSampleConfig	采样截图模板配置
imageSpriteConfig	ImageSpriteConfig	雪碧图模板配置
createTime	String	创建时间
updateTime	String	修改时间

ImageSpriteConfig

名称	类型	描述
startTime	Integer	截图起始时间，单位：秒
intervalTime	Integer	截图间隔
frameType	String	截图帧类型。
format	String	截图格式。取值范围：jpg、png
rows	Integer	雪碧图小图行数。雪碧图行列积必须不大于100, 缺省值为 10
columns	Integer	雪碧图小图列数。雪碧图行列积必须不大于100, 缺省值为 10
cellWidth	Integer	雪碧图单元格宽度取值范围：[8, 4096]，不能为奇数未设置时，回退为截图宽度 width
cellHeight	Integer	雪碧图单元格高度，取值范围：[8, 4096]，不能为奇数未设置时，系统自动会自动设置为截图高度 height
doKeepShots	Boolean	是否保留截图雪碧图的截图方式是先截取普通图，然后合成雪碧图。此字段控制是否保留截图。

ImageSampleConfig

名称	类型	描述
startTime	Integer	截图起始时间，取值范围单位为秒，缺省值为 0
intervalTime	Integer	截图时间间隔。单位为毫秒若未设置，则对于普通截图，按照截图张数做平均截图；对于雪碧图，则按照行列数乘积做平均截图
frameType	String	截图帧类型。取值范围： any - 任意帧 intra - 关键帧缺省值为 any
format	String	截图格式。取值范围：jpg、png
number	Integer	截图数量，缺省值为 10
width	Integer	截图宽度，取值范围：[8, 4096] 若宽度和高度同时设置，则按照设置的宽高截图；若宽度和高度均未设置，则截图保持与源视频相同的宽高值；若宽度和高度其中一项未设置，则截图保持与源视频相同的宽高比；
height	Integer	截图高度，取值范围：[8, 4096] 若宽度和高度同时设置，则按照设置的宽高截图；若宽度和高度均未设置，则截图保持与源视频相同的宽高值；若宽度和高度其中一项未设置，则截图保持与源视频相同的宽高比；
fillType	String	填充方式，当视频宽高与截图宽高指定值不能匹配时的填充处理方式。取值范围： stretch - 伸缩 black - 留黑 white - 留白 gauss - 高斯模糊缺省值为 black

返回码

HTTP状态码	错误码	描述
200		OK

请求示例

GET

https://vod.jdcloud-api.com/v1/snapshotTemplates/qc5p8Jv0jRRnTZc6Vgx

返回示例

{
    "requestId": "5120Oo568f967b0X83I004P2iL0Y477Q", 
    "requestId": "5120Oo568f967b0X83I004P2iL0Y477Q", 
        "createTime": "2022-02-25T08:31:11Z", 
        "imageSpriteConfig": {
            "cellHeight": 0, 
            "cellWidth": 0, 
            "columns": 3, 
            "doKeepShots": false, 
            "format": "jpg", 
            "frameType": "any", 
            "intervalTime": 1, 
            "rows": 2, 
            "startTime": 1
 }, 
         "snapshotType": "sprite", 
        "templateId": "qc5p8Jv0jRRnTZc6Vgx", 
        "templateName": "spriteT1", 
        "updateTime": "2022-02-25T08:31:11Z"
    }
}