产品文档

媒体处理服务

listSnapshotTemplates

描述

查询截图模板列表。 允许通过条件过滤查询,支持的过滤字段如下:

  • templateId[eq] 按模板ID精确查询

请求方式

GET

请求地址

https://mps.jdcloud-api.com/v1/snapshotTemplates

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码;默认值为 1
pageSize Integer False 10 分页大小;默认值为 10;取值范围 [10, 100]
filters Filter[ ] False

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤器属性名
operator String False 过滤器操作符,默认值为 eq
values String[ ] True 过滤器属性值

返回参数

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

Result

名称 类型 描述
pageNumber Integer 当前页码
pageSize Integer 每页数量
totalElements Integer 查询总数
totalPages Integer 总页数
content SnapshotTemplateInfo[ ] 分页内容

SnapshotTemplateInfo

名称 类型 描述
templateId String 模板ID
title String 模板标题。长度不超过 128 个字节。UTF-8 编码。
startTime Integer 截图起始时间,单位:秒
frameType String 截图帧类型。
format String 截图格式。取值范围:jpg、png
number Integer 截图数量
interval Integer 截图间隔
width Integer 截图宽度
height Integer 截图高度
fillType String 填充方式
spriteConfig SpriteConfig 雪碧图配置
createTime String 创建时间
updateTime String 修改时间

SpriteConfig

名称 类型 描述
rows Integer 雪碧图小图行数。雪碧图行列积必须不大于100
columns Integer 雪碧图小图列数。雪碧图行列积必须不大于100
cellWidth Integer 雪碧图单元格宽度
取值范围:[8, 4096],不能为奇数
未设置时,回退为截图宽度 width
cellHeight Integer 雪碧图单元格高度,
取值范围:[8, 4096],不能为奇数
未设置时,系统自动会自动设置为截图高度 height
doKeepShots Boolean 是否保留截图
雪碧图的截图方式是先截取普通图,然后合成雪碧图。此字段控制是否保留截图。

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
500 Internal server error
503 Service unavailable

请求示例

GET

https://mps.jdcloud-api.com/v1/snapshotTemplates?pageNumber=1&pageSize=10&filters.1.name=templateId&filters.1.values.1=d2e394fff7ff42b585448866f999507e&filters.1.operator=eq

返回示例

{
    "requestId": "bgvmivir54gddpgi764se9f4kfr7ge41", 
    "result": {
        "content": [
            {
                "createTime": "2019-04-16T15:51:32Z", 
                "fillType": "stretch", 
                "format": "jpg", 
                "frameType": "any", 
                "height": 480, 
                "interval": 10, 
                "number": 10, 
                "spriteConfig": {
                    "cellHeight": 48, 
                    "cellWidth": 48, 
                    "columns": 10, 
                    "doKeepShots": true, 
                    "rows": 10
                }, 
                "startTime": 0, 
                "templateId": "c35a7f843a6e49a4a32b1f8fab99fbd8", 
                "title": "我的截图模板", 
                "updateTime": "2019-04-16T15:51:32Z", 
                "width": 720
            }
        ], 
        "pageNumber": 1, 
        "pageSize": 10, 
        "totalElements": 100, 
        "totalPages": 10
    }
}
更新时间:2020-05-09 10:43:02