CreateCustomTemplate - 创建合流自定义模板

创建合流自定义模板。

接口说明

调用本接口创建好自定义模板后,请记录模板名。通过 CreateMixStream 接口创建合流任务时,MixStreamTemplate 传入模板名来使用自定义模板。

QPS 限制

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

调试

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

调试

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:CreateCustomTemplate

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

CustomTemplate

string

JSON 格式{height:xxx,scale:xxx,gop:xxx,bframes:xxx,cdesc:xxx},所有字段均必填,缺少其中任意字段会调用失败。

说明

具体参数请参考下表CustomTemplate 说明

{"height":"1060","scale":"[16:9]","gop":"60","bframes":"30","cdesc":"h264"}

Template

string

需要添加的模板名。

说明

请在创建时记录模板名,用于使用、查询和删除操作。

TestTemplate

CustomTemplate 说明

名称

类型

必选

描述

height

String

必选

输出分辨率的高。
scale 为 16:9 时最大支持 1920x1080。
scale 为 4:3 时最大支持 1440x1080 。

scale

String

必选

输出分辨率高宽比。只能接受 String 取值如下:
[3:4]
[4:3]
[16:9]
[9:16]



bframes

String

必选

输出流 b 帧数。取值需要大于 0 小于 9。

cdesc

String

必选

编码格式。只能取值 h264。

gop

String

必选

关键帧间隔。取值大于 25 小于 250。

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0D715397-2E66-4AE1-694h-C546628AD145

示例

正常返回示例

JSON格式

{
  "RequestId": "0D715397-2E66-4AE1-694h-C546628AD145"
}

错误码

HTTP status code

错误码

错误信息

描述

400 TemplateAlreadyExist %s
400 InvalidUserId.Malformed %s
400 InvalidParameter.Malformed %s
400 MissingParameter %s
400 CustomTemplateInvalid %s
500 InternalError %s
404 InvalidDomainName.NotFound %s

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

变更历史

更多信息,参考变更详情