调用DescribeRecordTemplates查询录制模板配置列表。

使用说明

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

QPS限制

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

调试

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

请求参数

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

操作接口名，系统规定参数。取值：DescribeRecordTemplates。

AppId String 是 yourAppId

应用ID。通过控制台创建和查询，仅支持传单个ID。
PageSize Integer 否 10

每页显示个数，默认取值10。

PageNum Integer 否 1

第几页，默认查询第1页。

TemplateIds.N RepeatList 否 76dasgb****

查询模板ID列表，格式如下所示：


TemplateIds.1=****
TemplateIds.2=****
......

获取模板ID，请参见AddRecordTemplate。

返回数据

名称 类型 示例值 描述
RequestId String C292B80E-5175-4BA4-8CC292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE1E-2ABEC4D7****

请求ID。
Templates Array of Template

录制配置模板。
BackgroundColor Integer 0

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

Backgrounds Array of Background

背景图片信息列表。
Display Integer 0

背景图片显示。取值：

  • 0（None）：不显示。
  • 1（Always）：总是显示。
Height Float 0.2456

背景图片窗格高，归一化百分比。
Url String https://www.example.com/image.jpg

背景图片的HTTP或HTTPS地址。
Width Float 0.2456

背景图片窗格宽，归一化百分比。
X Float 0.7576

背景图片坐标X，归一化百分比。
Y Float 0.7576

背景图片坐标Y，归一化百分比。
ZOrder Integer 0

背景图片叠放顺序，0为最底层，1层在0层之上，以此类推。
ClockWidgets Array of Watermark

时钟信息列表。
FontColor Integer 0

时钟文字颜色（RGB）。

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

FontSize Integer 1

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

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
X Float 0.7576

时钟坐标X，归一化百分比。
Y Float 0.7576

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

时钟叠放顺序，0为最底层，1层在0层之上，以此类推。
CreateTime String 2020-09-04T06:22:15Z

创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

DelayStopTime Integer 180

延时停止录制的时间，单位：秒。
EnableM3u8DateTime Boolean false

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

文件切割时长。
Formats List M3U8

录制文件格式。当前仅支持：M3U8、MP4、FLV。

HttpCallbackUrl String http://example.com/callback

录制事件HTTP回调地址。
LayoutIds List 2

布局ID列表。
MediaEncode Integer 50

编码选项。
MnsQueue String record-callback-queue

录制事件回调MNS队列名称。
Name String 模板-demo

录制配置模板名称。
OssBucket String rtc-record-oss

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

录制文件命名规则。
TaskProfile String 4IN_1080P

任务规格。
TemplateId String 1ca698e2-57fa-4314-8e11-00d950d4****

录制配置模板ID。
Watermarks Array of Watermark

水印信息列表。
Alpha Float 0

水印透明度，归一化百分比。其中0表示透明，1表示完全不透明。
Display Integer 0

水印显示。取值：

  • 0（None）：不显示。
  • 1（Always）：总是显示。
Height Float 0.2456

水印窗格高，归一化百分比。
Url String https://www.example.com/image.jpg

水印的HTTP或HTTPS地址。
Width Float 0.2456

水印窗格宽，归一化百分比。
X Float 0.7576

水印坐标X，归一化百分比。
Y Float 0.7576

水印坐标Y，归一化百分比。
ZOrder Integer 0

水印叠放顺序，0为最底层，1层在0层之上，以此类推。
TotalNum Long 1

返回结果数。
TotalPage Long 1

返回分页数。

示例

请求示例

https://rtc.aliyuncs.com/?Action=DescribeRecordTemplates
&AppId=yourAppId
&<公共请求参数>

正常返回示例

XML格式 

<DescribeRecordTemplatesResponse>
  <TotalNum>1</TotalNum>
	  <RequestId>C292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE</RequestId>
	  <TotalPage>1</TotalPage>
	  <Templates>
		    <FileSplitInterval>1800</FileSplitInterval>
    <OssFilePrefix>record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}</OssFilePrefix>
		    <TaskProfile>4IN_1080P</TaskProfile>
		    <OssBucket>rtc-record-pre</OssBucket>
		    <MediaEncode>50</MediaEncode>
		    <LayoutIds>2</LayoutIds>
		    <Formats>m3u8</Formats>
		    <TemplateId>1ca698e2-57fa-4314-8e11-00d950d4****</TemplateId>
		    <MnsQueue>record-callback-queue</MnsQueue>
		    <Name>模板-demo</Name>
		    <BackgroundColor>0</BackgroundColor>
	  </Templates>
    </DescribeRecordTemplatesResponse>

JSON格式 

{
	"TotalNum": 1,
	"RequestId": "C292B80E-5175-4BA4-8C1E-2ABEC4D7C2FE",
	"TotalPage": 1,
	"Templates": [{
		"FileSplitInterval": 1800,
		"OssFilePrefix": "record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}",
		"TaskProfile": "4IN_1080P",
		"OssBucket": "rtc-record-pre",
		"MediaEncode": 50,
		"LayoutIds": [
			2
		],
		"Formats": [
			"m3u8"
		],
		"TemplateId": "1ca698e2-57fa-4314-8e11-00d950d4****",
		"MnsQueue": "record-callback-queue",
		"Name": "模板-demo",
		"BackgroundColor": 0
	}]
}