提交任务

最近更新时间:2024-07-15 14:57:01

我的收藏

简介

本文档提供关于视频明水印-提交任务的相关 API 概览以及 SDK 示例代码。
API
操作描述
提交一个视频明水印任务

提交任务

功能说明

提交一个视频明水印任务。

示例代码

<?php

require 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,
'scheme' => 'https', // 审核时必须为https
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));
try {
//提交一个视频明水印任务
$result = $cosClient->PostWatermarkJobs(array(
'Bucket' => 'test-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket 'Headers' => array(
'Content-Type' => 'application/xml',
),
'Tag'=> 'Watermark', // 创建任务的Tag:Watermark;是否必传:是
// 待操作的文件信息;是否必传:是
'Input'=> array(
'Object'=> '', // 待处理的文件路径;是否必传:是
),
// 操作规则;是否必传:是
'Operation'=> array(
'WatermarkTemplateId'=> 'xxx', // 水印模板 ID,可以传多个水印模板 ID ,最多传3个;是否必传:否
'UserData'=> '', // 透传用户信息,可打印的 ASCII 码,长度不超过1024。;是否必传:否
'JobLevel'=> '', // 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0;是否必传:否
'Output' => array( 'Region' => 'ap-beijing', 'Bucket' => 'test-1250000000', 'Object' => 'testWatermark.mp4', ),
),
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo($e);
}

参数说明

参数名称
参数描述
类型
是否必填
Tag
创建任务的Tag:Watermark
string
Input
待操作的文件信息
Container
Operation
操作规则
Container
CallBackFormat
任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式
string
CallBackType
任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型
string
CallBack
任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调
string
CallBackMqConfig
任务回调TDMQ配置,当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig
Container

Input 的具体数据描述如下:

参数名称
参数描述
类型
是否必填
Object
待处理的文件路径
string

Operation 的具体数据描述如下:

参数名称
参数描述
类型
是否必填
WatermarkTemplateId
水印模板 ID,可以传多个水印模板 ID ,最多传3个
string Array
Watermark
水印模板参数,同创建水印模板接口中的 Request.Watermark,最多传3个
Container Array
Output
结果输出配置
Container
UserData
透传用户信息,可打印的 ASCII 码,长度不超过1024。
string
JobLevel
任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0
string

Output 的具体数据描述如下:

参数名称
参数描述
类型
是否必填
Region
存储桶的地域
string
Bucket
存储结果的存储桶
string
Object
输出结果的文件名
string
Request.Operation.Output.Object 支持的通配符如下:
通配符
含义
${ext}
封装格式
${jobid}
任务Id

返回参数说明

具体返回参数请参见 提交任务 接口。