创建 RTC 3.0 应用推流模板。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rtc:CreateAppStreamingOutTemplate | none |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 应用 ID。通过控制台创建和查询，仅支持传单个 ID。 | ac7N**** |
| StreamingOutTemplate | object | 是 | 模板。 | |
| Name | string | 是 | 模板名称。 | 模板 |
| LayoutIds | array | 是 | 布局 ID 列表。 | |
| string | 否 | 具体的布局 ID。 | 22 | |
| MediaEncode | integer | 是 | 编码选项。 | 1 |
MediaEncode 枚举值如下所示。
| ID | 宽 | 高 | 码流（Kps） | 帧率（FPS） |
|---|---|---|---|---|
| 0 | 0 | 0 | 64 | 0 |
| 1 | 640 | 360 | 500 | 15 |
| 54 | 360 | 640 | 500 | 30 |
| 53 | 360 | 640 | 500 | 15 |
| 52 | 640 | 360 | 500 | 30 |
| 10 | 960 | 540 | 700 | 24 |
| 20 | 1280 | 720 | 1024 | 24 |
| 22 | 720 | 1280 | 1024 | 30 |
| 23 | 800 | 600 | 1024 | 30 |
| 30 | 1920 | 1080 | 2048 | 30 |
| 31 | 1080 | 1920 | 2048 | 30 |
| 24 | 750 | 780 | 1024 | 30 |
| 25 | 750 | 540 | 700 | 30 |
| 26 | 720 | 1280 | 2048 | 30 |
| 27 | 1280 | 720 | 2048 | 30 |
| 28 | 1280 | 720 | 3096 | 30 |
| 32 | 1024 | 768 | 1024 | 24 |
| 33 | 1280 | 960 | 1024 | 24 |
| 34 | 1024 | 768 | 2048 | 24 |
| 35 | 1280 | 960 | 2048 | 24 |
| 36 | 1280 | 720 | 1024 | 24 |
| 37 | 1280 | 720 | 2048 | 24 |
| 38 | 540 | 960 | 750 | 15 |
| 39 | 540 | 960 | 1500 | 30 |
| 40 | 1280 | 720 | 1200 | 15 |
| 41 | 720 | 1280 | 1200 | 15 |
| 42 | 720 | 1280 | 1500 | 15 |
| 43 | 540 | 960 | 1200 | 15 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "30D41049-D02D-1C21-86AE-B3E5FD805C27",
"TemplateId": "bc5v****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ParameterError | %s. | 参数错误 |
| 400 | Function.Disable | %s. | 功能状态不合法，请在功能启用的状态下请求。 |
| 400 | Quota.Invalid | %s. | 资源配额不足，请提交工单加大配额 |
| 404 | NotFound | %s. | 请求的资源不存在 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-06-21 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-03-07 | OpenAPI 错误码发生变更 | 查看变更详情 |