1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
即时转码已经提供了预置转码模板,满足大部分的需求。如果有个性化的转码需求,可以通过本接口创建自定义的转码模板,最多可创建100个自定义转码模板。
为了确保即时转码效果的一致性,避免因 EO 缓存或 M3U8 分片处理过程中的模板变更导致视频输出异常,模板在创建后不可进行修改。
即时转码详细能力了解:EdgeOne视频即时处理功能介绍。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateJustInTimeTranscodeTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点ID。 |
TemplateName | 是 | String | 即时转码模板名称,长度限制:64 个字符。 |
Comment | 否 | String | 模板描述信息,长度限制:256 个字符。默认为空。 |
VideoStreamSwitch | 否 | String | 启用视频流开关,取值: |
AudioStreamSwitch | 否 | String | 启用音频流开关,取值: |
VideoTemplate | 否 | VideoTemplateInfo | 视频流配置参数,当 VideoStreamSwitch 为 on,该字段必填。 |
AudioTemplate | 否 | AudioTemplateInfo | 音频流配置参数,当 AudioStreamSwitch 为 on,该字段必填。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TemplateId | String | 即时转码模板唯一标识,用于即时转码 URL 拼接。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建即时转码模板
创建即时转码模板。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateJustInTimeTranscodeTemplate
<公共请求参数>
{
"ZoneId": "zone-djuqmq",
"TemplateName": "myTemplate",
"Comment": "This is my template.",
"VideoStreamSwitch": "on",
"AudioStreamSwitch": "on",
"VideoTemplate": {
"Codec": "H.264",
"Bitrate": 2048,
"Fps": 25
},
"AudioTemplate": {
"Codec": "libfdk_aac",
"AudioChannel": 2
}
}
输出示例
{
"Response": {
"TemplateId": "C1LZ7982VgTpYhJ7M",
"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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ProductDiscontinued | 该产品即将下架,操作被拒绝。 |
FailedOperation.ProductNotActivated | 没有开通本产品,请开通后再尝试。 |
FailedOperation.TemplateOverLimit | 该站点下的模板数量超过最大数量限制。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.ZoneNotFound | 没有对应的站点,请确保站点信息填写正确。 |
InvalidParameterValue.ZonePaused | 站点已停用,请检查当前站点状态。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation | 未授权操作。 |