调用StartMPUTask开始任务。

调用该接口前,请您注意:
  • 禁止同一个StreamURL(直播推流地址)在不同任务中同时使用。
  • 任务停止10S之内,禁止使用同一个StreamURL(直播推流地址)。

调试

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

请求参数

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

操作接口名,系统规定参数,取值:StartMPUTask

AppId String yourAppId

应用ID,仅支持传单个ID。

您可以在控制台创建和查询。

ChannelId String yourChannelId

频道ID,仅支持传单个ID。

LayoutIds.N RepeatList 1

布局ID数据,您可在一次任务中指定多个布局,系统会根据当时频道中的人数进行切换。详情请参见布局

N的取值范围1~15

MediaEncode Integer 2

编码选项,具体请参见本文中的MediaEncode枚举值。

StreamURL String https://123.com/xx

直播推流地址,仅支持传单个地址,生成规则请参见推流地址与播流地址(原画)

说明 对已开防盗链鉴权的域名,需要在推流地址中包含鉴权串。
TaskId String yourTaskId

任务ID,仅支持传单个ID。

字符只允许A-Za-z0-9_-,长度限制64字节。

此ID为旁路直播的标识,需保证唯一。

TaskProfile String 4IN_720P

任务计费配置,根据您的不同设置,进行收费。

  • 最大输出媒体规格为720P及以下:4IN_720P2IN_720P1IN_720P
  • 最大输出媒体规格为360P及以下:4IN_360P2IN_360P1IN_360P
  • 最大输出媒体规格为纯音频:Mixed_Audio1IN_Audio
说明 Mixed_Audio的最大输入路数为不限,其余规格根据第一个数字判断支持最大输入路数,例如:4IN_720P代表支持最大输入路数为4。
CropMode Integer 0

视频的裁剪方式。

  • 0:不保持比例铺满。
  • 1:保持比例裁剪。
  • 2(默认值):保持比例留边。
BackgroundColor Integer 0

背景色RGB,默认是0(黑色)。

计算公式为R + G × 256 + B × 65536,R(红)、G(绿)、B(蓝)的取值:0~255。

SubSpecUsers.N RepeatList userID

指定该任务订阅的用户列表,默认订阅频道内全部用户。

UserPanes.N.PaneId Integer 2

窗格ID,从左上到右下排序,从0开始。N的取值范围1~15

UserPanes.N.UserId String TestId

对应布局框格的用户ID。N的取值范围1~15

UserPanes.N.SourceType String camera

对应布局的用户视频输入,N的取值范围1~15

  • camera(默认值):视频流。
  • shareScreen:共享屏幕流。

MediaEncode枚举值如下所示。

ID

码流(kps)

帧率(fps)

0

0

0

64

0

1

640

360

500

15

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

返回数据

名称 类型 示例值 描述
RequestId String 760bad53276431c499e30dc36f6b26be

请求ID。

示例

请求示例

https://rtc.aliyuncs.com?Action=StartMPUTask
&AppId=yourAppId
&ChannelId=yourChannelId
&TaskId=yourTaskId
&MediaEncode=2
&BackgroundColor=0
&LayoutIds.1=2
&UserPanes.0.PaneId=2
&UserPanes.0.UserId=TestId
&UserPanes.0.SourceType=camera
&StreamURL=https://123.com/xx
&<公共请求参数>

正常返回示例

XML 格式

<StartMPUTaskResponse>
	  <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
</StartMPUTaskResponse>

JSON 格式

{
  "RequestId": "760bad53276431c499e30dc36f6b26be"
}

错误码

访问错误中心查看更多错误码。