对象存储
文档捉虫大赛：人工智能与机器学习专题> HOT
文档中心 > 对象存储 > SDK 文档 > PHP SDK > 模板接口 > 精彩集锦模板接口

精彩集锦模板接口

最近更新时间：2023-09-20 20:15:23

我的收藏

本页目录：

简介

本文档提供关于精彩集锦模板接口的 API 概览和 SDK 示例代码。
API
操作描述
用于新增精彩集锦模板
用于更新精彩集锦模板

新增精彩集锦模板

功能说明

用于新增精彩集锦模板。

方法原型

public Guzzle\\Service\\Resource\\Model createMediaVideoMontageTemplate(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/58314 新增精彩集锦模板
    $result = $cosClient->createMediaVideoMontageTemplate(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Tag' => 'VideoMontage',
        'Name' => 'VideoMontage-Template-Name',
        'Duration' => '',
        'Container' => array(
            'Format' => 'mp4',
        ),
        'Video' => array(
            'Codec' => 'H.264',
            'Width' => '',
            'Height' => '',
            'Fps' => '',
            'Bitrate' => '',
            'Crf' => '',
        ),
        'Audio' => array(
            'Codec' => 'aac',
            'Samplerate' => '',
            'Bitrate' => '',
            'Channels' => '',
            'Remove' => '',
        ),
        'AudioMix' => array(
            'AudioSource' => 'https://examplebucket-125000000.cos.ap-guangzhou.myqcloud.com/test01.mp3',
            'MixMode' => 'Once',
            'Replace' => 'true',
        ),
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}


参数说明

Request 中的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
限制
Tag
Request
模板类型: VideoMontage
String
是
无
Name
Request
模板名称 仅支持中文、英文、数字、_、-和*
String
是
无
Duration
Request
集锦时长
String
否
1. 默认自动分析时长
2. 单位为秒
3. 支持 float 格式，执行精度精确到毫秒
Container
Request
容器格式
Container
是
无
Video
Request
视频信息
Container
是
无
Audio
Request
音频信息
Container
否
无
AudioMix
Request
混音参数
Container
否
仅在 Audio.Remove 为 false 时生效
Container 类型 Container 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Format
Request.Container
容器格式：mp4、flv、hls、ts、mkv
String
是
设定 container，音频视频支持的格式如下表：
Container
Audio Codecs
Video Codecs
mp4/ts/hls/mkv
AAC、MP3
H.264、H.265
flv
AAC、MP3
H.264
Container 类型 Video 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
默认值
限制
Codec
Request.Video
编解码格式
String
否
H.264
1. H.264
2. 2. H.265
Width
Request.Video
宽
String
否
视频原始宽度
1. 值范围：[128，4096]
2. 单位：px
3. 若只设置 Width 时，按照视频原始比例计算 Height
4. 必须为偶数
Height
Request.Video
高
String
否
视频原始高度
1. 值范围：[128，4096]
2. 单位：px
3. 若只设置 Height 时，按照视频原始比例计算 Width
4. 必须为偶数
Fps
Request.Video
帧率
String
否
无
1. 值范围：(0，60]
2. 单位：fps
Bitrate
Request.Video
视频输出文件的码率
String
否
无
1. 值范围：[10，50000]
2. 单位：Kbps
Crf
Request.Video
码率-质量控制因子
String
否
无
1. 值范围：(0, 51]
2. 如果设置了 Crf，则 Bitrate 的设置失效
3. 当 Bitrate 为空时，默认为25
Container 类型 Audio 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
默认值
限制
Codec
Request.Audio
编解码格式
String
否
aac
取值 aac、mp3
Samplerate
Request.Audio
采样率
String
否
44100
1. 单位：Hz
2. 可选 11025、22050、32000、44100、48000、96000
3. 不同的封装，mp3 支持不同的采样率，如下表所示
Bitrate
Request.Audio
原始音频码率
String
否
无
1. 单位：Kbps
2. 值范围：[8，1000]
Channels
Request.Audio
声道数
String
否
无
1. 当 Codec 设置为 aac，支持1、2、4、5、6、8
2. 当 Codec 设置为 mp
3. 支持1、2
Remove
Request.Audio
是否删除音频流
String
否
false
取值 true、false
说明：
Y 表示支持这种采样率，N 表示不支持。
封装格式/音频采样率
11025
22050
32000
44100
48000
96000
flv
N
Y
N
Y
N
N
mp4
N
Y
Y
Y
Y
N
hls/ts/mkv
Y
Y
Y
Y
Y
N
Container 类型 AudioMix 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
必选
默认值
限制
AudioSource
Request.AudioMix
混音文件地址
String
是
无
需与 Input 媒体文件存储于同一 bucket
MixMode
Request.AudioMix
混音模式
String
否
Repeat
1. Repeat：背景音循环
2. Once：背景音一次播放
Replace
Request.AudioMix
是否用混音音轨媒体替换 Input 媒体文件的原音频
String
否
false
true/false

返回结果示例

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] => NjJhODZkNGRfZmNAOISUDOIASUDIOMjI0MzU=
    [ContentType] => application/xml
    [ContentLength] => 1115
    [Bucket] => examplebucket-125000000
    [Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/template
    [Response] => Array
        (
            [RequestId] => NjJhODZkNGRfZmNAOISUDOIASUDIOMjI0MzU=
            [Template] => Array
                (
                    [TemplateId] => t1107eb6ca4da547f3as8d90a8d067938
                    [Name] => VideoMontage-Template-Name
                    [State] => Normal
                    [Tag] => VideoMontage
                    [CreateTime] => 2022-06-14T19:13:17+0800
                    [UpdateTime] => 2022-06-14T19:13:17+0800
                    [BucketId] => examplebucket-125000000
                    [Category] => Custom
                    [VideoMontage] => Array
                        (
                            [Duration] => 10
                            [Container] => Array
                                (
                                    [Format] => mp4
                                )

                            [Video] => Array
                                (
                                    [Codec] => H.264
                                    [Bitrate] => 100
                                    [Width] => 400
                                    [Height] => 400
                                    [Fps] => 60
                                    [Crf] => 30
                                )

                            [Audio] => Array
                                (
                                    [Codec] => aac
                                    [Samplerate] => 11025
                                    [Bitrate] => 100
                                    [Channels] => 2
                                    [Remove] => false
                                )

                            [AudioMix] => Array
                                (
                                    [AudioSource] => https://examplebucket-125000000.cos.ap-guangzhou.myqcloud.com/test01.mp3
                                    [MixMode] => Once
                                    [Replace] => true
                                )

                        )

                )

        )

)

