調(diào)用AddRecordTemplate添加錄制配置模板。

使用說(shuō)明

本接口用于添加錄制配置模板。例如：添加錄制配置模板時(shí)，您可以配置錄制規(guī)格、編碼選項(xiàng)等參數(shù)。

QPS限制

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

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱(chēng) 類(lèi)型 是否必選 示例值 描述
Action String 是 AddRecordTemplate

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

應(yīng)用ID。通過(guò)控制臺(tái)創(chuàng)建和查詢(xún)，僅支持傳單個(gè)ID。
FileSplitInterval Integer 是 1800

錄制文件切割時(shí)長(zhǎng)（大于等于1800）。單位：秒。
Formats.N RepeatList 是 mp4

錄制文件格式。當(dāng)前文件格式僅支持：.m3u8、.mp4、.flv。

說(shuō)明 文件格式僅支持小寫(xiě)。
LayoutIds.N RepeatList 是 2

布局ID數(shù)據(jù)，您可在一次任務(wù)中指定多個(gè)布局，系統(tǒng)會(huì)根據(jù)當(dāng)時(shí)頻道中的人數(shù)進(jìn)行切換。N表示數(shù)組的下標(biāo)，取值范圍1～16，相當(dāng)于一個(gè)旁路任務(wù)中最多可以同時(shí)設(shè)置16種布局。詳情請(qǐng)參見(jiàn)布局說(shuō)明。

說(shuō)明
  • N需要從1開(kāi)始并從小到大，不能中斷，要連續(xù)。
  • 設(shè)置的布局窗格數(shù)不能相同。例如：官網(wǎng)上的布局ID 2和3不能同時(shí)設(shè)置，因?yàn)樗麄儍蓚€(gè)的窗格數(shù)相同都是2。
MediaEncode Integer 是 20

編碼選項(xiàng)，請(qǐng)參見(jiàn)下文中的MediaEncode枚舉值。
Name String 是 錄制模板

錄制配置模板名稱(chēng)。
OssBucket String 是 rtc-record-oss

錄制文件存儲(chǔ)的OSS bucket。

說(shuō)明 目前僅支持上海區(qū)域OSS bucket。
OssFilePrefix String 是 record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}

錄制文件命名規(guī)則。

說(shuō)明 為確保錄制的文件名稱(chēng)唯一，目前錄制文件的命名規(guī)則為record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}。
TaskProfile String 是 4IN_1080P

任務(wù)計(jì)費(fèi)配置，根據(jù)您的不同設(shè)置，進(jìn)行收費(fèi)。請(qǐng)參見(jiàn)下文中的TaskProfile枚舉值。

說(shuō)明
  • 編碼選項(xiàng)MediaEncode的分辨率需要小于等于TaskProfile的分辨率。
  • 布局最大窗格數(shù)需要小于等于TaskProfile的輸入路數(shù)。
BackgroundColor Integer 否 0

背景色RGB。默認(rèn)是0（黑色）。計(jì)算公式為R+G×256+B×65536，R（紅）、G（綠）、B（藍(lán)）的取值：0~255。

DelayStopTime Integer 否 180

延時(shí)停止錄制的時(shí)間。單位：秒。默認(rèn)值為180秒。

MnsQueue String 否 record-callback-queue

錄制事件回調(diào)消息隊(duì)列。

說(shuō)明 此參數(shù)和HttpCallbackUrl必須輸入其中某一個(gè)，不能兩者都輸入或都不輸入。
HttpCallbackUrl String 否 http://example.com/callback

錄制事件HTTP回調(diào)地址。詳情請(qǐng)參見(jiàn)StartRecordTask接口中錄制結(jié)果回調(diào)。

說(shuō)明 此參數(shù)和MnsQueue必須輸入其中某一個(gè)，不能兩者都輸入或都不輸入。
Backgrounds.N.Url String 否 https://www.example.com/image.jpg

背景圖片的HTTP或HTTPS地址。
Backgrounds.N.Display Integer 否 0

