开始旁路转推任务 -

使用说明

本接口用于开始旁路转推任务。当您使用旁路转推服务时，阿里云视频直播服务限制如下所示：

旁路转推并发限制20个任务数。
如果未开启转码功能，默认每个账号下每个直播加速域名最多并发推送20个原画直播流。
如果启用转码功能，默认每个账号下每个直播加速域名最多并发推送10个转码直播流。
启动旁路转推功能后，若推流地址配置了URL鉴权，则该推流地址会存在有效期问题，超过URL鉴权中配置的有效期，该地址便无法再访问，具体情况可参考URL鉴权章节。

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	StartMPUTask	系统规定参数。取值：StartMPUTask。
AppId	String	是	yourAppId	应用ID，仅支持传单个ID。
ChannelId	String	是	yourChannelId	频道ID，仅支持传单个ID。
TaskId	String	是	yourTaskId	任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字节。说明此ID为旁路转推的标识，需保证唯一。
TaskType	Integer	否	0	媒体处理类型。取值： 0：旁路转推任务。 1：MCU混流低延时分发任务。
MixMode	Integer	否	0	混流模式。取值： 0：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。 1：混流转码（默认值），支持混流转码输出。说明单路转推模式下有效参数：StreamType、SourceType、SubSpecUsers。混流转码模式下有效参数：MediaEncode、LayoutIds、BackgroundColor、SubSpecUsers、CropMode、UserPanes、Backgrounds、Watermarks。
TaskProfile	String	否	Mixed_Audio	纯音频混流时必须填写为Mixed_Audio ，其它情况置空即可。
MediaEncode	Integer	否	2	编码选项，请参见下文中的MediaEncode枚举值。
SubSpecUsers.N	String	否	userID	指定该任务订阅的用户列表，默认订阅频道内全部用户，数组下标取值范围：1～16。说明数组下标需要从1开始并从小到大，不能中断，要连续。
LayoutIds.N	Long	否	1	布局ID数据，您可在一次任务中指定多个布局，系统会根据当时频道中的人数进行切换。数组下标取值范围：1～16，相当于一个旁路任务中最多可以同时设置16种布局。说明数组下标需要从1开始并从小到大，不能中断，要连续。设置的布局窗格数不能相同。例：官网上的布局ID 2和3 的不能同时设置，他们两个的窗格数相同都是2。
UserPanes.N.Images.N.Display	Integer	否	2	图片显示，取值： 0（None）：不显示。 1（Always）：总是显示。 2（Backup）：当前用户无视频流时显示。
UserPanes.N.Images.N.Height	Float	否	0.2456	窗格高，归一化百分比。
UserPanes.N.Images.N.Url	String	否	https://www.example.com/image.jpg	图片的HTTP或HTTPS地址。
UserPanes.N.Images.N.Width	Float	否	0.2456	窗格宽，归一化百分比。
UserPanes.N.Images.N.X	Float	否	0.7576	坐标X，归一化百分比。
UserPanes.N.Images.N.Y	Float	否	0.7576	坐标Y，归一化百分比。
UserPanes.N.Images.N.ZOrder	Integer	否	0	叠放顺序，0为最底层，1层在0层之上，以此类推。
UserPanes.N.PaneId	Integer	否	2	窗格ID，取值：0~15。说明当指定的PaneId用户找不到的话，会默认显示其他的流，流的确定是根据用户加入频道的顺序。
UserPanes.N.SegmentType	Integer	否	0	人像分割类型。取值： 0：无人像分割（默认值）。 1：人像分割，仅在开启增强参数（人像分割功能）后有效。
UserPanes.N.SourceType	String	否	camera	对应布局的用户视频输入。取值： camera：视频流（默认值）。 shareScreen：共享屏幕流。
UserPanes.N.Texts.N.Alpha	Float	否	0.0	文字框和文字透明度。0.0表示透明，1.0表示完全不透明。
UserPanes.N.Texts.N.BorderColor	Long	否	0	文字描边颜色。计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：0~255。
UserPanes.N.Texts.N.BorderWidth	Integer	否	1	文字描边宽度（单位：像素），默认为0。
UserPanes.N.Texts.N.Box	Boolean	否	false	是否出现文字框。取值： false（默认值）：不出现。 true：出现。
UserPanes.N.Texts.N.BoxBorderWidth	Integer	否	0	文字框宽度（单位：像素），默认为0。
UserPanes.N.Texts.N.BoxColor	Long	否	0	文字框颜色。计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：0~255。
UserPanes.N.Texts.N.FontColor	Integer	否	0	文字颜色（RGB）。计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：0~255。
UserPanes.N.Texts.N.FontSize	Integer	否	1	字体大小，取值范围：0~72。
UserPanes.N.Texts.N.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
UserPanes.N.Texts.N.Text	String	否	text	文本内容。
UserPanes.N.Texts.N.X	Float	否	0.7576	坐标X，归一化百分比。
UserPanes.N.Texts.N.Y	Float	否	0.2456	坐标Y，归一化百分比。
UserPanes.N.Texts.N.ZOrder	Integer	否	0	叠放顺序，0为最底层，1层在0层之上，以此类推。
UserPanes.N.UserId	String	否	TestId	对应布局窗格的用户ID。取值：1~16。
Backgrounds.N.Display	Integer	否	1	图片显示，取值： 0（None）：不显示。 1（Always）：总是显示。
Backgrounds.N.Height	Float	否	0.2456	窗格高，归一化百分比。
Backgrounds.N.Url	String	否	https://www.example.com/image.jpg	图片的HTTP或HTTPS地址。
Backgrounds.N.Width	Float	否	0.2456	窗格宽，归一化百分比。
Backgrounds.N.X	Float	否	0.7576	坐标X，归一化百分比。
Backgrounds.N.Y	Float	否	0.7576	坐标Y，归一化百分比。
Backgrounds.N.ZOrder	Integer	否	0	叠放顺序，0为最底层，1层在0层之上，以此类推。
Watermarks.N.Alpha	Float	否	0.0	透明度。0.0表示透明，1.0表示完全不透明。
Watermarks.N.Display	Integer	否	0	图片显示，取值： 0（None）：不显示。 1（Always）：总是显示。
Watermarks.N.Height	Float	否	0.2456	窗格高，归一化百分比。
Watermarks.N.Url	String	否	https://www.example.com/image.jpg	图片的HTTP或HTTPS地址。
Watermarks.N.Width	Float	否	0.2456	窗格宽，归一化百分比。
Watermarks.N.X	Float	否	0.7576	坐标X，归一化百分比。
Watermarks.N.Y	Float	否	0.7576	坐标Y，归一化百分比。
Watermarks.N.ZOrder	Integer	否	0	叠放顺序，0为最底层，1层在0层之上，以此类推。
ClockWidgets.N.Alpha	Float	否	0	文字框和文字透明度。0.0表示透明，1.0表示完全不透明。
ClockWidgets.N.BorderColor	Long	否	0	文字描边颜色。计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：0~255。
ClockWidgets.N.BorderWidth	Integer	否	1	文字描边宽度（单位：像素），默认为0。
ClockWidgets.N.Box	Boolean	否	false	是否出现文字框。取值： false（默认值）：不出现。 true：出现。
ClockWidgets.N.BoxBorderWidth	Integer	否	0	文字框宽度（单位：像素），默认为0。
ClockWidgets.N.BoxColor	Long	否	0	文字框颜色。计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：0~255。
ClockWidgets.N.FontColor	Integer	否	0	文字颜色（RGB）。计算公式为`R + G × 256 + B × 65536`，R（红）、G（绿）、B（蓝）的取值：0~255。
ClockWidgets.N.FontSize	Integer	否	1	字体大小，取值范围：0~72。
ClockWidgets.N.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
ClockWidgets.N.X	Float	否	0.7576	坐标X，归一化百分比。
ClockWidgets.N.Y	Float	否	0.7576	坐标Y，归一化百分比。
ClockWidgets.N.ZOrder	Integer	否	0	叠放顺序，0为最底层，1层在0层之上，以此类推。
StreamType	Integer	否	0	单路转推模式下转推音频流。取值： 0（默认）：转推原始流。 1：仅转推音频流。 2：仅转推视频流。
SourceType	String	否	camera	单路转推模式下用户视频输入流。取值： camera：摄像头。 shareScreen：屏幕共享。
StreamURL	String	否	rtmp://example.com/live/stream	直播推流地址，仅支持传单个地址。生成规则请参见推流地址和播放地址。说明对已开防盗链鉴权的域名，需要在推流地址中包含鉴权串。禁止同一个StreamURL在不同任务中同时使用。任务停止10S之内，禁止使用同一个StreamURL。
PayloadType	String	否	0	载荷类型。取值： 0：不使用载荷。 1：使用VideoSEI。
VadInterval	String	否	86400	语音激励的回调间隔。
EnhancedParam.EnablePortraitSegmentation	Boolean	否	false	人像分割功能（内测中），取值： true：开启。 false（默认值）：关闭。

纯音频模式和音视频模式的旁路转推参数配置类似，区别在于LayoutIds（布局），MediaEncode（编码选项）及TaskProfile（任务计费配置）参数的配置。纯音频模式以上参数配置说明如下：

LayoutIds：根据任务计费配置参数TaskProfile决定，TaskProfile设置为Mixed_Audio时不限制音频源数量。
MediaEncode：只能设置为0。

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

返回数据

名称	类型	示例值	描述
RequestId	String	760bad53276431c499e30dc36f6b26be	请求ID。

示例

请求示例

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

正常返回示例

XML格式

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

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

JSON格式

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

{
  "RequestId" : "760bad53276431c499e30dc36f6b26be"
}

错误码

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