全部产品
Search
文档中心

视频直播:AddRtsLiveStreamTranscode - 添加RTS自定义转码配置信息

更新时间:Dec 05, 2024

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

接口说明

使用说明

调用本接口添加 RTS 自定义转码配置信息,本接口目前只支持 h264、h264-nbhd、h264-origin、audio 四种自定义转码模版类型。

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:AddRtsLiveStreamTranscodecreate
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
Domainstring

主播流域名。

example.com
Appstring

播流所属应用名称。取值要求:

  • 该字段必须由大小写字母、数字、下划线(_)或短横线(-)组成。

  • 这些字符不必全含,建议取值大于 3 个字符,且字段的开头必须是字母(大小写)或数字。

aliyun-test
Templatestring

转码模板自定义名称。取值要求:

  • 该字段必须由大小写字母、数字、下划线(_)或短横线(-)组成。

  • 这些字符不必全含,建议取值大于 3 个字符,且字段的开头必须是字母(大小写)或数字。

说明 不能与标准的转码模板命名重复。
ld
TemplateTypestring

自定义转码模版类型。目前支持:

  • h264:自定义 H264 标准模版。
  • h264-nbhd:自定义 H264 窄带高清™模版。
  • h264-origin:原画 H264 标准模版,转码参数尽量保持和片源相同。
  • audio:纯音频转码模板,转码出来文件只有声音没有图像。如果选择 audio 类型,必须同时设置请求参数 AudioBitrate。
说明 如果选择 h264 或 h264-nbhd 或 h264-origin 类型,必须同时设置请求参数 Height,Width,FPS,VideoBitrate 和 DeleteBframes。
h264
Heightinteger

转码视频高度。单位:像素。取值:

注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。

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

  • Height ≥ 100:视频的高需要不小于 100 像素。
  • max(Height,Width)≤ 2560:视频的宽、高中较大的一个最大不能大于 2560。
  • min(Height,Width)≤ 1440:视频的宽、高中较小的一个最大不能大于 1440。

例如:1560×1560(正方形视频)是不合法的。

说明 原画模板由于需要保持片源的信息,分辨率最高支持到 4K。
1280
Widthinteger

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

注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。

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

  • Width≥ 100:视频的宽需要不小于 100 像素。
  • max(Height,Width)≤ 2560:视频的宽、高中较大的一个最大不能大于 2560。
  • min(Height,Width)≤ 1440:视频的宽、高中较小的一个最大不能大于 1440。

例如:1560×1560(正方形视频)是不合法的。

说明 原画模板由于需要保持片源的信息,分辨率最高支持到 4K。
720
FPSinteger

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

注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。

30
VideoBitrateinteger

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

注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。

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

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

注意 当 TemplateType(自定义转码模版类型)设为 audio 时,本参数必填。

128
Gopstring

视频 GOP(Group of Picture)。主要用于控制关键帧间隔。单位:秒。取值:1~3

2
DeleteBframesboolean

是否使用 B 帧进行转码。取值:

注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。

  • true:转码后的视频无 B 帧。

  • false:包含 B 帧,默认包含 B 帧。

说明 不传参数时默认为 false
false
Opusboolean

音频转码是否使用 opus 进行转码(主要用户兼容原生 webrtc 问题)。取值:

  • true:音频转码为 opus 格式。

  • false:不使用 opus 格式转码。

说明 不传参数时默认为 false
true
Profileinteger

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

  • 1:baseline(适合移动设备)。
  • 2:main(适合标准分辨率设备)。
  • 3:high(适合高分辨率设备)。
2
AudioProfilestring

音频编码级别。取值:

  • aac_low
  • aac_he
  • aac_he_v2
  • aac_ld
aac_low
AudioCodecstring

音频编码器。取值:

  • aac
  • mp3
说明 如果要使用 opus 编码,把 Opus 选项参数置为 true 即可。
aac
AudioRateinteger

音频采样率。取值:22050~96000,其中 44100 比较常用。单位:Hz。

说明 如果音频编码 AudioProfile 是 aac_ld,则采样率不能超过 44100。
44100
AudioChannelNuminteger

音频声道数。取值:

  • 1 :单声道。
  • 2:立体声。
2
Lazystring

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

  • yes:开启触发转码。
  • no:不开启触发转码。
no

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidParameters%s
400ConfigAlreadyExists%s
400TemplateLimit%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史

特殊错误码

错误代码描述HTTP 状态码语义
InvalidDomain.NotFoundThe domain provided does not exist in our records.404域名不存在或不属于当前用户。
IllegalOperationIllegal domain operate is not permitted.403不支持当前操作,如:非直播类域名。
InvalidParametersInvalid parameters.400参数不合法,如高度过大、比特率过大等。
ConfigAlreadyExistsConfig has already exist.400配置已添加。
InternalErrorThe request processing has failed due to some unknown error.500后台发生未知错误。