功能描述
创建视频转动图模板。
请求
请求示例
POST /template HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
请求头
请求体
该请求操作的实现需要有如下请求体。
<Request><Tag>Animation</Tag><Name>TemplateName</Name><Container><Format>gif</Format></Container><Video><Codec>gif</Codec><Width>1280</Width><Height></Height><Fps>15</Fps><AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame></Video><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></Request>
具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 模板类型:Animation | String | 是 |
Name | Request | 模板名称仅支持中文、英文、数字、_、-和* | String | 是 |
Container | Request | 容器格式 | Container | 是 |
Video | Request | 视频信息 | Container | 否 |
TimeInterval | Request | 时间区间 | Container | 否 |
Request 节点 Container 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Format | Request.Container | 容器格式:gif,hgif,webp hgif 为高质量 gif,即清晰度比较高的 gif 格式图 | String | 是 |
Request 节点 Video 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Codec | Request.Video | 编解码格式 | String | 是 | 无 | gif, webp |
Width | Request.Video | 宽 | String | 否 | 视频原始宽度 | 值范围:[128,4096] 单位:px 若只设置 Width 时,按照视频原始比例计算 Height |
Height | Request.Video | 高 | String | 否 | 视频原始高度 | 值范围:[128,4096] 单位:px 若只设置 Height 时,按照视频原始比例计算 Width |
Fps | Request.Video | 帧率 | String | 否 | 视频原始帧率 | 值范围:(0,60] 单位:fps 如果不设置,那么播放速度按照原来的时间戳。这里设置 fps 为动图的播放帧率 |
AnimateOnlyKeepKeyFrame | Request.Video | 动图只保留关键帧 。若 AnimateOnlyKeepKeyFrame 设置为 true 时,则不考虑 AnimateTimeIntervalOfFrame、AnimateFramesPerSecond;若 AnimateOnlyKeepKeyFrame 设置为 false 时,则必须填写AnimateTimeIntervalOfFrame 或 AnimateFramesPerSecond | String | 否 | false | true、false 动图保留关键帧参数 优先级:AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame |
AnimateTimeIntervalOfFrame | Request.Video | 动图抽帧间隔时间 | String | 否 | 无 | (0,视频时长] 动图抽帧时间间隔 若设置 TimeInterval.Duration,则小于该值 |
AnimateFramesPerSecond | Request.Video | Animation 每秒抽帧帧数 | String | 否 | 无 | (0,视频帧率) 动图抽帧频率 优先级:AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame |
Quality | Request.Video | 设置相对质量 | String | 否 | 无 | [1, 100) webp 图像质量设定生效,gif 没有质量参数 |
Request 节点 TimeInterval 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Start | Request.TimeInterval | 开始时间 | String | 否 | 0 | [0 视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒 |
Duration | Request.TimeInterval | 持续时间 | String | 否 | 视频时长 | [0 视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><Template><Name>TemplateName</Name><TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId><Tag>Animation</Tag><BucketId>test-1234567890</BucketId><Category>Custom</Category><TransTpl><Container><Format>gif</Format></Container><Video><Codec>gif</Codec><Width>1280</Width><Height></Height><Fps>15</Fps><AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame></Video><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></TransTpl><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></Template></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Response 的具体描述:
节点名称(关键字) | 父节点 | 描述 | 类型 |
TemplateId | Response | 模板 ID | String |
Name | Response | 模板名字 | String |
BucketId | Response | 模板所属存储桶 | String |
Category | Response | 模板属性,Custom 或者 Official | String |
Tag | Response | 模板 Tag | String |
UpdateTime | Response | 更新时间 | String |
CreateTime | Response | 创建时间 | String |
TransTpl | Response | 详细的模板参数 | Container |
TransTpl 节点 Container 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Format | Response.TransTpl.Container | 容器格式: gif,hgif,webp hgif 为高质量 gif,即清晰度比较高的 gif 格式图 | String |
TransTpl 节点 Video 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Codec | Response.TransTpl.Video | 编解码格式 | String |
Width | Response.TransTpl.Video | 宽 | String |
Height | Response.TransTpl.Video | 高 | String |
Fps | Response.TransTpl.Video | 帧率 | String |
AnimateOnly KeepKeyFrame | Response.TransTpl.Video | 动图只保留关键帧 | String |
AnimateTime IntervalOfFrame | Response.TransTpl.Video | 动图抽帧间隔时间 | String |
AnimateFrames PerSecond | Response.TransTpl.Video | Animation 每秒抽帧帧数 | String |
Quality | Response.TransTpl.Video | 设置相对质量 | String |
TransTpl 节点 TimeInterval 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Start | Response.TransTpl.TimeInterval | 开始时间 | String |
Duration | Response.TransTpl.TimeInterval | 持续时间 | String |
错误码
实际案例
请求
POST /template HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host:bucket-1250000000.ci.ap-beijing.myqcloud.comContent-Length: 1666Content-Type: application/xml<Request><Tag>Animation</Tag><Name>TemplateName</Name><Container><Format>gif</Format></Container><Video><Codec>gif</Codec><Width>1280</Width><Height></Height><Fps>15</Fps><AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame></Video><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></Request>
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYz****=<Response><Template><Name>TemplateName</Name><TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId><Tag>Animation</Tag><BucketId>test-1234567890</BucketId><Category>Custom</Category><TransTpl><Container><Format>gif</Format></Container><Video><Codec>gif</Codec><Width>1280</Width><Height></Height><Fps>15</Fps><AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame></Video><TimeInterval><Start>0</Start><Duration>60</Duration></TimeInterval></TransTpl><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></Template></Response>