调用UpdateRecordTemplate更新录制配置模板。

使用说明

调用本接口前，您必须已经调用AddRecordTemplate添加录制配置模板。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateRecordTemplate

系统规定参数。取值：UpdateRecordTemplate。

AppId String 是 yourAppId

应用ID。通过控制台创建和查询，仅支持传单个ID。
Name String 是 录制模板

录制配置模板名称。
TemplateId String 是 76dasgb****

配置模板ID。获取模板ID，请参加AddRecordTemplate。

TaskProfile String 是 4IN_1080P

任务计费配置。
MediaEncode Integer 是 20

编码选项。
BackgroundColor Integer 否 0

背景色RGB，默认是0（黑色）。计算公式为R+G×256+B×65536，R（红）、G（绿）、B（蓝）的取值：0~255。

OssBucket String 是 rtc-record-pre

录制文件存储的OSS Bucket。
OssFilePrefix String 是 record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}

录制文件命名规则。
MnsQueue String 否 record-callback-queue

录制事件回调消息队列。
HttpCallbackUrl String 否 http://example.com/callback

录制事件HTTP回调地址。
FileSplitInterval Integer 是 1800

录制文件切割时长（大于等于1800）。单位：秒。
DelayStopTime Integer 否 180

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

EnableM3u8DateTime Boolean 否 false

录制的m3u8文件是否需要加上ts文件时间点。
LayoutIds.N Long 是 2

布局ID数据，您可在一次任务中指定多个布局，系统会根据当时频道中的人数进行切换。N表示数组的下标，取值范围1～16，相当于一个旁路任务中最多可以同时设置16种布局。详情请参见布局说明。

说明
  • N需要从1开始并从小到大，不能中断，要连续。
  • 设置的布局窗格数不能相同。例如：官网上的布局ID 2和3不能同时设置，因为他们两个的窗格数相同都是2。
Formats.N String 是 mp4

录制文件格式。当前文件格式仅支持：m3u8、mp4、flv。

说明 文件格式仅支持小写。
Backgrounds.N.Width Float 否 0.2456

窗格宽，归一化百分比。
Backgrounds.N.Height Float 否 0.2456

窗格高，归一化百分比。
Backgrounds.N.Y Float 否 0.7576

坐标Y，归一化百分比。
Backgrounds.N.Url String 否 https://www.example.com/image.jpg

图片的HTTP或HTTPS地址。
Backgrounds.N.Display Integer 否 0

图片显示。取值：

  • 0（None）：不显示。
  • 1（Always）：总是显示。
Backgrounds.N.ZOrder Integer 否 0

叠放顺序，0为最底层，1层在0层之上，以此类推。
Backgrounds.N.X Float 否 0.7576

坐标X，归一化百分比。
Watermarks.N.Alpha Float 否 0

透明度。0.0表示透明，1.0表示完全不透明。
Watermarks.N.Width Float 否 0.2456

窗格宽，归一化百分比。
Watermarks.N.Height Float 否 0.2456

窗格高，归一化百分比。
Watermarks.N.Y Float 否 0.7576

坐标Y，归一化百分比。
Watermarks.N.Url String 否 https://www.example.com/image.jpg

水印的HTTP或HTTPS地址。
Watermarks.N.Display Integer 否 0

水印显示。取值：

  • 0（None）：不显示。
  • 1（Always）：总是显示。
Watermarks.N.ZOrder Integer 否 0

叠放顺序，0为最底层，1层在0层之上，以此类推。
Watermarks.N.X Float 否 0.7576

坐标X，归一化百分比。
ClockWidgets.N.FontType Integer 否 0

时钟字体类型，取值：

  • 0（默认值）：NOTO_SERIF_CJKSC_REGULAR
  • 1：ALIBABA_PUHUITI_REGULAR
  • 2：ALIBABA_PUHUITI_BOLD
  • 3：ALIBABA_PUHUITI_Heavy
  • 4：ALIBABA_PUHUITI_LIGHT
  • 5：ALIBABA_PUHUITI_MEDIUM
ClockWidgets.N.FontColor Integer 否 0

时钟文字颜色（RGB）。

计算公式为R + G × 256 + B × 65536，R（红）、G（绿）、B（蓝）的取值：0~255。

ClockWidgets.N.Y Float 否 0.7576

时钟坐标Y，归一化百分比。
ClockWidgets.N.ZOrder Integer 否 0

时钟叠放顺序，0为最底层，1层在0层之上，以此类推。
ClockWidgets.N.X Float 否 0.7576

时钟坐标X，归一化百分比。
ClockWidgets.N.FontSize Integer 否 1

时钟字体大小。字体合理范围(0, 72]。

返回数据

名称 类型 示例值 描述
TemplateId String 76dasgb****

录制配置模板ID。
RequestId String 760bad53276431c499e30dc36f6b26be

该条任务请求ID。

示例

请求示例

https://rtc.aliyuncs.com/?Action=UpdateRecordTemplate
&AppId=yourAppId
&FileSplitInterval=1800
&Formats.1=mp4
&LayoutIds.1=2
&MediaEncode=20
&Name=录制模板
&OssBucket=rtc-record-pre
&OssFilePrefix=record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}
&TaskProfile=4IN_1080P
&TemplateId=76dasgb****
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateRecordTemplateResponse>
<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
<TemplateId>76dasgb****</TemplateId>
</UpdateRecordTemplateResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "760bad53276431c499e30dc36f6b26be",
  "TemplateId" : "76dasgb****"
}

特殊错误码

错误ID

错误代码

描述

HTTP状态码

语义

InternalError

The request processing has failed due to some unknown error, exception or failure.

500

内部错误