tencent cloud

云直播

动态与公告
公告
新手指南
产品简介
产品概述
子产品简介
基本概念
产品功能
应用场景
产品优势
使用限制
购买指南
计费概述
基础服务费
增值服务费
预付费资源包
购买流程
计费变更
退款说明
账单查询
续费说明
欠费停服说明
计费常见问题
标准直播
概述
应用场景
快速入门
SDK 接入说明
快直播(超低延时直播)
概述
快直播和标准直播区别
应用场景
快速入门
SDK 接入说明
云导播台
概述
应用场景
功能区介绍
云导播台管理
通用云导播
配置节目单和自动导播
控制台指南
控制台介绍
概览
域名管理
流管理
资源包管理
AI 智能
功能配置
拉流转推
计费用量
业务监控
常用工具
无忧直播
CAM 访问控制
功能实践
直播推流与播放
直播增值功能
典型场景实践
云端原生录制
直播安全
海外直播
回调事件消息通知
常见第三方工具指南
SDK 实践
0. SDK 接入引导
1. 推流
2. 播放
3. 高级功能
API 文档
History
Introduction
API Category
Making API Requests
Live Pad APIs
Live Stream Mix APIs
Time Shifting APIs
Monitoring Data Query APIs
Billing Data Query APIs
Live Transcoding APIs
Delayed Playback Management APIs
Domain Name Management APIs
Watermark Management APIs
Certificate Management APIs
Stream Pulling APIs
Recording Management APIs
Live Callback APIs
Screencapturing and Porn Detection APIs
Authentication Management APIs
Live Stream Management APIs
Data Types
Error Codes
运维指南
优化视频卡顿
推流失败问题排查
播放失败问题排查
CLS 协助直播问题排查
直播延迟问题排查
拉流视频质量不清晰问题排查
COS bucket 授权给直播实现截图存储
故障处理
直播混流报错:InvalidParameter.OtherError
常见问题
服务地区相关
直播基础相关
推流播放相关
直播计费相关
直播海外相关
直播录制相关
云端混流相关
域名配置相关
云导播台相关
适配苹果 ATS 相关
服务等级协议
云直播服务等级协议
CSS 政策
隐私协议
数据处理和安全协议
词汇表

ModifyLiveTranscodeTemplate

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:48:20

1. API Description

Domain name for API request: live.intl.tencentcloudapi.com.

This API is used to modify the transcoding template configuration.

A maximum of 200 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyLiveTranscodeTemplate.
Version Yes String Common Params. The value used for this API: 2018-08-01.
Region No String Common Params. This parameter is not required for this API.
TemplateId Yes Integer Template ID.
Vcodec No String Video codec. Valid values: h264, h265, origin (default)

origin: original codec as the output codec
Acodec No String Audio codec. Defaut value: aac.
Note: this parameter is unsupported now.
AudioBitrate No Integer Audio bitrate. Default value: 0.
Value range: 0-500.
Description No String Template description.
VideoBitrate No Integer Video bitrate in Kbps. Value range: 100-8000.
Note: the transcoding template requires that the bitrate be unique. Therefore, the final saved bitrate may be different from the input bitrate.
Width No Integer Width in pixels. Value range: 0-3000.
It must be a multiple of 2. The original width is 0.
NeedVideo No Integer Whether to keep the video. 0: no; 1: yes. Default value: 1.
NeedAudio No Integer Whether to keep the audio. 0: no; 1: yes. Default value: 1.
Height No Integer Height in pixels. Value range: 0-3000.
It must be a multiple of 2. The original height is 0.
Fps No Integer Frame rate in fps. Default value: 0.
Value range: 0-60
Gop No Integer Keyframe interval in seconds.
Value range: 2-6
Rotate No Integer Rotation angle. Default value: 0.
Valid values: 0, 90, 180, 270
Profile No String Encoding quality:
baseline/main/high.
BitrateToOrig No Integer Whether to use the original bitrate when the set bitrate is larger than the original bitrate.
0: no, 1: yes
Default value: 0.
HeightToOrig No Integer Whether to use the original height when the set height is higher than the original height.
0: no, 1: yes
Default value: 0.
FpsToOrig No Integer Whether to use the original frame rate when the set frame rate is larger than the original frame rate.
0: no, 1: yes
Default value: 0.
AdaptBitratePercent No Float Bitrate compression ratio of top speed codec video.
Target bitrate of top speed code = VideoBitrate * (1-AdaptBitratePercent)

Value range: 0.0-0.5.
ShortEdgeAsHeight No Integer Whether to use the short side as the video height. 0: no, 1: yes. Default value: 0.
DRMType No String The DRM encryption type. Valid values: fairplay, normalaes, widevine.
If you do not pass this parameter or pass in an empty string, the existing configuration will be reset.
DRMTracks No String The tracks to encrypt. Valid values: AUDIO, SD, HD, UHD1, UHD2. You can choose only one video track (SD, HD, UHD1, or UHD2).
If you do not pass this parameter or pass in an empty string, the existing configuration will be reset.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying a transcoding template

This example shows you how to modify a transcoding template.

Input Example

POST / HTTP/1.1
Host: live.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLiveTranscodeTemplate
<Common request parameters>

{
    "Profile": "main",
    "AudioBitrate": "600",
    "Rotate": "0",
    "Description": "test",
    "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"
}

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.AiTranscodeOptionFail Failed to manipulate the AI API.
FailedOperation.NotFound No records found.
InternalError Internal error.
InternalError.ArgsNotMatch For the transcoding template adding API.
InternalError.ConfInUsed The template is in use.
InternalError.ConfNotFound The template does not exist.
InternalError.InvalidInput Parameter check failed.
InternalError.NotFound The record does not exist.
InternalError.ProcessorAlreadyExist The transcoding template name already exists.
InternalError.RuleAlreadyExist The rule has already been configured.
InternalError.RuleInUsing The rule is in use.
InternalError.RuleNotFound The rule does not exist.
InvalidParameter Invalid parameter.
InvalidParameter.ArgsNotMatch Incorrect template name.
InvalidParameter.GopMustEqualAndExists The GOP of an adaptive bitrate template is required and must be the same for each stream.
InvalidParameter.ProcessorAlreadyExist Transcoding template already exists.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.
ResourceNotFound.ForbidService You are blocked.
ResourceNotFound.FreezeService Service suspended.
ResourceNotFound.StopService The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
ResourceNotFound.UserDisableService You disabled the service.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