创建转码模板

最近更新时间:2020-09-15 08:05:27

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

创建转码模板,成功返回模板id后,需要调用CreateLiveTranscodeRule接口,将返回的模板id绑定到流使用。
转码相关文档:直播转封装及转码

默认接口请求频率限制:200次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateLiveTranscodeTemplate。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
TemplateName String 模板名称,例:900 900p 仅支持字母和数字的组合。
长度限制:
标准转码:1-10个字符
极速高清转码:3-10个字符
VideoBitrate Integer 视频码率。范围:0kbps - 8000kbps。
0为保持原始码率。
注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。
Acodec String 音频编码:aac,默认aac。
注意:当前该参数未生效,待后续支持!
AudioBitrate Integer 音频码率,默认0。
范围:0-500。
Vcodec String 视频编码:h264/h265/origin,默认h264。

origin: 保持原始编码格式
Description String 模板描述。
Width Integer 宽,默认0。
范围[0-3000]
数值必须是2的倍数,0是原始宽度
NeedVideo Integer 是否保留视频,0:否,1:是。默认1。
NeedAudio Integer 是否保留音频,0:否,1:是。默认1。
Height Integer 高,默认0。
范围[0-3000]
数值必须是2的倍数,0是原始宽度
Fps Integer 帧率,默认0。
范围0-60fps
Gop Integer 关键帧间隔,单位:秒。
默认原始的间隔
范围2-6
Rotate Integer 旋转角度,默认0。
可取值:0,90,180,270
Profile String 编码质量:
baseline/main/high。默认baseline
BitrateToOrig Integer 当设置的码率>原始码率时,是否以原始码率为准。
0:否, 1:是
默认 0。
HeightToOrig Integer 当设置的高度>原始高度时,是否以原始高度为准。
0:否, 1:是
默认 0。
FpsToOrig Integer 当设置的帧率>原始帧率时,是否以原始帧率为准。
0:否, 1:是
默认 0。
AiTransCode Integer 是否是极速高清模板,0:否,1:是。默认0。
AdaptBitratePercent Float 极速高清视频码率压缩比。
极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent)

取值范围:0.0到0.5
ShortEdgeAsHeight Integer 是否以短边作为高度,0:否,1:是。默认0。

3. 输出参数

参数名称 类型 描述
TemplateId Integer 模板Id。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://live.tencentcloudapi.com/?Action=CreateLiveTranscodeTemplate
&Vcodec=h264
&Acodec=aac
&AudioBitrate=500
&TemplateName=900m
&Description=test
&VideoBitrate=900
&Width=250
&NeedVideo=1
&NeedAudio=1
&Height=250
&Fps=30
&Gop=3
&Rotate=0
&Profile=main
&BitrateToOrig=0
&HeightToOrig=0
&FpsToOrig=0
&<公共请求参数>

输出示例

{
  "Response": {
    "TemplateId": 1000,
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.ArgsNotMatch 针对添加转码模版的接口。
InternalError.ConfInUsed 模版使用中。
InternalError.ConfNotFound 模版不存在。
InternalError.ConfOutLimit 模版数量超过显示。
InternalError.InvalidInput 参数检校不通过。
InternalError.NotFound 记录不存在。
InternalError.ProcessorAlreadyExist 转码模板名称已经存在。
InternalError.RuleAlreadyExist 规则已经配置。
InternalError.RuleInUsing 规则使用中。
InternalError.RuleNotFound 规则不存在。
InternalError.RuleOutLimit 规则超过限制。
InvalidParameter 参数错误。
InvalidParameter.ArgsNotMatch 错误的模板名。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
目录