AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 视频直播 开发参考 API参考 API目录 直播转码 AddCustomLiveStreamTranscode - 添加自定义转码配置信息

AddCustomLiveStreamTranscode - 添加自定义转码配置信息

更新时间：
产品详情
我的收藏

调用AddCustomLiveStreamTranscode添加自定义转码配置信息。

接口说明

本接口目前支持以下自定义转码模版类型，取值：

  • h264：自定义 H264 标准模版。

  • h264-nbhd：自定义 H264 窄带高清™模版。

  • h265：自定义 H265 标准模版。

  • h265-nbhd：自定义 H265 窄带高清模版。

  • audio：纯音频模板。

QPS 限制

本接口的单用户 QPS 限制为 6000 次/分钟。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:AddCustomLiveStreamTranscode

create

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

 无 无

请求参数

名称

类型

必填

描述

示例值
Domain

string

是

主播流域名。

example.com
App

string

是

播流所属应用名称。

liveApp****
KmsKeyID

string

否

用户 KMS 主密钥 ID。

afce5722-81d2-43c3-9930-7601da11****
KmsUID

string

否

用户 KMS 主账号 ID。

25346073170691****
KmsKeyExpireInterval

string

否

换 Key 周期。取值范围：60~3600，单位：秒。

3600
Template

string

是

转码模板自定义名称。

说明

支持数字、大小写字母或短横线（-），且字段必须以大小写字母或数字开头，不能与标准的转码模板命名重复。

LiveCusTranscode****
TemplateType

string

是

自定义转码模版类型。取值：

  • h264：自定义 H264 标准模版。

  • h264-nbhd：自定义 H264 窄带高清™模版。

  • h265：自定义 H265 标准模版。

  • h265-nbhd：自定义 H265 窄带高清模版。

  • audio：纯音频模板。

说明

TemplateType 取值为视频类型时（例如 h264、h264-nbhd、h265 或 h265-nbhd），请求参数 Height、Width、FPS 和 VideoBitrate 的值必须填写。

h264
Height

integer

否

转码视频高度。单位：像素。取值： 需要同时满足如下三个条件：

  • Height ≥ 100：视频的高需要不小于 100 像素。

  • max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于 2560。

  • min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于 1440。

说明

265 窄带高清模板不得超过 1280×720。

720
Width

integer

否

转码视频宽度。单位：像素。取值：

需要同时满足如下三个条件：

  • Width ≥ 100：视频的宽需要不小于 100 像素。

  • max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于 2560。

  • min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于 1440。

说明

265 窄带高清模板不得超过 1280×720。

576
FPS

integer

否

转码视频帧率。单位：FPS，取值：1~60。

30
VideoBitrate

integer

否

转码视频比特率。单位：kbps，取值：1~6000。

说明

转码视频会尽量接近您所设定的比特率，但转码视频的实际比特率不能保证和您所设定的完全一致，尤其是当您设定的比特率过大或过小时。

720
AudioBitrate

integer

否

转码音频比特率。单位：kbps，取值：1~1000。

512
Gop

string

否

视频 GOP（Group of Picture），单位可选帧或者秒。

  • 单位：帧，取值：1~3000。例如：设置 GOP 为 2 帧，则此参数传入 2。

  • 单位：秒，取值：1s~20s。例如：设置 GOP 为 1 秒，则此参数传入 1s。

1
Profile

integer

否

编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：

  • 1：baseline（适合移动设备）。

  • 2：main（适合标准分辨率设备）。

  • 3：high（适合高分辨率设备）。

2
AudioProfile

string

否

音频编码。取值：

  • aac_low

  • aac_he

  • aac_he_v2

  • aac_ld

aac_low
AudioCodec

string

否

音频编码格式。取值：

  • AAC

  • MP3

AAC
AudioRate

integer

否

音频采样率。取值：22050~96000。

重要

如果 AudioProfile 取值为aac_ld，则采样率不能超过 44100。

96000
AudioChannelNum

integer

否

音频声道数。取值

  • 1：单声道。

  • 2：双声道。

2
Lazy

string

否

是否开启触发转码。取值：

  • yes：开启触发转码。

  • no：不开启触发转码。

yes
EncryptParameters

string

否

加密配置。JSON 格式，各字段说明如下：

  • EncryptType：加密类型。固定取值 aliyun。

  • KmsKeyID：用户 KMS 主密钥 ID。

  • KmsKeyExpireInterval：换 Key 周期。取值范围：60~3600，单位：秒。

说明

EncryptParameters 参数若配置，则 KmsKeyID、KmsUID、KmsKeyExpireInterval 参数不能为空

{"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}
ResWithSource

string

否

分辨率随源配置，若设置了该字段，分辨率以该字段为主。包含的字段如下：

  • Type string （必须添加）：只可以传 short （短边自适应）、long（长边自适应） 、screen（横竖屏自适应） 。

  • Value string（必须添加）：

    • 短边自适应取值可选：360、480、540、720、1080。

    • 长边自适应取值可选：640、848、960、1280、1920。

    • 横竖屏自适应取值可选：640*360、848*480、960*540、1280*720、1920*1080。

{"Type":"short","Value":"1080"}
FpsWithSource

string

否

帧率随源配置，若设置了该字段，帧率以该字段为主。包含的字段如下：

  • UpLimit int（必须添加）：帧率上限，输入范围 1-60 的整数，且大于帧率下限。

  • LowerLimit int （必须添加）：帧率下限，输入范围 1-60 的整数，且小于帧率上限。

{"UpLimit":60,"LowerLimit":1}
BitrateWithSource

string

否

码率随源配置，若设置了该字段，码率以该字段为主。包含的字段如下：

  • UpLimit int（必须添加）：码率上限，输入范围 128-10000 的整数，且大于码率下限。

  • LowerLimit int （必须添加）：码率下限，输入范围 128-10000 的整数，且小于码率上限。

  • Factor float （必须添加）：按源码率输出倍率，输入范围 0.1-1，精确至小数点后一位，“1”为按源流输出。

{"UpLimit":2500,"LowerLimit":800,"Factor":1}
ExtWithSource

string

否

其他随源配置，包含的字段如下：

  • KeyFrameOpen：关键帧随源是否开启，开启后，转码输出流关键帧与原始流关键帧一致。取值 yes 或 no。

  • Copyts string ：pts 随源是否开启，开启后，转码输出流 pts 与原始流 pts 一致。取值 yes 或 no。

  • SeiMode ：透传 sei 模式。取值有 0（不透传）、 1（全部透传）。

{"KeyFrameOpen":"yes","Copyts":"yes","SeiMode":1}

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F****

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

异常返回示例

JSON格式

{
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidParameters %s
400 ConfigAlreadyExists %s
400 TemplateLimit %s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：AddLiveStreamTranscode - 添加转码配置信息下一篇：AddRtsLiveStreamTranscode - 添加RTS自定义转码配置信息