背景圖片顯示。取值：

  • 0（None）：不顯示。
  • 1（Always）：總是顯示。
Backgrounds.N.X Float 否 0.7576

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

背景圖片坐標(biāo)Y，歸一化百分比。
Backgrounds.N.Width Float 否 0.2456

背景圖片窗格寬，歸一化百分比。
Backgrounds.N.Height Float 否 0.2456

背景圖片窗格高，歸一化百分比。
Backgrounds.N.ZOrder Integer 否 0

背景圖片疊放順序，0為最底層，1層在0層之上，以此類(lèi)推。
Watermarks.N.Url String 否 https://www.example.com/image.jpg

水印的HTTP或HTTPS地址。
Watermarks.N.Alpha Float 否 0

水印透明度。0.0表示透明，1.0表示完全不透明。
Watermarks.N.Display Integer 否 0

水印顯示。取值：

  • 0（None）：不顯示。
  • 1（Always）：總是顯示。
Watermarks.N.X Float 否 0.7576

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

水印坐標(biāo)Y，歸一化百分比。
Watermarks.N.Width Float 否 0.2456

水印窗格寬，歸一化百分比。
Watermarks.N.Height Float 否 0.2456

水印窗格高，歸一化百分比。
Watermarks.N.ZOrder Integer 否 0

水印疊放順序，0為最底層，1層在0層之上，以此類(lèi)推。
ClockWidgets.N.X Float 否 0.7576

時(shí)鐘坐標(biāo)X，歸一化百分比。
ClockWidgets.N.Y Float 否 0.7576

時(shí)鐘坐標(biāo)Y，歸一化百分比。
ClockWidgets.N.FontType Integer 否 0

時(shí)鐘字體類(lèi)型，取值：

  • 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
ClockWidgets.N.FontSize Integer 否 1

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

ClockWidgets.N.FontColor Integer 否 0

時(shí)鐘文字顏色（RGB）。

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

ClockWidgets.N.ZOrder Integer 否 0

時(shí)鐘疊放順序，0為最底層，1層在0層之上，以此類(lèi)推。

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

25

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

TaskProfile枚舉值：

說(shuō)明 Mixed_Audio（純音頻）不限制最大輸入路數(shù)，其余規(guī)格根據(jù)第一個(gè)數(shù)字判斷支持最大輸入路數(shù)，例如：4IN_720P代表支持最大輸入路數(shù)為4。

-

1080P

720P

360P

Audio

1IN

1IN_1080P

1IN_720P

1IN_360P

無(wú)

2IN

2IN_1080P

2IN_720P

2IN_360P

無(wú)

4IN

4IN_1080P

4IN_720P

4IN_360P

無(wú)

9IN

9IN_1080P

9IN_720P

9IN_360P

無(wú)

12IN

12IN_1080P

12IN_720P

12IN_360P

無(wú)

16IN

16IN_1080P

16IN_720P

16IN_360P

無(wú)

Mixed

無(wú)

無(wú)

無(wú)

Mixed_Audio

返回?cái)?shù)據(jù)

名稱(chēng) 類(lèi)型 示例值 描述
RequestId String 760bad53276431c499e30dc36f6b26be

該條任務(wù)請(qǐng)求ID。
TemplateId String 76dasgb****

錄制配置模板ID。

示例

請(qǐng)求示例

https://rtc.aliyuncs.com/?Action=AddRecordTemplate
&AppId=yourAppId
&FileSplitInterval=1800
&Formats.1=MP4
&LayoutIds.1=2
&MediaEncode=20
&Name=錄制模板
&OssBucket=rtc-record-oss
&OssFilePrefix=record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}
&TaskProfile=4IN_1080P
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式 

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

JSON格式 

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

特殊錯(cuò)誤碼

錯(cuò)誤ID

錯(cuò)誤代碼

描述

HTTP狀態(tài)碼

InternalError

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

500

內(nèi)部錯(cuò)誤