QueryLiveStreaming
調(diào)用該接口獲取IPC設備的直播開播地址。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | QueryLiveStreaming | 系統(tǒng)規(guī)定參數(shù)。取值:QueryLiveStreaming。 |
Scheme | String | 否 | rtmp | 播放協(xié)議類型:
|
IotInstanceId | String | 否 | iot-cn-n6w1y59**** | 實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
ProductKey | String | 否 | a1BwAGV**** | IPC設備所屬產(chǎn)品的ProductKey。 您可以在物聯(lián)網(wǎng)平臺控制臺產(chǎn)品頁查看或調(diào)用QueryProductList查看當前賬號下所有產(chǎn)品的信息。 重要 如果傳入該參數(shù),需同時傳入DeviceName。
|
DeviceName | String | 否 | camera1 | IPC設備的設備名稱。 您可以在物聯(lián)網(wǎng)平臺控制臺的設備頁查看DeviceName。 重要 如果傳入該參數(shù),需同時傳入ProductKey。
|
EnableStun | Boolean | 否 | false | 是否啟用P2P。
說明 該功能僅支持白名單用戶使用,如需了解使用相關(guān)功能,請發(fā)送郵件至 cangyu.fhb@alibaba-inc.com 進行咨詢。 |
StreamType | Integer | 否 | 0 | 碼流類型:
|
CacheDuration | Integer | 否 | 0 | 視頻緩存數(shù)據(jù)時長,取值范圍為0~10000,單位為毫秒,默認值為0。 |
IotId | String | 否 | C47T6xwp6ms4bNlkHRWCg4**** | IPC設備的設備ID。物聯(lián)網(wǎng)平臺為該設備頒發(fā)的ID,設備的唯一標識符。可調(diào)用物聯(lián)網(wǎng)平臺QueryDeviceDetail查詢。 重要 如果傳入該參數(shù),則無需傳入ProductKey和DeviceName。IotId作為設備唯一標識符,和ProductKey與DeviceName的組合是一一對應的關(guān)系。如果您同時傳入IotId和ProductKey與DeviceName的組合,則以IotId為準。
|
ShouldEncrypt | Boolean | 否 | true | 是否加密:
|
UrlValidDuration | Integer | 否 | 60 | URL有效期,取值范圍為10~14400,單位為秒。默認值為10。 |
PlayUnLimited | Boolean | 否 | false | 播放地址在有效期內(nèi)是否允許無限次使用:
|
EncryptType | Integer | 否 | 0 | 加密類型: 0(默認):關(guān)鍵幀加密。 |
ForceIFrame | Boolean | 否 | false | 是否給設備下發(fā)強制I幀指令:
|
調(diào)用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
Code | String | 200 | 接口返回碼:
|
Data | Struct | 播放地址信息。 |
|
Path | String | rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0 | 直播播放地址。 說明 播放地址有效期為10秒。 |
RelayDecryptKey | String | {\"iv\":\"MDEy**********+Pw==\",\"key\":\"TuqB5bpZ+589v********==\"} | 解密密鑰。 設置ShouldEncrypt參數(shù)為true時,生成解密密鑰。
|
StunInfo | String | {\"stunUrl\":\"101.***.***.**:3478?key=MuJtPMYxxxxxA&productKey=g2zbxxxxxx&udpRequestTimeout=300&udpRequestRetryNum=5&p2pSessionTimeout=10000&maxPortDetectNum=20&packetsPerSecond=1\"} | P2P服務地址。 |
ErrorMessage | String | stream push failed | 調(diào)用失敗時,返回的出錯信息。 |
RequestId | String | 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1 | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調(diào)用成功:
|
示例
請求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryLiveStreaming
&IotId=C47T6xwp6ms4bNlkHRWCg4****
&ShouldEncrypt=true
&<公共請求參數(shù)>
正常返回示例
XML
格式
<QueryLiveStreamingResponse>
<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
<Data>
<Path>rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0</Path>
<StunInfo>{\"stunUrl\":\"101.***.***.**:3478?key=MuJtPMYxxxxxA&productKey=g2zbxxxxxx&udpRequestTimeout=300&udpRequestRetryNum=5&p2pSessionTimeout=10000&maxPortDetectNum=20&packetsPerSecond=1\"}</StunInfo>
<RelayDecryptKey>{\"iv\":\"MDEy**********+Pw==\",\"key\":\"TuqB5bpZ+589v********==\"}</RelayDecryptKey>
</Data>
<Code>200</Code>
<Success>true</Success>
</QueryLiveStreamingResponse>
JSON
格式
{
"RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
"Data": {
"Path": "rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0",
"StunInfo": "{\\\"stunUrl\\\":\\\"101.***.***.**:3478?key=MuJtPMYxxxxxA&productKey=g2zbxxxxxx&udpRequestTimeout=300&udpRequestRetryNum=5&p2pSessionTimeout=10000&maxPortDetectNum=20&packetsPerSecond=1\\\"}",
"RelayDecryptKey": "{\"iv\":\"MDEy**********+Pw==\",\"key\":\"TuqB5bpZ+589v********==\"}"
},
"Code": 200,
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。