AddRecordTemplate_音视频通信_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

本接口用于添加录制配置模板。例如:添加录制配置模板时,您可以配置录制规格、编码选项等参数。

QPS 限制

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
LayoutIdsarray<integer<int64>>

布局 ID 数据列表。

示例值:2子级条数 <= 64
Formatsarray<string>

录制文件格式列表。

示例值:mp4子级条数 <= 3
Backgroundsarray<object>

背景图片列表。

子级条数 <= 1
Watermarksarray<object>

水印列表。

子级条数 <= 1
ClockWidgetsarray<object>

时钟列表。

子级条数 <= 1
AppIdstring

应用 ID。通过控制台创建和查询,仅支持传单个 ID。

示例值:yourAppId
Namestring

录制配置模板名称。

示例值:录制模板
TaskProfilestring

任务计费配置,根据您的不同设置,进行收费。请参见下文中的 TaskProfile 枚举值。展开详情

示例值:4IN_1080P
MediaEncodeinteger<int32>

编码选项,请参见下文中的 MediaEncode 枚举值。

示例值:20
BackgroundColorinteger<int32>

背景色 RGB。默认是 0(黑色)。计算公式为 R+G×256+B×65536,R(红)、G(绿)、B(蓝)的取值:0~255

示例值:0
OssBucketstring

录制文件存储的 OSS bucket。展开详情

示例值:rtc-record-oss
OssFilePrefixstring

录制文件命名规则。展开详情

示例值:record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}
FileSplitIntervalinteger<int32>

录制文件切割时长(大于等于 1800)。单位:秒。

示例值:1800
DelayStopTimeinteger<int32>

延时停止录制的时间。单位:秒。默认值为 180 秒。

示例值:180取值 <= 86400
MnsQueuestring

录制事件回调消息队列。展开详情

示例值:record-callback-queue
HttpCallbackUrlstring

录制事件 HTTP 回调地址。展开详情

示例值:http://example.com/callback
EnableM3u8DateTimeboolean

录制的 m3u8 文件是否需要加上 ts 文件时间点。

示例值:false
OssEndpointstring

请求说明

MediaEncode 枚举值如下所示。

ID码流(Kps)帧率(FPS)
000640
164036050015
5436064050030
5336064050015
5264036050030
1096054070024
201280720102425
227201280102430
23800600102430
3019201080204830
3110801920204830
24750780102430
2575054070030
267201280204830
271280720204830
281280720309630
321024768102424
331280960102424
341024768204824
351280960204824
361280720102424
371280720204824
3854096075015
39540960150030
401280720120015
417201280120015
427201280150015
43540960120015

TaskProfile 枚举值:

说明 Mixed_Audio(纯音频)不限制最大输入路数,其余规格根据第一个数字判断支持最大输入路数,例如:4IN_720P 代表支持最大输入路数为 4。
-1080P720P360PAudio
1IN1IN_1080P1IN_720P1IN_360P
2IN2IN_1080P2IN_720P2IN_360P
4IN4IN_1080P4IN_720P4IN_360P
9IN9IN_1080P9IN_720P9IN_360P
12IN12IN_1080P12IN_720P12IN_360P
16IN16IN_1080P16IN_720P16IN_360P
MixedMixed_Audio

返回参数

字段名称字段详情
TemplateIdstring

录制配置模板 ID。

示例值:76dasgb****
RequestIdstring

该条任务请求 ID。

示例值:760bad53276431c499e30dc36f6b26be

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
SLR.NoPermission
%s诊断

变更历史

变更时间变更内容概要操作
2022-06-21
新增请求参数OssEndpoint

相关示例