调用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:AddRtsLiveStreamTranscode | create | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Domain | string | 是 | 主播流域名。 | example.com |
App | string | 是 | 播流所属应用名称。取值要求:
| aliyun-test |
Template | string | 是 | 转码模板自定义名称。取值要求:
说明
不能与标准的转码模板命名重复。
| ld |
TemplateType | string | 是 | 自定义转码模版类型。目前支持:
说明
如果选择 h264 或 h264-nbhd 或 h264-origin 类型,必须同时设置请求参数 Height,Width,FPS,VideoBitrate 和 DeleteBframes。
| h264 |
Height | integer | 否 | 转码视频高度。单位:像素。取值: 注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。
需要同时满足如下三个条件:
例如:1560×1560(正方形视频)是不合法的。 说明
原画模板由于需要保持片源的信息,分辨率最高支持到 4K。
| 1280 |
Width | integer | 否 | 转码视频宽度。单位:像素。取值: 注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。
需要同时满足如下三个条件:
例如:1560×1560(正方形视频)是不合法的。 说明
原画模板由于需要保持片源的信息,分辨率最高支持到 4K。
| 720 |
FPS | integer | 否 | 转码视频帧率。单位:FPS。取值:1~60。 注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。
| 30 |
VideoBitrate | integer | 否 | 转码视频比特率。单位:kbps。取值:1~6000。 注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。
说明
转码视频会尽量接近您所设定的比特率,但转码视频的实际比特率不能保证和您所设定的完全一致,尤其是当您设定的比特率过大或过小时。
| 2000 |
AudioBitrate | integer | 否 | 转码音频比特率。 单位:kbps。取值:1~1000。 注意 当 TemplateType(自定义转码模版类型)设为 audio 时,本参数必填。
| 128 |
Gop | string | 否 | 视频 GOP(Group of Picture)。主要用于控制关键帧间隔。单位:秒。取值:1~3。 | 2 |
DeleteBframes | boolean | 否 | 是否使用 B 帧进行转码。取值: 注意 当 TemplateType(自定义转码模版类型)设为 h264 或 h264-nbhd 或 h264-origin 时,本参数必填。
说明
不传参数时默认为 false。
| false |
Opus | boolean | 否 | 音频转码是否使用 opus 进行转码(主要用户兼容原生 webrtc 问题)。取值:
说明
不传参数时默认为 false。
| true |
Profile | integer | 否 | 编码级别。视频支持的一组特定的编码功能,一般值越大得到的画面质量越好,同时编解码消耗的资源也越高。取值:
| 2 |
AudioProfile | string | 否 | 音频编码级别。取值:
| aac_low |
AudioCodec | string | 否 | 音频编码器。取值:
说明
如果要使用 opus 编码,把 Opus 选项参数置为 true 即可。
| aac |
AudioRate | integer | 否 | 音频采样率。取值:22050~96000,其中 44100 比较常用。单位:Hz。 说明
如果音频编码 AudioProfile 是 aac_ld,则采样率不能超过 44100。
| 44100 |
AudioChannelNum | integer | 否 | 音频声道数。取值:
| 2 |
Lazy | string | 否 | 是否开启触发转码。取值:
| no |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidParameters | %s |
400 | ConfigAlreadyExists | %s |
400 | TemplateLimit | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
特殊错误码
错误代码 | 描述 | HTTP 状态码 | 语义 |
---|---|---|---|
InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 域名不存在或不属于当前用户。 |
IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作,如:非直播类域名。 |
InvalidParameters | Invalid parameters. | 400 | 参数不合法,如高度过大、比特率过大等。 |
ConfigAlreadyExists | Config has already exist. | 400 | 配置已添加。 |
InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |