tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

视频明水印

最后更新时间：2023-05-06 17:35:34

    功能描述

    提交一个视频明水印任务。

    请求

    请求示例

    POST /jobs 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>Watermark</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
        <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
        <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.mp4</Object>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>

    具体的数据描述如下：

    节点名称（关键字） 父节点 描述 类型 是否必选
    Request 无 保存请求的容器 Container 是

    Container 类型 Request 的具体数据描述如下：

    节点名称（关键字） 父节点 描述 类型 是否必选
    Tag Request 创建任务的Tag：Watermark String 是
    Input Request 待操作的文件信息 Container 是
    Operation Request 操作规则 Container 是
    QueueType Request 任务所在的队列类型，限制为 SpeedTranscoding, 表示为开启倍速转码 String 否
    CallBackFormat Request 任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式 String 否
    CallBackType Request 任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型 String 否
    CallBack Request 任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调 String 否
    CallBackMqConfig Request 任务回调TDMQ配置，当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig Container 否

    Container 类型 Input 的具体数据描述如下：

    节点名称（关键字） 父节点 描述 类型 是否必选
    Object Request.Input 文件路径 String 是


    Container 类型 Operation 的具体数据描述如下：

    节点名称（关键字） 父节点 描述 类型 是否必选
    WatermarkTemplateId Request.Operation 水印模板 ID，可以传多个水印模板 ID ，最多传3个。 String数组 否
    Watermark Request.Operation 印模板参数，同创建水印模板接口中的 Request.Watermark ，最多传3个。 Container数组 否
    Output Request.Operation 结果输出配置 Container 是
    UserData Request.Operation 透传用户信息, 可打印的 ASCII 码, 长度不超过1024 String 否
    JobLevel Request.Operation 任务优先级，级别限制：0 、1 、2 。级别越大任务优先级越高，默认为0 String 否
    说明：

    对于水印参数，可以使用 WatermarkTemplateId 或 Watermark 设置，WatermarkTemplateId 优先级更高，两者不能同时为空

    Container 类型 Output 的具体数据描述如下：

    节点名称（关键字） 父节点 描述 类型 是否必选
    Region Request.Operation.Output 存储桶的地域 String 是
    Bucket Request.Operation.Output 存储结果的存储桶 String 是
    Object Request.Operation.Output 输出结果的文件名 String 是

    Request.Operation.Output.Object 支持的通配符如下：

    通配符 含义
    ${ext} 封装格式
    ${jobid} 任务Id

    响应

    响应头

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

    响应体

    该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：

    <Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Watermark</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
            <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
            <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.mp4</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>

    具体的数据内容如下：

    节点名称（关键字） 父节点 描述 类型
    Response 无 保存结果的容器 Container

    Container 节点 Response 的内容：

    节点名称（关键字） 父节点 描述 类型
    JobsDetail Response 任务的详细信息 Container


    Container 节点 JobsDetail 的内容：

    节点名称（关键字） 父节点 描述 类型
    Code Response.JobsDetail 错误码，只有 State 为 Failed 时有意义 String
    Message Response.JobsDetail 错误描述，只有 State 为 Failed 时有意义 String
    JobId Response.JobsDetail 新创建任务的 ID String
    Tag Response.JobsDetail 新创建任务的 Tag：Watermark String
    State Response.JobsDetail 任务的状态，为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个 String
    CreationTime Response.JobsDetail 任务的创建时间 String
    StartTime Response.JobsDetail 任务的开始时间 String
    EndTime Response.JobsDetail 任务的结束时间 String
    QueueId Response.JobsDetail 任务所属的队列 ID String
    Input Response.JobsDetail 该任务的输入资源地址 Container
    Operation Response.JobsDetail 该任务的规则 Container

    Container 节点 Input 的内容：

    节点名称（关键字） 父节点 描述 类型
    Region Response.JobsDetail.Input 存储桶的地域 String
    Bucket Response.JobsDetail.Input 存储结果的存储桶 String
    Object Response.JobsDetail.Input 输出结果的文件名 String

    Container 节点 Operation 的内容：

    节点名称（关键字） 父节点 描述
    WatermarkTemplateId Response.JobsDetail.Operation 水印模板 ID
    Watermark Response.JobsDetail.Operation 同请求中的 Request.Operation.Watermark
    Output Response.JobsDetail.Operation 同请求中的 Request.Operation.Output
    MediaInfo Response.JobsDetail.Operation 输出文件的媒体信息，任务未完成时不返回
    MediaResult Response.JobsDetail.Operation 输出文件的基本信息，任务未完成时不返回
    UserData Response.JobsDetail.Operation 透传用户信息
    JobLevel Response.JobsDetail.Operation 任务优先级

    Container 节点 MediaInfo 的内容：
    同 GenerateMediaInfo 接口中的 Response.MediaInfo 节点。

    Container 节点 MediaResult 的内容：
    详情见 MediaResult

    错误码

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

    实际案例

    请求1：使用水印模板id

    POST /jobs 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: 166
Content-Type: application/xml

<Request>
    <Tag>Watermark</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
        <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
        <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.mp4</Object>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>

    响应1

    HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:11+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Watermark</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId>
            <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId>
            <WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.mp4</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>

    请求2：使用水印参数

    POST /jobs 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: 166
Content-Type: application/xml

<Request>
    <Tag>Watermark</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <Watermark>
            <Type>Text</Type>
            <LocMode>Absolute</LocMode>
            <Dx>128</Dx>
            <Dy>128</Dy>
            <Pos>TopRight</Pos>
            <StartTime>0</StartTime>
            <EndTime>100.5</EndTime>
            <Text>
                <Text>水印内容</Text>
                <FontSize>30</FontSize>
                <FontType>simfang.ttf</FontType>
                <FontColor>0xRRGGBB</FontColor>
                <Transparency>30</Transparency>
            </Text>
        </Watermark>
        <Watermark>
            <Type>Image</Type>
            <LocMode>Absolute</LocMode>
            <Dx>128</Dx>
            <Dy>128</Dy>
            <Pos>TopRight</Pos>
            <StartTime>0</StartTime>
            <EndTime>100.5</EndTime>
            <Image>
                <Url>http://test-1234567890.ci.ap-chongqing.myqcloud.com/shuiyin_2.png</Url>
                <Mode>Proportion</Mode>
                <Width>10</Width>
                <Height></Height>
                <Transparency>100</Transparency>
            </Image>
        </Watermark>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.mp4</Object>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>

    响应2

    HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Watermark</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <Watermark>
                <Type>Text</Type>
                <LocMode>Absolute</LocMode>
                <Dx>128</Dx>
                <Dy>128</Dy>
                <Pos>TopRight</Pos>
                <StartTime>0</StartTime>
                <EndTime>100.5</EndTime>
                <Text>
                    <Text>水印内容</Text>
                    <FontSize>30</FontSize>
                    <FontType>simfang.ttf</FontType>
                    <FontColor>0xRRGGBB</FontColor>
                    <Transparency>30</Transparency>
                </Text>
            </Watermark>
            <Watermark>
                <Type>Image</Type>
                <LocMode>Absolute</LocMode>
                <Dx>128</Dx>
                <Dy>128</Dy>
                <Pos>TopRight</Pos>
                <StartTime>0</StartTime>
                <EndTime>100.5</EndTime>
                <Image>
                    <Url>http://test-1234567890.ci.ap-chongqing.myqcloud.com/shuiyin_2.png</Url>
                    <Mode>Proportion</Mode>
                    <Width>10</Width>
                    <Height></Height>
                    <Transparency>100</Transparency>
                </Image>
            </Watermark>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.mp4</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款