创建监播室 - 视频直播

使用说明

调用本接口创建监播室，调用时请保证参数设置符合要求。

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateLiveStreamMonitor	系统规定参数。取值：CreateLiveStreamMonitor。
MonitorName	String	是	liveMonitor****	监播名称。
OutputTemplate	String	是	lp_ud	监播输出模版。类型取值： lp_ld：流畅。 lp_sd：标清。 lp_hd：高清。 lp_ud：超清。
Domain	String	是	demo.aliyundoc.com	监播域名。
App	String	否	monitor****	监播输出流的App。名称可自取，不传默认用monitor作为AppName名称。
Stream	String	否	monitorStream****	监播输出流名，不传则系统随机生成。
InputList	String	否	InputConfig	监控流输入列表。具体内容，请参考下表InputConfig。
MonitorConfig	String	否	"{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}"	监播告警阈值设置，JSON格式，具体内容，请参考下表MonitorConfig。
CallbackUrl	String	否	http://guide.aliyundoc.com/notify	支持输入HTTP(S)格式的回调地址。
DingTalkWebHookUrl	String	否	https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****	监播钉钉告警通过钉群机器人进行告警信息的通知，请先设置钉群机器人，并在此输入机器人的HTTP(S)地址。详情请参见自定义机器人接入。说明配置钉群机器人自定义关键词为“告警”，否则消息无法接收。

InputConfig

名称	类型	描述	示例值
Index	Integer	索引，前端使用。	1
LayoutId	Integer	布局ID，必须从1开始。	1
StreamName	String	监播流的显示名称。	monitorStream****
InputUrl	String	输入流地址。	demo.aliyundoc.com
LayoutConfig	LayoutConfig	布局信息。	参考下表LayoutConfig
PlayConfig	PlayConfig	播放配置。	参考下表PlayConfig

LayoutConfig

名称	类型	描述	示例值
FillMode	String	填充类型，前端填none即可。	none
PositionRefer	String	设置元素的position参考坐标值，取值：topLeft（左上），topRight（右上），bottomLeft（左下），bottomRight（右下）。	topLeft
PositionNormalized	Float	表示该Layer元素填充区位置归一化值[x,y]。 x和y的取值范围为0~1。例如[0.1,0.1] 代表左上角水平偏移10%, 垂直偏移10%。	[0.1, 0.1]
SizeNormalized	Float	表示该Layer元素需要填充的尺寸大小[w,h]。 w和h取值范围为0~1，宽高都是进行了归一化计算。例如 [0.2,0.3]代表水平占比20%，垂直占比30%。	[0.2, 0.3]

PlayConfig

名称	类型	描述	示例值
VolumeRate	Float	音量。取值0~1之间，精确小数点后2位。	0.50

MonitorConfig

名称	类型	描述	示例值
fpsLowThres	Float	视频帧率告警阈值。此阈值为比例系数，取值范围（0.0,1.0]，默认值0.7。当监播流的视频帧率＜帧率告警阈值*直播流原始帧率，则会报警。	0.7
brHighThres	Float	音视频码率告警阈值。此阈值为比例系数，取值范围（0.0,100]，默认值1.0。当监播流的音视频码率＞码率告警阈值*直播流原始码率，则会报警。	1.0
eofDurationThresSec	Float	断流时长检测阈值，表示当前监播流断流超过多少时间（单位：秒）才会报警。取值范围（0,65535]，默认值0。由于断流后连接不断，系统会有内部收包超时时间（5秒）来判断断流。因此如果设置此参数时间<=5s，实际检测时间仍为5s；如果设置该项时间>5s，实际检测时间为设置值，只是前5s为内部收包超时，剩余时间为持续等待流没有恢复时间。如果断流后没达到此超时时间流自动恢复，则不会报警。如果断流未超时，此时修改了监播地址，对前流也不会继续检测超时和报警。	10

返回数据

名称	类型	示例值	描述
MonitorId	String	445409ec-7eaa-461d-8f29-4bec2eb9****	监播室ID。
RequestId	String	5c6a2a0d-f228-4a64-af62-20e91b9676b3	请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=CreateLiveStreamMonitor
&Domain=demo.aliyundoc.com
&MonitorName=liveMonitor****
&OutputTemplate=lp_ud
&<公共请求参数>

正常返回示例

XML格式

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

<CreateLiveStreamMonitorResponse>
<RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>
<MonitorId>445409ec-7eaa-461d-8f29-4bec2eb9****</MonitorId>
</CreateLiveStreamMonitorResponse>

JSON格式

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

{
  "RequestId" : "5c6a2a0d-f228-4a64-af62-20e91b9676b3",
  "MonitorId" : "445409ec-7eaa-461d-8f29-4bec2eb9****"
}

错误码

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