数据万象
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 数据万象 > API 文档 > 媒体处理 > 视频转动图 > 创建模板

创建模板

最近更新时间：2024-04-09 15:54:33

我的收藏

本页目录：

功能描述

创建视频转动图模板。

授权说明

通过子账号使用时，需要授予 ci:CreateMediaTemplate 权限，详情请参见 数据万象 action。

服务开通

使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通媒体处理服务 。详情请参见 开通媒体处理服务。

使用限制

使用该接口时，请先确认相关限制条件。详情请参见 使用限制。


请求

请求示例

POST /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
说明
Authorization: Auth String，详情请参见 请求签名 文档。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求操作的实现需要有如下请求体。
<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
模板名称仅支持中文、英文、数字、_、-和*，长度不超过 64
String
是
Container
Request
容器格式
Container
是
Video
Request
视频信息
Container
否
TimeInterval
Request
时间区间
Container
否
Request 节点
Container
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Format
Request.Container
封装格式：gif，hgif，webp
String
无
是
说明：
hgif 为高质量 gif，即清晰度比较高的 gif 格式图。
Request 节点
Video
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Codec
Request.Video
编解码格式，取值 gif、webp
String
无
是
Width
Request.Video
宽
值范围：[128，4096]
单位：px
若只设置 Width 时，按照视频原始比例计算 Height
String
视频原始宽度
否
Height
Request.Video
高
值范围：[128，4096]
单位：px
若只设置 Height 时，按照视频原始比例计算 Width
String
视频原始高度
否
Fps
Request.Video
帧率
值范围：(0，60]
单位：fps
如果不设置，那么播放速度按照原来的时间戳。这里设置 fps 为动图的播放帧率
String
视频原始帧率
否
AnimateOnlyKeepKeyFrame
Request.Video
动图只保留关键帧
true ：AnimateTimeIntervalOfFrame 和 AnimateFramesPerSecond 无效
false：AnimateTimeIntervalOfFrame 和 AnimateFramesPerSecond 必填
String
false
否
AnimateTimeIntervalOfFrame
Request.Video
动图抽帧间隔时间
取值范围：（0，视频时长 ]
若设置 TimeInterval.Duration，则小于该值
String
无
否
AnimateFramesPerSecond
Request.Video
每秒抽帧帧数，取值范围：（0，视频帧率）
String
无
否
Quality
Request.Video
相对质量
取值范围： [1, 100)
webp 图像质量设定生效，gif 没有质量参数
String
无
否
Request 节点
TimeInterval
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Start
Request.TimeInterval
开始时间
[0 视频时长]
单位为秒
支持 float 格式，执行精度精确到毫秒
String
0
否
Duration
Request.TimeInterval
持续时间
[0 视频时长]
单位为秒
支持 float 格式，执行精度精确到毫秒
String
视频时长
否

响应

响应头

该响应包含公共响应头，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 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
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
Container 节点
TransTpl
的内容：
节点名称（关键字）
父节点
描述
类型
Container
Request
同请求体中的 Request.Container
Container
Video
Request
同请求体中的 Request.Video
Container
TimeInterval
Request
同请求体中的 Request.TimeInterval
Container

错误码

该请求无特有错误信息，常见的错误信息请参见 错误码 文档。

实际案例

请求

POST /template HTTP/1.1
Authorization: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=28e9a4986df11bed0255e97ff90500557e0ea057
Host:test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 1666
Content-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 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-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>

中国站