更新精彩集锦模板

功能说明

用于更新精彩集锦模板。

方法原型

public Guzzle\\Service\\Resource\\Model updateMediaVideoMontageTemplate(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/58311 更新精彩集锦模板
    $result = $cosClient->updateMediaVideoMontageTemplate(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key' => '', // TemplateId
        'Tag' => 'VideoMontage',
        'Name' => 'VideoMontage-Template-Name',
        'Duration' => '',
        'Container' => array(
            'Format' => 'mp4',
        ),
        'Video' => array(
            'Codec' => 'H.264',
            'Width' => '',
            'Height' => '',
            'Fps' => '',
            'Bitrate' => '',
            'Crf' => '',
        ),
        'Audio' => array(
            'Codec' => 'aac',
            'Samplerate' => '',
            'Bitrate' => '',
            'Channels' => '',
            'Remove' => '',
        ),
        'AudioMix' => array(
            'AudioSource' => 'https://examplebucket-125000000.cos.ap-guangzhou.myqcloud.com/test01.mp3',
            'MixMode' => 'Once',
            'Replace' => 'true',
        ),
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

Request 中的具体数据描述如下：
节点名称（关键字）
父节点
描述
Tag
Request
同精彩集锦模板 CreateMediaTemplate 接口中的 Request.Tag
Name
Request
同精彩集锦模板 CreateMediaTemplate 接口中的 Request.Name
Container
Request
同精彩集锦模板 CreateMediaTemplate 接口中的 Request.Container
Duration
Request
同精彩集锦模板 CreateMediaTemplate 接口中的 Request.Duration
Video
Request
同精彩集锦模板 CreateMediaTemplate 接口中的 Request.Video
Audio
Request
同精彩集锦模板 CreateMediaTemplate 接口中的 Request.Audio

返回结果示例

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] => NjJhODZlYTlfZmNjYTNiMGAUJSDOISDUoTQ=
    [ContentType] => application/xml
    [ContentLength] => 1116
    [Key] => t1107eb6ca4f3aas8d0as9d80938
    [Bucket] => examplebucket-125000000
    [Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/template/t1107eb6ca4f3aas8d0as9d80938
    [Response] => Array
        (
            [RequestId] => NjJhODZlYTlfZmNjYTNiMGAUJSDOISDUoTQ=
            [Template] => Array
                (
                    [TemplateId] => t1107eb6ca4f3aas8d0as9d80938
                    [Name] => VideoMontage-Template-Name-ss
                    [State] => Normal
                    [Tag] => VideoMontage
                    [CreateTime] => 2022-06-14T19:13:17+0800
                    [UpdateTime] => 2022-06-14T19:19:05+0800
                    [BucketId] => examplebucket-125000000
                    [Category] => Custom
                    [VideoMontage] => Array
                        (
                            [Duration] => 10
                            [Container] => Array
                                (
                                    [Format] => mp4
                                )

                            [Video] => Array
                                (
                                    [Codec] => H.264
                                    [Bitrate] => 100
                                    [Width] => 400
                                    [Height] => 400
                                    [Fps] => 60
                                    [Crf] => 30
                                )

                            [Audio] => Array
                                (
                                    [Codec] => aac
                                    [Samplerate] => 11025
                                    [Bitrate] => 100
                                    [Channels] => 2
                                    [Remove] => false
                                )

                            [AudioMix] => Array
                                (
                                    [AudioSource] => https://examplebucket-125000000.cos.ap-guangzhou.myqcloud.com/test01.mp3
                                    [MixMode] => Once
                                    [Replace] => true
                                )

                        )

                )

        )

)

中国站