調用CreateAutoLiveStreamRule創建自動旁路單路轉推規則。

使用說明

本接口用于創建旁路規則。

QPS限制

本接口的單用戶QPS限制為1000次/分鐘。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

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

請求參數

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

系統規定參數。取值：CreateAutoLiveStreamRule。

AppId String 是 eo85****

應用ID，可通過控制臺創建和查詢。
PlayDomain String 是 rtmp://${domain}/${app}/${stream}

自動旁路的播流域名。自動旁路任務對應播流地址為rtmp://${domain}/${app}/${stream}。

  • domain: 您的直播播流域名。
  • app: live。
  • stream: urlencode(${AppId}_${ChannelId}_${UserId}_${SourceType})，其中SourceType為輸入源類型。
RuleName String 否 testRule

旁路規則名稱。
CallBack String 否 http://example.com/callback

開啟和結束旁路的回調地址。回調內容請參見下文中的CallBack回調示例。
MediaEncode Integer 否 20

編碼選項，請參見下文中的MediaEncode枚舉值。
ChannelIds.N String 否 12333

精確匹配的頻道ID。

說明 ChannelIds和ChannelIdPrefixes參數只能二選一輸入或者都不輸入，如果都不輸入，則表示進行應用ID維度的自動旁路單路轉推。
ChannelIdPrefixes.N String 否 12

模糊匹配頻道ID的前綴。

說明 ChannelIds和ChannelIdPrefixes參數只能二選一輸入或者都不輸入，如果都不輸入，則表示進行應用ID維度的自動旁路單路轉推。

CallBack回調示例


{
    "RequestId": "udie-jfieu89-34jfi-7jjifk",
    "AppId": "pdtkb2qy",
    "ChannelId": "0122",
    "TaskId": "AL-1f43957a8e58fedef9b568b9c9ebddc0-1613618364",
    "UserId": "2d0069089df36b22",
    "SourceType": "camera",
    "RuleId": 40,
    "Event": "StartAutoLiveStreamTask",
    "Description": "success"
}

參數

類型

是否必填

描述

RequestId

String

是

請求ID。

AppId

String

是

應用ID。

ChannelId

String

是

頻道ID。

TaskId

String

是

任務ID，生成規則為AL-MD5(rtmp://${domain}/${app}/${stream})。

UserId

String

是

用戶ID。

SourceType

String

是

輸入源類型，取值：

  • camera：攝像頭視頻流。
  • shareScreen：共享視頻流。

RuleId

Long

是

旁路規則ID。

Event

String

是

事件類型，取值：

  • StartAutoLiveStreamTask：開啟自動旁路單路轉推任務。
  • StopAutoLiveStreamTask：停止自動旁路單路轉推任務。

Description

String

是

事件描述。

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

返回數據

名稱 類型 示例值 描述
RuleId Long 12

旁路規則ID。
RequestId String 760bad53276431c499e30dc36f6b26be

請求ID。

示例

請求示例

http(s)://rtc.aliyuncs.com/?Action=CreateAutoLiveStreamRule
&AppId=eo85****
&PlayDomain=rtmp://${domain}/${app}/${stream}
&CallBack=http://example.com/callback
&公共請求參數

正常返回示例

XML格式 

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

<CreateAutoLiveStreamRuleResponse>
    <RuleId>12</RuleId>
    <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
</CreateAutoLiveStreamRuleResponse>

JSON格式 

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

{
  "RuleId" : 12,
  "RequestId" : "760bad53276431c499e30dc36f6b26be"
}