1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
修改转码模板配置。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyLiveTranscodeTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TemplateId | 是 | Integer | 模板 Id。 示例值:1001 |
Vcodec | 否 | String | 视频编码:h264/h265/origin,默认origin。 origin: 保持原始编码格式 示例值:h265 |
Acodec | 否 | String | 音频编码:aac,默认aac。 注意:当前该参数未生效,待后续支持! 示例值:aac |
AudioBitrate | 否 | Integer | 音频码率,默认0。 范围:0-500。 示例值:600 |
Description | 否 | String | 模板描述。 示例值:transcode |
VideoBitrate | 否 | Integer | 视频码率。范围:0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。 示例值:1500 |
Width | 否 | Integer | 宽。0-3000。 数值必须是2的倍数,0是原始宽度 示例值:250 |
NeedVideo | 否 | Integer | 是否保留视频,0:否,1:是。默认1。 示例值:1 |
NeedAudio | 否 | Integer | 是否保留音频,0:否,1:是。默认1。 示例值:1 |
Height | 否 | Integer | 高。0-3000。 数值必须是2的倍数,0是原始宽度 示例值:240 |
Fps | 否 | Integer | 帧率,默认0。 范围0-60 示例值:30 |
Gop | 否 | Integer | 关键帧间隔,单位:秒。 范围2-6 示例值:3 |
Rotate | 否 | Integer | 旋转角度,默认0。 可取值:0,90,180,270 示例值:0 |
Profile | 否 | String | 编码质量: baseline/main/high。 示例值:main |
BitrateToOrig | 否 | Integer | 当设置的码率>原始码率时,是否以原始码率为准。 0:否, 1:是 默认 0。 示例值:0 |
HeightToOrig | 否 | Integer | 当设置的高度>原始高度时,是否以原始高度为准。 0:否, 1:是 默认 0。 示例值:0 |
FpsToOrig | 否 | Integer | 当设置的帧率>原始帧率时,是否以原始帧率为准。 0:否, 1:是 默认 0。 示例值:0 |
AdaptBitratePercent | 否 | Float | 极速高清视频码率压缩比。 极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent) 取值范围:0.0到0.5 示例值:1.1 |
ShortEdgeAsHeight | 否 | Integer | 是否以短边作为高度,0:否,1:是。默认0。 示例值:1 |
DRMType | 否 | String | DRM 加密类型,可选值:fairplay、normalaes、widevine。 不传递或者为空字符串,清空之前的DRM配置。 示例值:fairplay |
DRMTracks | 否 | String | DRM 加密项,可选值:AUDIO、SD、HD、UHD1、UHD2,后四个为一组,同组中的内容只能选一个。 不传递或者为空字符串,清空之前的DRM配置。 示例值:AUDIO|HD |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
ModifyLiveTranscodeTemplate 例子。
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLiveTranscodeTemplate
<公共请求参数>
{
"Profile": "main",
"AudioBitrate": "600",
"Rotate": "0",
"Description": "transcode",
"VideoBitrate": "1500",
"Vcodec": "h265",
"Height": "240",
"Width": "250",
"NeedAudio": "1",
"FpsToOrig": "0",
"Fps": "30",
"TemplateId": "1001",
"BitrateToOrig": "0",
"HeightToOrig": "0",
"NeedVideo": "1",
"Gop": "3",
"Acodec": "aac"
}
输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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.AiTranscodeOptionFail | 操作 AI 接口失败。 |
FailedOperation.NotFound | 找不到记录。 |
InternalError | 内部错误。 |
InternalError.ArgsNotMatch | 针对添加转码模版的接口。 |
InternalError.ConfInUsed | 模版使用中。 |
InternalError.ConfNotFound | 模版不存在。 |
InternalError.InvalidInput | 参数检校不通过。 |
InternalError.NotFound | 记录不存在。 |
InternalError.ProcessorAlreadyExist | 转码模板名称已经存在。 |
InternalError.RuleAlreadyExist | 规则已经配置。 |
InternalError.RuleInUsing | 规则使用中。 |
InternalError.RuleNotFound | 规则不存在。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ArgsNotMatch | 错误的模板名。 |
InvalidParameter.GopMustEqualAndExists | 自适应码率子模板gop值必须存在且相等。 |
InvalidParameter.ProcessorAlreadyExist | 转码模板已存在。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |