tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

创建截图模板

最后更新时间：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>Snapshot</Tag>
        <Name>TemplateName</Name>
        <Snapshot>
            <Mode>Interval</Mode>
            <Width>1280</Width>
            <Height>960</Height>
            <Start>0</Start>
            <TimeInterval>0.5</TimeInterval>
            <Count>10</Count>
            <SnapshotOutMode>OnlySprite</SnapshotOutMode>
            <SpriteSnapshotConfig>
                <Color>Aquamarine</Color>
                <Columns>3</Columns>
                <Lines>3</Lines>
            </SpriteSnapshotConfig>
        </Snapshot>
    </Request>
    具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Request
    无
    保存请求的容器
    Container
    是
    Container 类型 Request 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Tag
    Request
    模板类型：Snapshot
    String
    是
    Name
    Request
    模板名称仅支持中文、英文、数字、_、-和*
    String
    是
    Snapshot
    Request
    截图
    Container
    是
    
    Container 类型 Snapshot 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    默认值
    限制
    Mode
    Request.Snapshot
    截图模式
    String
    否
    Interval
    值范围：{Interval, Average, KeyFrame}
    Interval 表示间隔模式 Average 表示平均模式
    KeyFrame 表示关键帧模式
    Interval模式：Start，TimeInterval， Count参数生效。当设置Count，未设置TimeInterval时， 表示截取所有帧，共Count张图片
    Average模式：Start，Count参数生效。表示
    从Start开始到视频结束，按平均间隔截取共Count张图片
    Start
    Request.Snapshot
    开始时间
    String
    否
    0
    [0 视频时长]
    单位为秒
    支持 float 格式，执行精度精确到毫秒
    TimeInterval
    Request.Snapshot
    截图时间间隔
    String
    否
    无
    (0 3600]
    单位为秒
    支持 float 格式，执行精度精确到毫秒
    Count
    Request.Snapshot
    截图数量
    String
    是
    无
    (0 10000]
    Width
    Request.Snapshot
    宽
    String
    否
    视频原 始宽度
    值范围：[128，4096]
    单位：px
    若只设置 Width 时，按照视频原始比例计算 Height
    Height
    Request.Snapshot
    高
    String
    否
    视频原 始高度
    值范围：[128，4096]
    单位：px
    若只设置 Height 时，按照视频原始比例计算 Width
    CIParam
    Request.Snapshot
    截图图片处理参数
    String
    否
    无
    参考 图片处理
    例如: imageMogr2/format/png
    IsCheckCount
    Request.Snapshot
    是否强制检查截图个数
    String
    否
    false
    使用自定义间隔模式截图时，视频时长不够截取 Count 个截图，可以转为平均截图模式截取 Count 个截图
    IsCheckBlack
    Request.Snapshot
    是否开启黑屏检测
    String
    否
    false
    true/false
    BlackLevel
    Request.Snapshot
    截图黑屏检测参数
    String
    否
    空
    当 IsCheckBlack=true 时有效
    值参考范围[30，100]，表示黑色像素的占比值，值越小，黑色占比越小
    Start>0，参数设置无效，不做过滤黑屏
    Start =0 参数有效，截帧的开始时间为第一帧非黑屏开始
    PixelBlackThreshold
    Request.Snapshot
    截图黑屏检测参数
    String
    否
    空
    当IsCheckBlack=true时有效
    判断像素点是否为黑色点的阈值，取值范围：[0，255]
    SnapshotOutMode
    Request.Snapshot
    截图输出模式参数
    String
    否
    OnlySnapshot
    值范围：{OnlySnapshot, OnlySprite, SnapshotAndSprite}
    OnlySnapshot 表示仅输出截图模式 OnlySprite 表示仅输出雪碧图模式 SnapshotAndSprite 表示输出截图与雪碧图模式
    SpriteSnapshotConfig
    Request.Snapshot
    雪碧图输出配置
    Container
    否
    无
    无
    Container 类型 Snapshot.SpriteSnapshotConfig 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    必选
    默认值
    限制
    CellWidth
    Request.Snapshot.SpriteSnapshotConfig
    单图宽度
    String
    否
    截图宽度
    值范围：[8，4096]
    单位：px
    CellHeight
    Request.Snapshot.SpriteSnapshotConfig
    单图高度
    String
    否
    截图高度
    值范围：[8，4096]
    单位：px
    Padding
    Request.Snapshot.SpriteSnapshotConfig
    雪碧图内边距大小
    String
    否
    0
    值范围：[0，1024]
    单位：px
    Margin
    Request.Snapshot.SpriteSnapshotConfig
    雪碧图外边距大小
    String
    否
    0
    值范围：[0，1024]
    单位：px
    Color
    Request.Snapshot.SpriteSnapshotConfig
    背景颜色
    String
    是
    无
    支持颜色详见 FFmpeg
    Columns
    Request.Snapshot.SpriteSnapshotConfig
    雪碧图列数
    String
    是
    0
    值范围：[1，10000]
    Lines
    Request.Snapshot.SpriteSnapshotConfig
    雪碧图行数
    String
    是
    0
    值范围：[1，10000]
    

    响应

    响应头

    此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

    响应体

    该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
    <Response>
        <Template>
            <Tag>Snapshot</Tag>
            <Name>TemplateName</Name>
            <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
            <BucketId>test-1234567890</BucketId>
            <Category>Custom</Category>
            <Snapshot>
                <Mode>Interval</Mode>
                <Width>1280</Width>
                <Height>960</Height>
                <Start>0</Start>
                <TimeInterval>0.5</TimeInterval>
                <Count>10</Count>
                <SnapshotOutMode>OnlySprite</SnapshotOutMode>
                <SpriteSnapshotConfig>
                    <Color>Aquamarine</Color>
                    <Columns>3</Columns>
                    <Lines>3</Lines>
                </SpriteSnapshotConfig>
            </Snapshot>
            <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
            <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        </Template>
    </Response>
    具体的数据内容如下：
    节点名称（关键字）
    父节点
    描述
    类型
    Response
    无
    保存结果的容器
    Container
    Container 节点 Response 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    Tag
    Response
    模板类型，Snapshot
    String
    Name
    Response
    模板名字
    String
    TemplateId
    Response
    模板 ID
    String
    UpdateTime
    Response
    更新时间
    String
    CreateTime
    Response
    创建时间
    String
    Snapshot
    Response
    详细的模板参数，同上述请求体部分 Snapshot 说明
    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-beijing.myqcloud.com
    Content-Length: 1666
    Content-Type: application/xml
    
    <Request>
        <Tag>Snapshot</Tag>
        <Name>TemplateName</Name>
        <Snapshot>
            <Mode>Interval</Mode>
            <Width>1280</Width>
            <Height>960</Height>
            <Start>0</Start>
            <TimeInterval>0.5</TimeInterval>
            <Count>10</Count>
            <SnapshotOutMode>OnlySprite</SnapshotOutMode>
            <SpriteSnapshotConfig>
                <Color>Aquamarine</Color>
                <Columns>3</Columns>
                <Lines>3</Lines>
            </SpriteSnapshotConfig>
        </Snapshot>
    </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: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
    
    <Response>
        <Template>
            <Tag>Snapshot</Tag>
            <Name>TemplateName</Name>
            <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
            <BucketId>test-1234567890</BucketId>
            <Category>Custom</Category>
            <Snapshot>
                <Mode>Interval</Mode>
                <Width>1280</Width>
                <Height>960</Height>
                <Start>0</Start>
                <TimeInterval>0.5</TimeInterval>
                <Count>10</Count>
                <SnapshotOutMode>OnlySprite</SnapshotOutMode>
                <SpriteSnapshotConfig>
                    <Color>Aquamarine</Color>
                    <Columns>3</Columns>
                    <Lines>3</Lines>
                </SpriteSnapshotConfig>
            </Snapshot>
            <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
            <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        </Template>
    </Response>
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款