tencent cloud

文档反馈

动图任务接口

最后更新时间:2022-05-23 14:41:09

    简介

    本文档提供关于提交动图任务的 API 概览和 SDK 示例代码。

    API 操作描述
    提交动图任务 提交一个动图任务

    提交动图任务

    功能说明

    用于提交一个动图任务。

    方法原型

    public Guzzle\Service\Resource\Model createMediaAnimationJobs(array $args = array());
    

    请求示例

    示例一: 使用模板

    <?php
    require dirname(__FILE__) . '/../vendor/autoload.php';
    $secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.intl.cloud.tencent.com/cam/capi
    $secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.intl.cloud.tencent.com/cam/capi
    $region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.intl.cloud.tencent.com/cos5/bucket
    $cosClient = new Qcloud\Cos\Client(
      array(
          'region' => $region,
          'schema' => 'https', //协议头部,默认为http
          'credentials'=> array(
              'secretId'  => $secretId ,
              'secretKey' => $secretKey)));
    try {
      $result = $cosClient->createMediaAnimationJobs(array(
          'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.intl.cloud.tencent.com/cos5/bucket
          'Tag' => 'Animation',
          'QueueId' => 'p81e648af2aee49688xxxxxxxxxxxxxxxx',
          'Input' => array(
              'Object' => 'video01.mp4'
          ),
          'Operation' => array(
              'TemplateId' => 't1de276cbdab16xxxxxxxxxxxxxxxxxxxxx',
              'Output' => array(
                  'Region' => $region,
                  'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.intl.cloud.tencent.com/cos5/bucket
                  'Object' => 'Animation.gif',
              ),
          ),
      ));
      // 请求成功
      print_r($result);
    } catch (\Exception $e) {
      // 请求失败
      echo($e);
    }
    

    示例二: 自定义参数

    <?php
    require dirname(__FILE__) . '/../vendor/autoload.php';
    $secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.intl.cloud.tencent.com/cam/capi
    $secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.intl.cloud.tencent.com/cam/capi
    $region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.intl.cloud.tencent.com/cos5/bucket
    $cosClient = new Qcloud\Cos\Client(
      array(
          'region' => $region,
          'schema' => 'https', //协议头部,默认为http
          'credentials'=> array(
              'secretId'  => $secretId ,
              'secretKey' => $secretKey)));
    try {
      $result = $cosClient->createMediaAnimationJobs(array(
          'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.intl.cloud.tencent.com/cos5/bucket
          'Tag' => 'Animation',
          'QueueId' => 'p81e648af2aee49688xxxxxxxxxxxxxxxx',
          'Input' => array(
              'Object' => 'video01.mp4'
          ),
          'Operation' => array(
              'Animation' => array(
                  'Container' => array(
                      'Format' => '',
                  ),
                  'Video' => array(
                      'Codec' => '',
                      'Width' => '',
                      'Height' => '',
                      'Fps' => '',
                      'AnimateOnlyKeepKeyFrame' => '',
                      'AnimateTimeIntervalOfFrame' => '',
                      'AnimateFramesPerSecond' => '',
                      'Quality' => '',
                  ),
                  'TimeInterval' => array(
                      'Start' => '',
                      'Duration' => '',
                  ),
              ),
              'Output' => array(
                  'Region' => $region,
                  'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.intl.cloud.tencent.com/cos5/bucket
                  'Object' => 'Animation.gif',
              ),
          ),
      ));
      // 请求成功
      print_r($result);
    } catch (\Exception $e) {
      // 请求失败
      echo($e);
    }
    

    参数说明

    Request 中的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选
    Tag Request 创建任务的 Tag:Transcode(转码)、Animation(动图)、SmartCover(智能封面)、Snapshot(截图)、Concat(拼接) String
    Input Request 待操作的媒体信息 Container
    Operation Request 操作规则,支持对单个文件执行多个不同任务,最多可填写6个 Container
    QueueId Request 任务所在的队列 ID String
    CallBack Request 回调地址 String

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

    节点名称(关键字) 父节点 描述 类型 是否必选
    Object Request.Input 媒体文件名 String

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

    节点名称(关键字) 父节点 描述 类型 是否必选
    Animation Request.Operation 指定该任务的参数 Container
    TemplateId Request.Operation 指定的模板 ID String
    Output Request.Operation 结果输出地址 Container
    注意:

    优先使用 TemplateId,无 TemplateId 时使用对应任务类型的参数。

    Container 类型 Animation 的具体数据描述如下:

    节点名称(关键字) 父节点 描述 类型 是否必选
    Container Request.Operation.Animation 同动图模板 CreateMediaTemplate 接口中的 Request.Container Container
    Video Request.Operation.Animation 同动图模板 CreateMediaTemplate 接口中的 Request.Video Container
    TimeInterval Request.Operation.Animation 同动图模板 CreateMediaTemplate 接口中的 Request.TimeInterval Container

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

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

    返回结果示例

    GuzzleHttp\Command\Result Object
    (
      [Body] => GuzzleHttp\Psr7\Stream Object
          (
              [stream:GuzzleHttp\Psr7\Stream:private] => Resource id #88
              [size:GuzzleHttp\Psr7\Stream:private] => 
              [seekable:GuzzleHttp\Psr7\Stream:private] => 1
              [readable:GuzzleHttp\Psr7\Stream:private] => 1
              [writable:GuzzleHttp\Psr7\Stream:private] => 1
              [uri:GuzzleHttp\Psr7\Stream:private] => php://temp
              [customMetadata:GuzzleHttp\Psr7\Stream:private] => Array
                  (
                  )
           )
       [RequestId] => NjI2MTQHOAIHDOIDUOIA7879ADJOIMDc2YTk=
      [ContentType] => application/xml
      [ContentLength] => 797
      [Bucket] => examplebucket-1250000000
      [Location] => examplebucket-1250000000.ci.ap-beijing.myqcloud.com/jobs
      [Response] => Array
          (
              [JobsDetail] => Array
                  (
                      [Code] => Success
                      [CreationTime] => 2022-04-21T19:29:36+0800
                      [EndTime] => -
                      [Input] => Array
                          (
                              [BucketId] => examplebucket-1250000000
                              [Object] => video01.mp4
                              [Region] => ap-beijing
                          )
                       [JobId] => j5318zx9c890zx8c0z98c0fa6355174de
                      [Message] => 
                      [Operation] => Array
                          (
                              [Output] => Array
                                  (
                                      [Bucket] => examplebucket-1250000000
                                      [Object] => Animation.gif
                                      [Region] => ap-beijing
                                  )
                               [TemplateId] => t1de276cbdz78xcz09xc80zx901af71
                              [TemplateName] => Animation-gif-1
                          )
                       [QueueId] => p81e648af2aeez87c6z78xc7z98xc79ca86
                      [StartTime] => -
                      [State] => Submitted
                      [Tag] => Animation
                  )
           )
    )
    
    联系我们

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

    技术支持

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

    7x24 电话支持