tencent cloud

文档反馈

创建动图模板

最后更新时间:2024-01-23 10:00:02

    功能描述

    创建视频转动图模板。
    

    请求

    请求示例

    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
    模板名称仅支持中文、英文、数字、_-*
    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 为动图的播放帧率
    AnimateOnly KeepKeyFrame
    Request.Video
    动图只保留 关键帧 。若 AnimateOnlyKeepKeyFrame 设置为 true 时,则不考虑 AnimateTimeIntervalOfFrame、AnimateFramesPerSecond;若 AnimateOnlyKeepKeyFrame 设置为 false 时,则必须填写AnimateTimeIntervalOfFrame 或 AnimateFramesPerSecond
    String
    false
    true、false
    动图保留关键帧参数
    优先级:AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame
    AnimateTime IntervalOfFrame
    Request.Video
    动图抽帧间 隔时间
    String
    (0,视频时长]
    动图抽帧时间间隔
    若设置 TimeInterval.Duration,则小于该值
    AnimateFrames PerSecond
    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
    AnimateOnlyKeepKeyFrame
    Response.TransTpl.Video
    动图只保留关键帧
    String
    AnimateTimeIntervalOfFrame
    Response.TransTpl.Video
    动图抽帧间隔时间
    String
    AnimateFramesPerSecond
    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.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:bucket-1250000000.ci.ap-beijing.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>