tencent cloud

Overview

This document provides an overview of APIs and SDK code samples for animated image job submission.

Submitting Animated Image Job

Feature description

This API is used to submit an animated image job.

Method prototype

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

Sample request

Sample 1. Using a template

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; // Replace it with your real `secretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; // Replace it with your real `secretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
$region = "ap-beijing"; // Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is `http` by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->createMediaAnimationJobs(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at 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', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
              'Object' => 'Animation.gif',
          ),
      ),
  ));
  // Request successful
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Sample 2. Customizing parameters

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; // Replace it with your real `secretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; // Replace it with your real `secretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
$region = "ap-beijing"; // Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is `http` by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->createMediaAnimationJobs(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at 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', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
              'Object' => 'Animation.gif',
          ),
      ),
  ));
  // Request successful
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Parameter description

Request has the following sub-nodes:

Input has the following sub-nodes:

Operation has the following sub-nodes:

Note：

TemplateId is used with priority. If TemplateId is unavailable, the corresponding job type parameter is used.

Animation has the following sub-nodes:

Output has the following sub-nodes:

Sample response

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
              )
       )
)