調(diào)用DescribeRecordTemplates查詢錄制模板配置列表。

使用說明

調(diào)用本接口前，您必須已經(jīng)調(diào)用AddRecordTemplate添加錄制配置模板。

QPS限制

本接口的單用戶QPS限制為100次/秒。超過限制，API調(diào)用會被限流，這可能會影響您的業(yè)務(wù)，請合理調(diào)用。更多信息，請參見QPS限制。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeRecordTemplates

操作接口名，系統(tǒng)規(guī)定參數(shù)。取值：DescribeRecordTemplates。

AppId String 是 yourAppId

應(yīng)用ID。通過控制臺創(chuàng)建和查詢，僅支持傳單個ID。
PageSize Integer 否 10

每頁顯示個數(shù)，默認(rèn)取值10。

PageNum Integer 否 1

第幾頁，默認(rèn)查詢第1頁。

TemplateIds.N RepeatList 否 76dasgb****

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


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

獲取模板ID，請參見AddRecordTemplate。

返回數(shù)據(jù)

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

請求ID。
Templates Array of Template

錄制配置模板。
BackgroundColor Integer 0

背景色RGB。默認(rèn)是0（黑色）。計算公式為R+G×256+B×65536，R（紅）、G（綠）、B（藍(lán)）的取值：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

背景圖片坐標(biāo)X，歸一化百分比。
Y Float 0.7576

背景圖片坐標(biāo)Y，歸一化百分比。
ZOrder Integer 0

背景圖片疊放順序，0為最底層，1層在0層之上，以此類推。
ClockWidgets Array of Watermark

時鐘信息列表。
FontColor Integer 0

時鐘文字顏色（RGB）。

計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍(lán)）的取值：0~255。

FontSize Integer 1

時鐘字體大小。字體合理范圍(0, 72]。

FontType Integer 0

時鐘字體類型，取值：

  • 0（默認(rèn)值）：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

時鐘坐標(biāo)X，歸一化百分比。
Y Float 0.7576

時鐘坐標(biāo)Y，歸一化百分比。
ZOrder Integer 0

時鐘疊放順序，0為最底層，1層在0層之上，以此類推。
CreateTime String 2020-09-04T06:22:15Z

創(chuàng)建時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

DelayStopTime Integer 180

延時停止錄制的時間，單位：秒。
EnableM3u8DateTime Boolean false

錄制的m3u8文件是否需要加上ts文件時間點。
FileSplitInterval Integer 1800

文件切割時長。
Formats List M3U8

錄制文件格式。當(dāng)前僅支持：M3U8、MP4、FLV。

HttpCallbackUrl String http://example.com/callback

錄制事件HTTP回調(diào)地址。
LayoutIds List 2

布局ID列表。
MediaEncode Integer 50

編碼選項。
MnsQueue String record-callback-queue

錄制事件回調(diào)MNS隊列名稱。
Name String 模板-demo

錄制配置模板名稱。
OssBucket String rtc-record-oss

錄制文件存儲OSS Bucket名稱。
OssFilePrefix String record/pre/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}

錄制文件命名規(guī)則。
TaskProfile String 4IN_1080P

任務(wù)規(guī)格。
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

水印坐標(biāo)X，歸一化百分比。
Y Float 0.7576

水印坐標(biāo)Y，歸一化百分比。
ZOrder Integer 0

水印疊放順序，0為最底層，1層在0層之上，以此類推。
TotalNum Long 1

返回結(jié)果數(shù)。
TotalPage Long 1

返回分頁數(shù)。

示例

請求示例

https://rtc.aliyuncs.com/?Action=DescribeRecordTemplates
&AppId=yourAppId
&<公共請求參數(shù)>

正常返回示例

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
	}]
}