对象存储

动态与公告

产品简介

购买指南

快速入门

控制台指南

工具指南

最佳实践

视频教程专区

开发者指南

第三方教程

数据湖存储

数据处理 Demo 体验

故障处理

API 文档

SDK 文档

常见问题

服务等级协议

附录

联系我们

词汇表
文档捉虫大赛火热进行中，好礼多多> HOT
文档中心 > 对象存储 > SDK 文档 > PHP SDK > 任务接口 > 超分辨率任务接口

超分辨率任务接口

最近更新时间：2022-12-14 17:54:47

前往 GitHub 编辑 我的收藏

本页目录：

简介

本文档提供关于超分辨率任务接口的 API 概览和 SDK 示例代码。

API 操作描述
提交超分辨率任务 提交超分辨率任务

提交超分辨率任务

功能说明

提交超分辨率任务。

方法原型

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

请求示例

示例一： 使用模板

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.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->createMediaSuperResolutionJobs(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Tag' => 'SuperResolution',
        'QueueId' => 'p81e648af2aee49688570xxxxxxxxxxx',
        'Input' => array(
            'Object' => 'video01.mp4'
        ),
        'Operation' => array(
            'TemplateId' =>'t19ea5e0c0b7054d7b904axxxxxxxxxxx',
            'TranscodeTemplateId' =>'t0b612860a293f41078xxxxxxxxxxx',
            'WatermarkTemplateId' =>'t185e2e24551b24259a02xxxxxxxxxxx',
            'DigitalWatermark' => array(
                'Message' => 'xxx',
                'Type' => 'Text',
                'Version' => 'V1',
                'IgnoreError' => 'true',
            ),
            'Output' => array(
                'Region' => $region,
                'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket
                'Object' => 'SuperResolution.flv',
            ),
//            'UserData' => 'xxx', // 透传用户信息
//            'JobLevel' => '0', // 任务优先级，级别限制：0 、1 、2。级别越大任务优先级越高，默认为0
        ),
        'CallBack' => '',
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

示例二： 自定义参数

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.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->createMediaSuperResolutionJobs(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Tag' => 'SuperResolution',
        'QueueId' => 'p81e648af2aee49688570xxxxxxxxxxx',
        'Input' => array(
            'Object' => 'video01.mp4'
        ),
        'Operation' => array(
            'SuperResolution' => array(
                'Resolution' => '',
                'EnableScaleUp' => '',
            ),
            'Transcode' => array(
                'Tag' => '',
                'Name' => '',
                'Container' => array(
                    'Format' => '',
                ),
                'Video' => array(
                    'Codec' => '',
                    'Width' => '',
                    'Height' => '',
                    'Fps' => '',
                    'Remove' => '',
                    'Profile' => '',
                    'Bitrate' => '',
                    'Crf' => '',
                    'Gop' => '',
                    'Preset' => '',
                    'Bufsize' => '',
                    'Maxrate' => '',
                    'HlsTsTime' => '',
                    'Pixfmt' => '',
                    'LongShortMode' => '',
                ),
                'TimeInterval' => array(
                    'Start' => '',
                    'Duration' => '',
                ),
                'Audio' => array(
                    'Codec' => '',
                    'Samplerate' => '',
                    'Bitrate' => '',
                    'Channels' => '',
                    'Remove' => '',
                    'KeepTwoTracks' => '',
                    'SwitchTrack' => '',
                    'SampleFormat' => '',
                ),
                'TransConfig' => array(
                    'AdjDarMethod' => '',
                    'IsCheckReso' => '',
                    'ResoAdjMethod' => '',
                    'IsCheckVideoBitrate' => '',
                    'VideoBitrateAdjMethod' => '',
                    'IsCheckAudioBitrate' => '',
                    'AudioBitrateAdjMethod' => '',
                    'DeleteMetadata' => '',
                    'IsHdr2Sdr' => '',
                    'HlsEncrypt' => array(
                        'IsHlsEncrypt' => '',
                        'UriKey' => '',
                    ),
                ),
            ),
            'Watermark' => array(
                'Type' => '',
                'Pos' => '',
                'LocMode' => '',
                'Dx' => '',
                'Dy' => '',
                'StartTime' => '',
                'EndTime' => '',
                'Image' => array(
                    'Url' => '',
                    'Mode' => '',
                    'Width' => '',
                    'Height' => '',
                    'Transparency' => '',
                    'Background' => '',
                ),
                'Text' => array(
                    'FontSize' => '',
                    'FontType' => '',
                    'FontColor' => '',
                    'Transparency' => '',
                    'Text' => '',
                ),
            ),
            'DigitalWatermark' => array(
                'Message' => '',
                'Type' => '',
                'Version' => '',
                'IgnoreError' => '',
            ),
            'Output' => array(
                'Region' => $region,
                'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket
                'Object' => 'SuperResolution.flv',
            ),
//            'UserData' => 'xxx', // 透传用户信息
//            'JobLevel' => '0', // 任务优先级，级别限制：0 、1 、2。级别越大任务优先级越高，默认为0
        ),
        'CallBack' => '',
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

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

节点名称（关键字） 父节点 描述 类型 是否必选
Tag Request 创建任务的 Tag：SuperResolution 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 的具体数据描述如下：

节点名称（关键字） 父节点 描述 类型 是否必选
SuperResolution Request.Operation 指定超分辨率模板参数，不能与 TemplateId 同时为空 Container 否
TemplateId Request.Operation 指定的超分辨率模 ID，优先使用模板 ID，不能与 SuperResolution 同时为空 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 是
UserData Request.Operation 透传用户信息, 可打印的 ASCII 码, 长度不超过1024 String 否
JobLevel Request.Operation 任务优先级，级别限制：0 、1 、2。级别越大任务优先级越高，默认为0 String 否
说明：

提交超分辨率任务必须传入转码参数。对于超分辨率参数，优先使用 TemplateId，无 TemplateId 时使用 SuperResolution；对于转码参数，优先使用 TranscodeTemplateId，无 TranscodeTemplateId 时使用 Transcode；对于水印参数，可以使用 WatermarkTemplateId 或 Watermark 设置，WatermarkTemplateId 优先级更高。

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

节点名称（关键字） 父节点 描述 类型 必选
Resolution Request.Operation.SuperResolution 同创建超分辨率模板 CreateMediaTemplate 接口中的 Request.Resolution String 是
EnableScaleUp Request.Operation.SuperResolution 同创建超分辨率模板 CreateMediaTemplate 接口中的 Request.EnableScaleUp String 否
Version Request.Operation.SuperResolution 同创建超分辨率模板 CreateMediaTemplate 接口中的 Request.Version String 否

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

节点名称（关键字） 父节点 描述 类型 必选
TimeInterval Request.Operation.Transcode 同创建转码模板 CreateMediaTemplate 接口中的 Request.TimeInterval Container 否
Container Request.Operation.Transcode 同创建转码模板 CreateMediaTemplate 接口中的 Request.Container Container 否
Video Request.Operation.Transcode 同创建转码模板 CreateMediaTemplate 接口中的 Request.Video Container 否
Audio Request.Operation.Transcode 同创建转码模板 CreateMediaTemplate 接口中的 Request.Audio Container 否
TransConfig Request.Operation.Transcode 同创建转码模板 CreateMediaTemplate 接口中的 Request.TransConfig Container 否
AudioMix Request.Operation.Transcode 混音参数，详情见 AudioMix Container 数组 否

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 是

返回结果示例

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] => NjI2OGY4ZDdfZmNjYTNiMGAJODIJAOIDJAOMmVmNDU=
    [ContentType] => application/xml
    [ContentLength] => 1170
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/jobs
    [Response] => Array
        (
            [JobsDetail] => Array
                (
                    [Code] => Success
                    [CreationTime] => 2022-04-27T16:03:35+0800
                    [EndTime] => -
                    [Input] => Array
                        (
                            [BucketId] => examplebucket-1250000000
                            [Object] => video01.mp4
                            [Region] => ap-guangzhou
                        )

                    [JobId] => j89be22b8c60011ec9070fasd8a09d80a9b8
                    [Message] => 
                    [Operation] => Array
                        (
                            [DigitalWatermark] => Array
                                (
                                    [IgnoreError] => true
                                    [Message] => xxx
                                    [State] => Running
                                    [Type] => Text
                                    [Version] => V1
                                )

                            [Output] => Array
                                (
                                    [Bucket] => examplebucket-1250000000
                                    [Object] => SuperResolution.flv
                                    [Region] => ap-guangzhou
                                )

                            [TemplateId] => t19ea5e0c0b7b904a8sd09a8sd09a80sd10
                            [TemplateName] => SuperResolution-1
                            [TranscodeTemplateId] => t19ea5e0c0b7b904a8sd09a8sd09a80sd10
                            [WatermarkTemplateId] => t19ea5e0c0b7b904a8sd09a8asdasddsd10
                            [UserData] => xxx
                            [JobLevel] => 0
                        )

                    [QueueId] => p81e648af2aee49688570asd8a90sd6
                    [StartTime] => -
                    [State] => Submitted
                    [Tag] => SuperResolution
                )

        )

)

目录