1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
创建用户自定义转码模板,数量上限:100。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTranscodeTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Container | 是 | String | 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a、wav。其中,mp3、flac、ogg、m4a、wav 为纯音频文件。 示例值:hls |
SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:123 |
Name | 否 | String | 转码模板名称,长度限制:64 个字符。 示例值:转码模板1 |
Comment | 否 | String | 模板描述信息,长度限制:256 个字符。 示例值:自定义模板1 |
RemoveVideo | 否 | Integer | 是否去除视频数据,可选值: 默认值:0。 示例值:0 |
RemoveAudio | 否 | Integer | 是否去除音频数据,可选值: 默认值:0。 示例值:0 |
VideoTemplate | 否 | VideoTemplateInfo | 视频流配置参数,当 RemoveVideo 为 0,该字段必填。 |
AudioTemplate | 否 | AudioTemplateInfo | 音频流配置参数,当 RemoveAudio 为 0,该字段必填。 |
TEHDConfig | 否 | TEHDConfig | 极速高清转码参数。 |
SegmentType | 否 | String | 切片类型,当 Container 为 hls 时有效,可选值: 默认值:ts。 示例值:ts |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Definition | Integer | 转码模板唯一标识。 示例值:1008 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建转码模板
创建转码模板
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTranscodeTemplate
<公共请求参数>
{
"RemoveVideo": "0",
"Container": "mp4",
"Name": "转码模板1",
"AudioTemplate": {
"SampleRate": "200",
"Codec": "libfdk_aac",
"Bitrate": "200"
},
"VideoTemplate": {
"Codec": "libx264",
"Bitrate": "256",
"Fps": "45"
},
"RemoveAudio": "0"
}
输出示例
{
"Response": {
"Definition": 1008,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.InvalidVodUser | 没有开通点播业务。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.AudioBitrate | 参数错误:音频流码率。 |
InvalidParameterValue.AudioChannel | 参数值错误:AudioChannel。 |
InvalidParameterValue.AudioCodec | 参数错误:音频流编码格式。 |
InvalidParameterValue.AudioSampleRate | 参数错误:音频流采样率。 |
InvalidParameterValue.Bitrate | 无效的音频/视频码率。 |
InvalidParameterValue.Codec | 无效的音频/视频编码格式。 |
InvalidParameterValue.Comment | 参数错误:对该模板的描述。 |
InvalidParameterValue.Container | 参数错误:封装格式。 |
InvalidParameterValue.FillType | 参数错误:填充方式错误。 |
InvalidParameterValue.Fps | 参数错误:视频帧率。 |
InvalidParameterValue.Height | 参数错误:高度。 |
InvalidParameterValue.Name | 参数值错误:Name 超过长度限制。 |
InvalidParameterValue.RemoveAudio | 参数值错误:RemoveAudio。 |
InvalidParameterValue.RemoveVideo | 参数值错误:RemoveVideo。 |
InvalidParameterValue.Resolution | 参数错误:分辨率错误。 |
InvalidParameterValue.ResolutionAdaptive | 无效的ResolutionAdaptive。 |
InvalidParameterValue.TEHDType | 参数值错误:TEHD Type 无效。 |
InvalidParameterValue.Type | Type 参数值错误。 |
InvalidParameterValue.Vcrf | 参数错误:vcrf。 |
InvalidParameterValue.VideoBitrate | 参数错误:视频流码率。 |
InvalidParameterValue.VideoCodec | 参数错误:视频流的编码格式。 |
InvalidParameterValue.Width | 参数错误:宽度。 |
LimitExceeded.TooMuchTemplate | 超过限制值:模板数超过上限 100 个,如需更多请提交工单。 |
UnauthorizedOperation | 未授权操作。 |