tencent cloud

文档反馈

GenerateSnapshot

最后更新时间:2024-01-20 10:09:09

    功能描述

    GenerateSnapshot 接口用于获取媒体文件某个时间的截图,输出的截图统一为 jpeg 格式。

    请求

    请求示例

    POST /snapshot 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(详情请参见 请求签名 文档)。
    通过子账号使用时,需要授予相关的权限,详情请参见授权粒度详情文档。

    请求头

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

    请求体

    该 API 接口请求的请求体具体节点内容为:
    <Request>
    <Input>
    <Object></Object>
    </Input>
    <Time></Time>
    <Width></Width>
    <Height></Height>
    <Mode></Mode>
    <Rotate></Rotate>
    <Format></Format>
    <Output>
    <Region></Region>
    <Bucket></Bucket>
    <Object></Object>
    </Output>
    </Request>
    具体的数据内容如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Request
    保存 Generate Snapshot 请求的容器
    Container
    Container 节点 Request 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Input
    Request
    媒体文件的位置信息
    Container
    Time
    Request
    截取哪个时间点的内容,单位为秒
    Float
    Output
    Request
    截图保存的位置信息
    Container
    Width
    Request
    截图的宽。默认为0
    Int
    Height
    Request
    截图的高。默认为0。
    Width 和 Height 都为0时,表示使用视频的宽高。如果单个为0,则以另外一个值按视频宽高比例自动适应。
    Int
    Format
    Request
    截图的格式,支持 jpg 和 png,默认 jpg
    String
    Mode
    Request
    截帧方式
    keyframe:截取指定时间点之前的最近的一个关键帧
    exactframe:截取指定时间点的帧
    默认值为 exactframe
    String
    Rotate
    Request
    图片旋转方式。
    auto:按视频旋转信息进行自动旋转
    off:不旋转
    默认值为 auto
    String
    Container 节点 Input 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Object
    Request.Input
    文件的名称
    String
    Container 节点 Output 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Region
    Request.Output
    存储桶所在的地域
    String
    Bucket
    Request.Output
    文件所属的 COS 存储桶
    String
    Object
    Request.Output
    文件的名称
    String

    响应

    响应头

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

    响应体

    该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
    <Response>
    <Output>
    <Region></Region>
    <Bucket></Bucket>
    <Object></Object>
    </Output>
    </Response>
    具体的数据内容如下:
    节点名称(关键字)
    父节点
    描述
    类型
    Response
    保存结果的容器
    Container
    Container 节点 Response 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    Output
    Request
    截图保存的位置信息
    Container
    Container 节点 Output 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    Region
    Response.Output
    存储桶所在的地域
    String
    Bucket
    Response.Output
    文件所属的 COS 存储桶
    String
    Object
    Response.Output
    文件的名称
    String

    错误码

    该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

    实际案例

    请求

    POST /snapshot HTTP/1.1
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Date: Fri, 10 Mar 2016 09:45:46 GMT
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDWtTCBYjM5OwLB9CAwA1Qb2ThTSUj****&q-sign-time=1484213027;32557109027&q-key-time=1484213027;32557109027&q-header-list=host&q-url-param-list=acl&q-signature=dcc1eb2022b79cb2a780bf062d3a40e120b4****
    Content-Length: 552
    Content-Type: application/xml
    
    <Request>
    <Input>
    <Object>video-for-test.mp4</Object>
    </Input>
    <Time>10</Time>
    <Output>
    <Region>ap-beijing</Region>
    <Bucket>ci-output-1250000000</Bucket>
    <Object>snapshot/video-for-test-snapshot.jpg</Object>
    </Output>
    </Request>

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 266
    Connection: keep-alive
    Date: Fri, 10 Mar 2016 09:45:46 GMT
    Server: tencent-ci
    x-ci-request-id: NTg3NzRiMjVfYmRjMzVfMTViMl82ZGZm****
    
    <Response>
    <Output>
    <Region>ap-beijing</Region>
    <Bucket>ci-output-1250000000</Bucket>
    <Object>snapshot/video-for-test-snapshot.jpg</Object>
    </Output>
    </Response>
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持