tencent cloud

文档反馈

智能封面任务接口

最后更新时间:2024-03-14 09:31:03

    简介

    本文档提供关于提交智能封面任务的 API 概览和 SDK 示例代码。
    API
    操作描述
    提交一个智能封面任务

    提交智能封面任务

    功能说明

    用于提交一个智能封面任务。

    方法原型

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

    请求示例

    <?php
    
    require dirname(__FILE__) . '/../vendor/autoload.php';
    
    $secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
    $secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
    $region = "ap-beijing"; //替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
    $cosClient = new Qcloud\\Cos\\Client(
    array(
    'region' => $region,
    'schema' => 'https', //协议头部,默认为 http
    'credentials'=> array(
    'secretId' => $secretId ,
    'secretKey' => $secretKey)));
    try {
    // 提交智能封面任务 https://www.tencentcloud.com/document/product/436/54017?from_cn_redirect=1
    $result = $cosClient->createMediaSmartCoverJobs(array(
    'Bucket' => 'examplebucket-1250000000', //存储桶名称,由 BucketName-Appid 组成,可以在 COS 控制台查看 https://console.tencentcloud.com/cos5/bucket
    'Tag' => 'SmartCover',
    'QueueId' => 'p81e648afxxxxxxxxxxxxxxxxx',
    'Input' => array(
    'Object' => 'video01.mp4'
    ),
    'Operation' => array(
    // 'TemplateId' => '', // 使用模板
    'SmartCover' => array(
    'Format' => '',
    'Width' => '',
    'Height' => '',
    'Count' => '',
    'DeleteDuplicates' => '',
    ),
    'Output' => array(
    'Region' => $region,
    'Bucket' => 'examplebucket-1250000000', //存储桶名称,由 BucketName-Appid 组成,可以在 COS 控制台查看 https://console.tencentcloud.com/cos5/bucket
    'Object' => 'SmartCover-${Number}.jpg',
    ),
    // 'UserData' => 'xxx', // 透传用户信息
    // 'JobLevel' => '0', // 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0
    ),
    'CallBack' => '',
    // 'CallBackFormat' => '',
    // 'CallBackType' => '',
    ));
    // 请求成功
    print_r($result);
    } catch (\\Exception $e) {
    // 请求失败
    echo($e);
    }

    参数说明

    Request 中的具体数据描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Tag
    Request
    创建任务的 Tag:SmartCover
    String
    Input
    Request
    待操作的媒体信息
    Container
    Operation
    Request
    操作规则
    Container
    QueueId
    Request
    任务所在的队列 ID
    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 的具体数据描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    TemplateId
    Request.Operation
    智能封面模板 ID
    String
    SmartCover
    Request.Operation
    封面配置
    Container
    Output
    Request.Operation
    结果输出地址
    Container
    UserData
    Request.Operation
    透传用户信息, 可打印的 ASCII 码, 长度不超过1024
    String
    JobLevel
    Request.Operation
    任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0
    String
    说明
    如果同时设置了 TemplateId 和 SmartCover,则优先使用 TemplateId。
    Container 类型 SmartCover 的具体数据类型描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    默认值
    限制
    Format
    Request.Operation.SmartCover
    封面图片类型
    String
    png、jpg、webp
    Width
    Request.Operation.SmartCover
    封面图片宽度
    String
    值范围:[128,4096]
    单位:px
    Height
    Request.Operation.SmartCover
    封面图片高度
    String
    值范围:[128,4096]
    单位:px
    Count
    Request.Operation.SmartCover
    封面数量
    String
    3
    值范围:[1,10]
    DeleteDuplicates
    Request.Operation.SmartCover
    封面是否去重
    String
    false
    true/false
    Container 类型 Output 的具体数据描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Region
    Request.Operation.Output
    存储桶的地域
    String
    Bucket
    Request.Operation.Output
    存储结果的存储桶
    String
    Object
    Request.Operation.Output
    输出结果的文件名。
    必须包含 ${Number} 参数。
    如 Object 为 my-new-cover-${Number}.jpg,对应实际3张输出结果时,分别为
    my-new-cover-0.jpg
    my-new-cover-1.jpg
    my-new-cover-2.jpg
    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] => NjI2MASOIDUAOIDUJIAOJDIOADJyMjNjZDE=
    [ContentType] => application/xml
    [ContentLength] => 832
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-beijing.myqcloud.com/jobs
    [Response] => Array
    (
    [JobsDetail] => Array
    (
    [Code] => Success
    [CreationTime] => 2022-04-22T11:12:33+0800
    [EndTime] => -
    [Input] => Array
    (
    [BucketId] => examplebucket-1250000000
    [Object] => video01.mp4
    [Region] => ap-beijing
    )
    
    [JobId] => j0d9bc17z890zx8c9s877z97187147
    [Message] =>
    [Operation] => Array
    (
    [Output] => Array
    (
    [Bucket] => examplebucket-1250000000
    [Object] => SmartCover-${Number}.jpg
    [Region] => ap-beijing
    )
    
    [SmartCover] => Array
    (
    [Count] =>
    [DeleteDuplicates] => false
    [Format] =>
    [Height] =>
    [Width] =>
    )
    [UserData] => xxx
    [JobLevel] => 0
    )
    
    [QueueId] => p81e648afzx8c09z8xc09zx8c097be086
    [StartTime] => -
    [State] => Submitted
    [Tag] => SmartCover
    )
    
    )
    
    )
    
    联系我们

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

    技术支持

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

    7x24 电话支持