tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

提交视频增强任务

最后更新时间：2023-12-20 09:56:28

    功能描述

    CreateMediaJobs 用于提交一个视频增强任务。

    请求

    请求示例

    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>VideoProcess</Tag>
      <Input>
        <Object></Object>
      </Input>
      <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <TranscodeTemplateId></TranscodeTemplateId>
        <WatermarkTemplateId></WatermarkTemplateId>
        <Output>
          <Region></Region>
          <Bucket></Bucket>
          <Object></Object>
        </Output>
      </Operation>
      <QueueId></QueueId>
      <CallBack></CallBack>
    </Request>
    具体的数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Request
    无
    保存请求的容器
    Container
    是
    Container 类型 Request 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Tag
    Request
    创建任务的 Tag：VideoProcess
    String
    是
    Input
    Request
    待操作的媒体信息
    Container
    是
    Operation
    Request
    操作规则，支持对单个文件执行多个不同任务，最多可填写6个
    Container
    是
    QueueId
    Request
    任务所在的队列 ID
    String
    是
    CallBack
    Request
    回调地址
    String
    否
    Container 类型 Input 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Object
    Request.Input
    媒体文件名
    String
    是
    Container 类型 Operation 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    VideoProcess
    Request.Operation
    指定视频增强模板参数
    Container
    否
    TemplateId
    Request.Operation
    指定的模板 ID
    String
    否
    Transcode
    Request.Operation
    指定转码模板参数，不能与 TranscodeTemplateId 同时为空
    Container
    否
    TranscodeTemplateId
    Request.Operation
    指定的转码模板 ID，优先使用模板 ID，不能与 Transcode 同时为空
    String
    否
    Watermark
    Request.Operation
    指定水印模板参数，同创建水印模板 CreateMediaTemplate 接口的 Request.Watermark, 最多传3个
    Container
    否
    WatermarkTemplateId
    Request.Operation
    指定的水印模板 ID，可以传多个水印模板 ID，最多传3个，优先使用模板 id
    String
    否
    DigitalWatermark
    Request.Operation
    指定数字水印参数
    Container
    否
    Output
    Request.Operation
    结果输出地址
    Container
    是
    注意
    优先使用 TemplateId，无 TemplateId 时使用对应任务类型的参数。
    Container 类型 VideoProcess 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    ColorEnhance
    Request.Operation.VideoProcess
    同创建视频增强模板 CreateMediaTemplate 接口中的 Request.ColorEnhance
    MsSharpen
    Request.Operation.VideoProcess
    同创建视频增强模板 CreateMediaTemplate 接口中的 Request.MsSharpen
    Container 类型 DigitalWatermark 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    必选
    Message
    Request.Operation.DigitalWatermark
    数字水印嵌入的字符串信息，长度不超过64个字符，仅支持中文、英文、数字、_、-和*
    string
    是
    Type
    Request.Operation.DigitalWatermark
    水印类型，当前仅可设置为 Text
    String
    是
    Version
    Request.Operation.DigitalWatermark
    水印版本，当前仅可设置为 V1
    String
    是
    IgnoreError
    Request.Operation.DigitalWatermark
    当添加水印失败是否忽略错误继续执行任务，限制为 true/false，默认为 false
    string
    是
    Container 类型 Output 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Region
    Request.Operation.Output
    存储桶的地域
    String
    是
    Bucket
    Request.Operation.Output
    存储结果的存储桶
    String
    是
    Object
    Request.Operation.Output
    输出结果的文件名
    String
    是

    响应

    响应头

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

    响应体

    该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
    <Response>
      <JobsDetail>
        <Code></Code>
        <Message></Message>
        <JobId></JobId>
        <State></State>
        <CreationTime></CreationTime>
        <StartTime></StartTime>
        <EndTime></EndTime>
        <QueueId></QueueId>
        <Tag>VideoProcess</Tag>
        <Input>
          <Object></Object>
        </Input>
        <Operation>
          <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
          <TranscodeTemplateId></TranscodeTemplateId>
          <WatermarkTemplateId></WatermarkTemplateId>
          <DigitalWatermark>
            <Type>Text</Type>
            <Message>123456789ab</Message>
            <Version>V1</Version>
            <IgnoreError>false</IgnoreError>
          </DigitalWatermark>
          <Output>
            <Region></Region>
            <Bucket></Bucket>
            <Object></Object>
          </Output>
          <MediaInfo>
          </MeidaInfo>
        </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：VideoProcess
    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 的内容： 同请求中的 Request.Input 节点。
    Container 节点 Operation 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    TemplateId
    Response.JobsDetail.Operation
    任务的模板 ID
    String
    Output
    Response.JobsDetail.Operation
    文件的输出地址
    Container
    DigitalWatermark
    Request.Operation
    指定数字水印参数
    Container
    MediaInfo
    Response.JobsDetail.Operation
    转码输出视频的信息，没有时不返回
    Container
    Container 节点 Output 的内容： 同请求中的 Request.Operation.Output 节点。
    Container 节点 MediaInfo 的内容： 同 GenerateMediaInfo 接口中的 Response.MediaInfo 节点。
    Container 类型 DigitalWatermark 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    Message
    Response.Operation.DigitalWatermark
    成功嵌入视频的数字水印的字符串信息，长度不超过64个字符，仅支持中文、英文、数字、_、-和*
    string
    Type
    Response.Operation.DigitalWatermark
    水印类型，当前仅可设置为 Text
    String
    Version
    Response.Operation.DigitalWatermark
    水印版本，当前仅可设置为 V1
    String
    IgnoreError
    Response.Operation.DigitalWatermark
    当添加水印失败是否忽略错误继续执行任务，限制为 true/false，默认 false
    string
    State
    Response.Operation.DigitalWatermark
    添加水印是否成功，执行中为 Running，成功为 Success，失败为 Failed
    string

    错误码

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

    实际案例

    案例一：使用视频增强模板 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: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    
    <Request>
      <Tag>VideoProcess</Tag>
      <Input>
        <Object>test.mp4</Object>
      </Input>
      <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <TranscodeTemplateId></TranscodeTemplateId>
        <WatermarkTemplateId></WatermarkTemplateId>
        <DigitalWatermark>
            <Type>Text</Type>
            <Message>123456789ab</Message>
            <Version>V1</Version>
            <IgnoreError>false</IgnoreError>
        </DigitalWatermark>
        <Output>
            <Region>ap-beijing</Region>
            <Bucket>examplebucket-1250000000</Bucket>
            <Object>test-montage.mkv</Object>
        </Output>
      </Operation>
      <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
    </Request>

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    
    <Response>
      <JobsDetail>
        <Code>Success</Code>
        <Message>Success</Message>
        <JobId>je8f65004eb8511eaaed4f377124a303c</JobId>
        <State>Submitted</State>
        <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
        <StartTime></StartTime>
        <EndTime></EndTime>
        <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
        <Tag>VideoProcess</Tag>
        <Input>
          <Object>test.mp4</Object>
        </Input>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TranscodeTemplateId></TranscodeTemplateId>
            <WatermarkTemplateId></WatermarkTemplateId>
            <DigitalWatermark>
                <Type>Text</Type>
                <Message>123456789ab</Message>
                <Version>V1</Version>
                <IgnoreError>false</IgnoreError>
            </DigitalWatermark>
            <Output>
                <Region>ap-beijing</Region>
                <Bucket>examplebucket-1250000000</Bucket>
                <Object>test-montage.mkv</Object>
            </Output>
        </Operation>
      </JobsDetail>
    </Response>

    案例二：使用视频增强处理参数

    请求

    POST /jobs HTTP/1.1
    Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    
    <Request>
      <Tag>VideoProcess</Tag>
      <Input>
        <Object>test.mp4</Object>
      </Input>
      <Operation>
        <VideoProcess>
          <ColorEnhance>
            <Enable>true</Enable>
            <Contrast></Contrast>
            <Correction></Correction>
            <Saturation></Saturation>
          </ColorEnhance>
          <MsSharpen>
            <Enable>true</Enable>
            <SharpenLevel></SharpenLevel>
          </MsSharpen>
        <VideoProcess>
        <TranscodeTemplateId></TranscodeTemplateId>
        <WatermarkTemplateId></WatermarkTemplateId>
        <DigitalWatermark>
            <Type>Text</Type>
            <Message>123456789ab</Message>
            <Version>V1</Version>
            <IgnoreError>false</IgnoreError>
        </DigitalWatermark>
        <Output>
          <Region>ap-beijing</Region>
          <Bucket>examplebucket-1250000000</Bucket>
          <Object>test-montage.gif</Object>
        </Output>
      </Operation>
      <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
    </Request>

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    
    <Response>
      <JobsDetail>
        <Code>Success</Code>
        <Message>Success</Message>
        <JobId>jabcxxxxfeipplsdfwe</JobId>
        <State>Submitted</State>
        <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
        <StartTime></StartTime>
        <EndTime></EndTime>
        <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
        <Tag>VideoProcess</Tag>
        <Input>
          <Object>test.mp4</Object>
        </Input>
        <Operation>
          <VideoProcess>
            <ColorEnhance>
              <Enable>true</Enable>
              <Contrast></Contrast>
              <Correction></Correction>
              <Saturation></Saturation>
            </ColorEnhance>
            <MsSharpen>
              <Enable>true</Enable>
              <SharpenLevel></SharpenLevel>
            </MsSharpen>
          <VideoProcess>
          <TranscodeTemplateId></TranscodeTemplateId>
          <WatermarkTemplateId></WatermarkTemplateId>
          <DigitalWatermark>
            <State>Success</State>
            <Type>Text</Type>
            <Message>123456789ab</Message>
            <Version>V1</Version>
            <IgnoreError>false</IgnoreError>
          </DigitalWatermark>
          <Output>
            <Region>ap-beijing</Region>
            <Bucket>examplebucket-1250000000</Bucket>
            <Object>test-montage.gif</Object>
          </Output>
        </Operation>
      </JobsDetail>
    </Response>
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款