字段	类型	是否必填	示例	描述
Action	String	是	ListSnapshotTemplate	公共参数，拉取上传，取值：ListSnapshotTemplate
TemplateType	String	是	SampleSnapshot	模板类型。可选值： SampleSnapshot：采样截图 SnapshotByTimeOffset：指定时间截图 ImageSprite：雪碧图
SpaceName	String	否	other_space1	应用空间默认为：default_space
Offset	Integer	否	0	分页偏移量，默认值：0
Limit	Integer	否	20	分页返回条数，最大不超过50 默认值：20

返回参数

字段	类型	示例	描述
SampleSnapshotTemplates	Array of SampleSnapshotTemplate		对应的模板对象列表
SnapshotByTimeOffsetTemplates	Array of SnapshotByTimeOffsetTemplate		对应的模板对象列表
ImageSpriteTemplates	Array of ImageSpriteTemplate		对应的模板对象列表
Limit	Integer	10	返回的模板个数
Offset	Integer	0	分页起始坐标
Total	Integer		满足查询条件的模板总数

SampleSnapshotTemplate

字段	类型	是否必填（创建）	示例	描述
SnapshotTemplateId	String	否	xxx	模板ID
Name	String	否	snapshot_template	截图模板名称，长度限制：64 个字符。只可设置字母、数字、中划线、下划线。创建接口，需要传入更新接口，不需要传入
Description	String	否	test xxx	模板描述信息，长度限制：256 个字符。
SampleType	String	否	Time	采样截图类型，取值： Time：按时间间隔。默认值为Time
Interval	Integer	是	10	采样间隔。值必须大于0。当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。
Format	String	否	png	该模板计划使用的输出格式。支持输出的静图格式：jpeg、png 默认为jpeg
Width	Integer	宽和高必填其中一个	10	截图输出的宽，单位px。范围[0,4096]。如果为0则根据高进行缩放。宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。默认值为0。
Height	Integer	宽和高必填其中一个	10	截图输出的高，单位px。范围[0,4096]。如果为0则根据宽进行缩放。宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。默认值为0。
OffsetTime	Integer	否	10	截图指定时间的起始点，单位：s。若不指定则默认从0s开始。如果视频时长小于offsetTime则默认offsetTime从0s开始。默认值为0。

SnapshotByTimeOffsetTemplate

字段	类型	是否必填（创建）	示例	描述
SnapshotTemplateId	String	否	xxx	模板ID
Name	String	否	snapshot_template	截图模板名称，长度限制：64 个字符。只可设置字母、数字、中划线、下划线。创建接口，需要传入更新接口，不需要传入
Description	String	否	test xxx	模板描述信息，长度限制：256 个字符。
Format	String	否	png	该模板计划使用的输出格式。支持输出的静图格式：jpeg、png 默认值为jpeg
Width	Integer	否	10	截图输出的宽，单位px。范围[0,4096]。如果为0则根据高进行缩放。同时设置宽高会对生成图宽高进行自适应调整。默认值为0。
Height	Integer	否	10	截图输出的高，单位px。范围[0,4096]。如果为0则根据宽进行缩放。同时设置宽高会对生成图宽高进行自适应调整。默认值为0。
OffsetTime	Integer	否	10	截图指定时间的起始点，单位：s。若不指定则默认从0s开始。如果视频时长小于offsetTime则默认offsetTime从0s开始。OffsetTime必须大于等于0。默认值为0。

ImageSpriteTemplate

字段	类型	是否必填（创建）	示例	描述
SnapshotTemplateId	String	否	xxx	模板ID
Name	String	否	String	雪碧图模板名称，长度限制：64 个字符。只可设置字母、数字、中划线、下划线。
Description	String	否	String	模板描述信息，长度限制：256 个字符。
SampleType	String	否	String	采样类型，取值： Time：按时间间隔。默认为Time
SampleInterval	Integer	是	Integer	采样间隔。当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。值必须大于0。
RowCount	Integer	是	Integer	雪碧图中小图的行数。值必须大于0。行数*列数必须小于200。
ColumnCount	Integer	是	Integer	雪碧图中小图的列数。值必须大于0。行数*列数必须小于200。
Width	Integer	宽和高必填其中一个	Integer	雪碧图中小图的宽度，单位px。范围[0,480]。如果为0则根据高进行缩放。如果为0则根据高进行等比缩放宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。默认值为0。
Height	Integer	宽和高必填其中一个	Integer	雪碧图中小图的高度，单位px。范围[0,480]。如果为0则根据高进行缩放。如果为0则根据宽进行等比缩放宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。默认值为0。
Format	String	否	String	图片格式，取值： jpeg：jpeg 格式； png：png 格式； webp：webp 格式。默认值：jpeg

API示例

请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=ListSnapshotTemplate' \
-H 'Content-Type: application/json' \
-d 'Offset=0' \
-d 'TemplateType=SampleSnapshot \
-d 'Limit=10' \
-H <公共参数>

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
  "ResponseMeta": {
  	"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
    "ErrorCode":"",
    "ErrorMessage":""
  },
  "ResponseData": {
  	 "Limit": 10,
    "Offset": 0,
    "Total": 10,
  	"SampleSnapshotTemplates": [
    	{
      	"TemplateId": "xxx",
        "Name": "xxx",
        "Interval": 10,
        "Count": 10
        ...
      }, {
      	"TemplateId": "xxx",
        "Name": "xxx",
        "Interval": 5,
        "Count": 6
        ...
      }
    ]
  }
}

错误码

ErrorCode	ErrorMessage	说明	状态码
InvalidArgument	limit arguments are invalid,limit should between 0 and 50	参数错误（包括参数格式、类型、长度等错误）	400
InvalidArgument	offset arguments are invalid,offset should greater than or equal to 0	参数错误（包括参数格式、类型、长度等错误）	400

上一篇：获取转码模板列表下一篇：获取水印模板列表

该篇文档内容是否对您有帮助？

有帮助没帮助

关于我们

支持与服务

法律支持

联系我们

友情链接