简介
本文档提供关于视频质量评分任务接口的 API 概览和 SDK 示例代码。
API | 操作描述 |
提交视频质量评分任务 |
提交视频质量评分任务
功能说明
提交一个视频质量分析任务。
方法原型
public Guzzle\\Service\\Resource\\Model createMediaQualityEstimateJobs(array $args = array());
请求示例
<?phprequire dirname(__FILE__, 2) . '/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 {// 提交视频质量评分任务 https://cloud.tencent.com/document/product/460/76906$result = $cosClient->createMediaQualityEstimateJobs(array('Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Tag' => 'QualityEstimate','Input' => array('Object' => 'test.mp4',),'Operation' => array('UserData' => 'xxx', // 透传用户信息'JobLevel' => '0', // 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0'QualityEstimateConfig' => array('Rotate' => '','Mode' => '',),),// 'CallBack' => 'http://xxx.com/callback',// 'CallBackFormat' => 'JSON',// 'CallBackType' => '',// 'CallBackMqConfig' => array(// 'MqRegion' => '',// 'MqMode' => '',// 'MqName' => '',// ),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:QualityEstimate | String | 是 |
Input | Request | 待操作的文件信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件路径 | String | 是 |
Container 类型
Operation
的具体数据描述如下:节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
QualityEstimateConfig | Request.Operation | 质量评分配置 | Container | 否 |
UserData | Request.Operation | 透传用户信息,可打印的 ASCII 码 ,长度不超过1024 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 |
Container 类型
Operation
的具体数据描述如下:节点名称(关键字) | 父节点 | 描述 | 类型 | 默认值 | 是否必选 |
Rotate | Request.Operation.QualityEstimateConfig | 旋转角度,只支持 0,90,180,270 | String | 0 | 否 |
Mode | Request.Operation.QualityEstimateConfig | 分析模式 general: 普通分析, 只返回视频质量分数 vqaPlus: 返回更详细的分析结果 设置为vqaPlus时,Rotate 参数无效 | String | general | 否 |
返回结果示例
GuzzleHttp\\Command\\Result Object([Body] => GuzzleHttp\\Psr7\\Stream Object([stream:GuzzleHttp\\Psr7\\Stream:private] => Resource id #89[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] => NjRjNjRjMjIxODBfMzUxNGSIOJOIDAJOIDg=[ContentType] => application/xml[ContentLength] => 750[Bucket] => examplebucket-1250000000[Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/jobs[Response] => Array([JobsDetail] => Array([Code] => Success[CreationTime] => 2023-08-03T15:20:18+0800[EndTime] => -[Input] => Array([BucketId] => examplebucket-1250000000[Object] => test01.mp4[Region] => ap-guangzhou)[JobId] => j32d5epc7a00f19asf798sd7f89s7f2e646[Message] => Array()[Operation] => Array([JobLevel] => 0[QualityEstimateConfig] => Array([Mode] => vqaPlus[Rotate] => 90)[UserData] => xxx)[QueueId] => pc6f4dpc7a00f19asf798sd7f89s7f2e646[StartTime] => -[State] => Submitted[Tag] => QualityEstimate)))