文档中心

更新转码配置

最近更新时间：2024.04.07 10:28:24

首次发布时间：2023.09.25 14:34:03

调用 UpdateTranscodePreset 接口，更新转码配置。

使用说明

更新转码配置后，AppName 下的直播流可通过添加转码流后缀使用转码配置，配置完成后约 3-5 分钟生效。
使用当前接口更新转码配置时，如果未填写非必选参数，则更新配置后该参数不会发生改变。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=UpdateTranscodePreset&Version=2023-01-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateTranscodePreset`	接口名称。当前 API 的名称为 `UpdateTranscodePreset`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Preset	String	是	`PresetName`	转码配置的名称。
Vhost	String	是	`push.example.com`	域名空间名称。
App	String	否	`live`	应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
SuffixName	String	否	`hd`	转码流后缀名。支持 10 个字符以内的大小写字母、下划线与中划线，常见后缀包括：_sd、_hd、_uhd。例如，配置的转码流后缀名为_hd，则拉转码流时转码的流名为 stream-123456789_hd。
VideoBitrate	Integer	否	`0`	视频码率，单位为 bps，默认值为 1000000；取 0 时，表示使用源流码率。配置不同的视频编码格式时，视频码率的取值范围存在如下差异。 H.264：取值范围为 [0,30000000]； H.265：取值范围为 [0,30000000]； H.266：取值范围为 [0,6000000]。
Vcodec	String	否	`h265`	视频编码格式，支持的取值及含义如下所示。 h264：使用 H.264 编码格式； h265：使用 H.265 编码格式； h266：使用 H.266 编码格式； copy：不进行转码，所有视频编码参数不生效。
AudioBitrate	Integer	否	`30`	音频码率，单位为 kbps。
Acodec	String	否	`aac`	音频编码格式，支持以下 3 种类型。 aac：使用 AAC 编码格式； copy：不进行转码，所有音频编码参数不生效； opus：使用 Opus 编码格式。
FPS	Integer	否	`60`	视频帧率，单位为 fps，默认值为 25，帧率越大，画面越流畅。配置不同视频编码格式时，视频帧率的取值存在如下差异。 H.264：取值范围为 [0,60]； H.265：取值范围为 [0,60]； H.266：取值范围为 [0,35]。
GOP	Integer	否	`4`	IDR 帧之间的最大间隔，单位为秒，默认值为 4，取值范围为 [1,20]。
Width	Integer	否	`1366`	视频宽度，默认值为 0。配置不同视频编码格式时，视频宽度的取值存在如下差异。 H.264：取值范围为 [150,1920]； H.265：取值范围为 [150,1920]。说明当 `As` 的取值为 0 即关闭宽高自适应时，转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸； Width 和 Height 任一配置为 0 时，转码视频将保持源流尺寸；编码格式为 H.266 时，不支持设置 Width 和 Height，请使用自适应配置。
Height	Integer	否	`768`	视频高度，默认值为 0。配置不同视频编码格式时，视频高度的取值存在如下差异。 H.264：取值范围为 [150,1920]； H.265：取值范围为 [150,1920]。说明当 `As` 的取值为 0 时，参数生效；反之则不生效；编码格式为 H.266 时，不支持设置 Width 和 Height，请使用自适应配置。
As	String	否	`1`	宽高自适应模式开关，默认值为 0。支持的取值及含义如下。 0：关闭宽高自适应 1：开启宽高自适应说明关闭宽高自适应时，转码配置分辨率取 `Width` 和 `Height` 的值对转码视频进行拉伸；开启宽高自适应时，转码配置分辨率按照 `ShortSide` 、 `LongSide` 、`Width` 、`Height` 的优先级取值，另一边等比缩放。修改 `As` 为 0 时，请确认 `Width` 和 `Height` 的取值是否超出阈值；修改 `As` 为 1 时，请确认 `ShortSide` 和 `LongSide` 的取值是否超出阈值。
ShortSide	Integer	否	`500`	短边长度，配置不同的视频编码方式和转码类型时，短边长度的取值范围存在如下差异。 `Roi` 取 false 时： H.264：取值范围为 0 和 [150,2160]； H.265：取值范围为 0 和 [150,4096]； H.266：取值范围为 0 和 [150,720]。 `Roi` 取 true 时： H.264：取值范围为 0 和 [150,1920]； H.265：取值范围为 0 和 [150,1920]。说明当 `As` 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。当 `As` 的取值为 1 时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 0，表示保持源流尺寸。
LongSide	Integer	否	`600`	长边长度，配置不同的视频编码方式和转码类型时，长边长度的取值范围存在如下差异。 `Roi` 取 false 时： H.264：取值范围为 0 和 [150,4096]； H.265：取值范围为 0 和 [150,7680]； H.266：取值范围为 0 和 [150,1280]。 `Roi` 取 true 时： H.264：取值范围为 0 和 [150,1920]； H.265：取值范围为 0 和 [150,1920]。说明当 `As` 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。当 `As` 的取值为 1 时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 0，表示保持源流尺寸。
BFrames	Integer	否	`3`	2 个参考帧之间的最大 B 帧数，默认值为 3。配置不同的视频编码格式时，最大 B 帧数的取值存在如下差异。 H.264：取值范围为 [0,7]； H.265：取值范围为 [0,3]、7、15； H.266：取值范围为 [0,3]、7、15。取值为 0 时，表示去除 B 帧。
Roi	Boolean	否	`true`	是否极智超清转码，取值及含义如下。 true：极智超清转码； false：标准转码。说明修改 `Roi` 为 true，且 `As` 为 1 时，请确认 `ShortSide` 和 `LongSide` 的取值是否超出阈值。视频编码格式为 H.266 时，转码类型不支持极智超清转码。
AutoTransResolution	Integer	否	`1`	是否开启转码不超过源流分辨率。开启后，当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时)，将按源流视频分辨率进行转码，默认开启。 0：关闭 1：开启
AutoTransVb	Integer	否	`1`	是否开启不超过源流码率。开启后，当源流码率低于转码配置码率时，将按照源流视频码率进行转码，默认开启。 0：关闭 1：开启
AutoTransVr	Integer	否	`1`	是否开启不超过源流帧率。开启后，当源流帧率低于转码配置帧率时，将按照源流视频帧率进行转码，默认开启。 0：关闭 1：开启
StopInterval	Integer	否	`60`	转码停止时长，支持触发方式为拉流转码时设置，表示断开拉流后转码停止的时长，单位为秒，取值范围为 -1 和 [0,300]，-1 表示不停止转码，默认值为 60。
TransType	String	否	`Pull`	转码触发方式，默认值为 Pull，支持的取值及含义如下。 Push：推流转码，直播推流后会自动启动转码任务，生成转码流； Pull：拉流转码，直播推流后，需要主动播放转码流才会启动转码任务，生成转码流。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=UpdateTranscodePreset&Version=2023-01-01
{
  "Preset": "PresetName",
  "Vhost": "push.example.com",
  "App": "live",
  "SuffixName": "hd"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateTranscodePreset",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.Preset	an internal error related to preset occurred, please contact the administrator.	出现与功能配置相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。