建立監播室。
介面說明
調用本介面建立監播室,調用時請保證參數設定符合要求。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:CreateLiveStreamMonitor |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| MonitorName |
string |
是 |
監播名稱。 |
liveMonitor**** |
| OutputTemplate |
string |
是 |
監播輸出模版。類型取值:
|
lp_ud |
| Domain |
string |
是 |
監播網域名稱。 |
demo.aliyundoc.com |
| App |
string |
否 |
監播輸出資料流的 App。 名稱可自取,不傳預設用 monitor 作為 AppName 名稱。 |
monitor**** |
| Stream |
string |
否 |
監播輸出資料流名,不傳則系統隨機產生。 |
monitorStream**** |
| InputList |
string |
是 |
監控流輸入列表。具體內容,請參考下表 InputConfig。 |
InputConfig |
| MonitorConfig |
string |
否 |
監播警示閾值設定,JSON 格式,具體內容,請參考下表 MonitorConfig。 |
"{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}" |
| CallbackUrl |
string |
否 |
支援輸入 HTTP(S)格式的回調地址。 |
http://guide.aliyundoc.com/notify |
| DingTalkWebHookUrl |
string |
否 |
監播DingTalk警示通過釘群機器人進行警示資訊的通知,請先設定釘群機器人,並在此輸入機器人的 HTTP(S)地址。詳情請參見自訂機器人接入。 說明
配置釘群機器人自訂關鍵詞為“警示”,否則訊息無法接收。 |
https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa**** |
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]。 | [0.1, 0.1] |
SizeNormalized | Float | 表示該 Layer 元素需要填充的尺寸大小[w,h]。 | [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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| MonitorId |
string |
監播室 ID。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| RequestId |
string |
請求 ID。 |
5c6a2a0d-f228-4a64-af62-20e91b96**** |
樣本
正常返回樣本
JSON格式
{
"MonitorId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.Malformed | %s | |
| 400 | InvalidUserId.Malformed | %s | |
| 400 | MissingParameter | %s | |
| 400 | StreamMonitorExist | %s | |
| 401 | IllegalOperation | %s | |
| 500 | InternalError | %s | |
| 404 | InvalidDomainName.NotFound | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。