文档中心数据万象SDK 文档PHP SDK模板接口截图模板接口

截图模板接口

最近更新时间：2025-03-21 17:50:32

本页目录：

简介
本文档提供关于截图模板接口的 API 概览和 SDK 示例代码。
API
操作描述
﻿新增截图模板﻿
用于新增截图模板。
﻿更新截图模板﻿
用于更新截图模板。
新增截图模板
功能说明
用于新增截图模板。
方法原型
public Guzzle\\Service\\Resource\\Model createMediaSnapshotTemplate(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 {
    // 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
模板名称，仅支持中文、英文、数字、_、-和*，长度不超过 64
String
是
Snapshot
Request
截图参数
Container
是
Container 类型 Snapshot
 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Mode
Request.Snapshot
截图模式
值范围：{Interval, Average, KeyFrame}
Interval 表示间隔模式，Start，TimeInterval，Count 参数生效。当设置 Count，未设置 TimeInterval 时，表示截取所有帧，共Count张图片
Average 表示平均模式，Start，Count参数生效。表示从 Start 开始到视频结束，按平均间隔截取共 Count 张图片
KeyFrame 表示关键帧模式
String
Interval
否
Start
Request.Snapshot
开始时间
[0 视频时长] 
单位为秒 
支持 float 格式，执行精度精确到毫秒
String
0
否
TimeInterval
Request.Snapshot
截图时间间隔
(0 3600] 
单位为秒 
支持 float 格式，执行精度精确到毫秒
String
无
否
Count
Request.Snapshot
截图数量，取值范围 (0，10000]
String
无
是
Width
Request.Snapshot
宽
值范围：[128，4096]
单位：px
若只设置 Width 时，按照视频原始比例计算 Height
String
视频原始宽度
否
Height
Request.Snapshot
高
值范围：[128，4096]
单位：px
若只设置 Height 时，按照视频原始比例计算 Width
String
视频原始高度
否
返回结果示例
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());
请求示例
<?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 {
    // 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 中的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
必选
Key
无
模版 ID
String
是
Request
无
﻿同创建截图模板接口的 Request﻿
Container
是
返回结果示例
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
)
﻿

上一篇: 动图模板接口下一篇: 水印模板接口

目录