简介
本文档提供关于截图模板接口的 API 概览和 SDK 示例代码。
新增截图模板
功能说明
用于新增截图模板。
方法原型
public Guzzle\\Service\\Resource\\Model createMediaSnapshotTemplate(array $args = array());
请求示例
<?phprequire 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,'scheme' => 'https', //协议头部,默认为http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {// https://cloud.tencent.com/document/product/436/54029 新增截图模板$result = $cosClient->createMediaSnapshotTemplate(array('Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Tag' => 'Snapshot','Name' => 'Snapshot-Template-Name','Snapshot' => array('Mode' => '','Start' => '','TimeInterval' => '','Count' => '','Width' => '','Height' => '',),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 模板类型:Snapshot | String | 是 |
Name | Request | 模板名称仅支持中文、英文、数字、_、-和* | String | 是 |
Snapshot | Request | 截图 | Container | 是 |
Container 类型 Snapshot 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Mode | Request.Snapshot | 截图模式 | String | 否 | Interval | 值范围:{Interval, Average} Interval:表示间隔模式,Average:表示平均模式 Interval 模式:Start,TimeInterval, Count 参数生效。当设置 Count,未设置 TimeInterval 时, 表示截取所有帧,共 Count 张图片 Average 模式:Start,Count 参数生效。表示 从 Start 开始到视频结束,按平均间隔截取共 Count 张图片 |
Start | Request.Snapshot | 开始时间 | String | 否 | 0 | [0 视频时长]单位为秒支持 float 格式,执行精度精确到毫秒 |
TimeInterval | Request.Snapshot | 截图时间间隔 | String | 否 | 无 | (0 3600]单位为秒支持 float 格式,执行精度精确到毫秒 |
Count | Request.Snapshot | 截图数量 | String | 是 | 无 | (0 10000] |
Width | Request.Snapshot | 宽 | String | 否 | 视频原始宽度 | 值范围:[128,4096] 单位:px 若只设置 Width 时,按照视频原始比例计算 Height |
Height | Request.Snapshot | 高 | String | 否 | 视频原始高度 | 值范围:[128,4096] 单位:px 若只设置 Height 时,按照视频原始比例计算 Width |
返回结果示例
GuzzleHttp\\Command\\Result Object([RequestId] => NjJhODMwYWZfNzgwYzAIUSIODZCHIOUHDIMGQ5ZjI=[ContentType] => application/xml[ContentLength] => 879[Template] => Array([State] => Normal[BucketId] => examplebucket-125000000[Category] => Custom[Tag] => Snapshot[Name] => Snapshot-Template-Name[TemplateId] => t11c298b96a8zxc890z8c90z8c09699[UpdateTime] => 2022-06-14T14:54:39+0800[CreateTime] => 2022-06-14T14:54:39+0800[Snapshot] => Array([IsCheckCount] => false[BlackLevel] => 0[PixelBlackThreshold] => 0[IsCheckBlack] => false[SnapshotOutMode] => OnlySnapshot[Mode] => Interval[Start] => 0[TimeInterval] => 3[Count] => 10[Width] => 400[Height] => 400))[Bucket] => examplebucket-125000000[Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/template)
更新截图模板
功能说明
用于更新截图模板。
方法原型
public Guzzle\\Service\\Resource\\Model updateMediaSnapshotTemplate(array $args = array());
请求示例
<?phprequire 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,'scheme' => 'https', //协议头部,默认为http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {// https://cloud.tencent.com/document/product/436/54032 更新截图模板$result = $cosClient->updateMediaSnapshotTemplate(array('Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Key' => '', // TemplateId'Tag' => 'Snapshot','Name' => 'Snapshot-Template-Name','Snapshot' => array('Mode' => '','Start' => '','TimeInterval' => '','Count' => '','Width' => '','Height' => '',),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 |
Tag | Request | 模板类型:Snapshot | String | 是 |
Name | Request | 模板名称仅支持中文、英文、数字、_、-和* | String | 是 |
Snapshot | Request | 截图 | Container | 否 |
Container 类型 Snapshot 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 | 默认值 | 限制 |
Mode | Request.Snapshot | 截图模式 | String | 是 | Interval | 值范围:{Interval, Average}
Interval 表示间隔模式,Average 表示平均模式 Interval 模式:Start,TimeInterval,Count 参数 生效。当设置 Count,未设置 TimeInterval 时,表示 截取所有帧,共 Count 张图片 Average 模式:Start,Count 参数生效。表示 从 Start 开始到视频结束,按平均间隔截取共 Count 张图片 |
Start | Request.Snapshot | 开始时间 | String | 是 | 0 | [0 视频时长]单位为秒支持 float 格式,执行精度精确到毫秒 |
TimeInterval | Request.Snapshot | 截图时间间隔 | String | 否 | 无 | (0 3600]单位为秒支持 float 格式,执行精度精确到毫秒 |
Count | Request.Snapshot | 截图数量 | String | 是 | 无 | (0 10000] |
Width | Request.Snapshot | 宽 | String | 否 | 视频原始宽度 | 值范围:[128,4096]
单位:px
若只设置 Width 时,按照视频原始比例计算 Height |
Height | Request.Snapshot | 高 | String | 否 | 视频原始高度 | 值范围:[128,4096]
单位:px
若只设置 Height 时,按照视频原始比例计算 Width |
返回结果示例
GuzzleHttp\\Command\\Result Object([RequestId] => NjJhODMxYjFfZmNjYTNASHCU67JCIOZJmQ=[ContentType] => application/xml[ContentLength] => 881[Template] => Array([State] => Normal[BucketId] => examplebucket-125000000[Category] => Custom[Tag] => Snapshot[Name] => Snapshot-Template-Name[TemplateId] => t11c298b96azx9c8z9x08c0z98c09699[UpdateTime] => 2022-06-14T14:58:57+0800[CreateTime] => 2022-06-14T14:54:39+0800[Snapshot] => Array([IsCheckCount] => false[BlackLevel] => 0[PixelBlackThreshold] => 0[IsCheckBlack] => false[SnapshotOutMode] => OnlySnapshot[Mode] => Interval[Start] => 0[TimeInterval] => 3[Count] => 10[Width] => 400[Height] => 400))[Key] => t11c298b96azx9c8z9x08c0z98c09699[Bucket] => examplebucket-125000000[Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/template/t11c298b9f976f4f6a86f6d506f17b9699)