IC.Video.Stream - imonology/ImonCloud-Doc GitHub Wiki

Stream

new(i_obj, i_callback) -- 新增串流

del(i_vid, i_callback) -- 刪除串流

getList() -- 取得串流列表(未傳值:撈全部, 傳i_vid:指定資料)

• stdin(i_obj)
  • DVR 寫資料功能 { 'streamID': streamID, 'data': data, 'encode': 'binary' }

---------------------------------------------------------------

###init(i_strName, i_kmsServerURL, i_callback);

功能說明：初始化 KMS工具

變數說明：

• 傳入(input)

變數名稱: i_strName

變數類型: string

變數說明: 名稱

變數名稱: i_kmsServerURL

變數類型: string

變數說明: KMS SERVER 的URL

• 傳出(output)

無

• 回傳(return)

無

• 範例:

---

IC.Video.Stream.init("WebRTC", "http://xxxxx.xxxx.xx");

---

---------------------------------------------------------------

###new(i_obj, i_callback);

功能說明：新增串流

變數說明：

• 傳入(input)

變數名稱: i_obj

變數類型: object

變數說明: 串流資訊 { url :網址 , type : 串流格式 }

串流格式 type = IPCAM , DVR

• 傳出(output)

變數名稱: callback( error, o_obj )

變數類型:

變數說明: error = null(沒錯誤)，error != null(發生錯誤)

• 回傳(return)

無

• 範例:

---

IC.Video.Stream.new(i_obj,function ( error , o_obj ){

o_obj.id

o_obj.url

o_obj.type

});

---

---------------------------------------------------------------

###del(i_vid, i_callback);

功能說明：刪除串流

變數說明：

• 傳入(input)

變數名稱: i_vid

變數類型: string

變數說明: 影片ID

• 傳出(output)

變數名稱: callback( ( error , o_state ) )

變數類型:

變數說明: error = null(沒錯誤)，error != null(發生錯誤)

• 回傳(return)

無

• 範例:

---

IC.Video.Stream.del(tempVid, function ( error , o_state ){
});

---

---------------------------------------------------------------

###start(i_vid, i_connID, i_sdpOffer, i_callback);

功能說明：播放串流

變數說明：

• 傳入(input)

變數名稱: i_vid

變數類型: string

變數說明: 影像ID

變數名稱: i_connID

變數類型: string

變數說明: 連線ID

變數名稱: i_sdpOffer

變數類型:

變數說明:

• 傳出(output)

變數名稱: callback( error, sdpAnswer )

變數類型:

變數說明: error = null(沒錯誤)，error != null(發生錯誤)

• 回傳(return)

無

• 範例:

---

IC.Video.Stream.start(tempVID, i_connID, tempSdpOffer ,
	function(error, sdpAnswer)
            {
	}
 });

---

---------------------------------------------------------------

###clear(i_connID);

功能說明：釋放 WEBRTC 資源

變數說明：

• 傳入(input)

變數名稱: i_connID

變數類型: string

變數說明: 連線ID

• 傳出(output)

無

• 回傳(return)

無

• 範例:

---

IC.Video.Stream.clear(i_connID);

---

--------------------------------------------------------------- ###getList();

功能說明：取得串流列表

變數說明：

• 傳入(input)

(未傳值:撈全部, 傳i_vid:指定資料)

• 傳出(output)

變數名稱: 未定義

變數類型: Array[Object]

變數說明: (串流資料陣列)

Object : { 'id':影像ID, 'url':串流網址}

• 回傳(return)

無

• 範例:

---

var l_streamAr = IC.Video.Stream.getList();

---

---------------------------------------------------------------

###getById(i_vid);

功能說明：取得指定串流資料

變數說明：

• 傳入(input)

變數名稱: i_vid

變數類型: string

變數說明: 影像ID

• 傳出(output)

變數名稱: 未定義

變數類型: Object

變數說明: 串流資料

• 回傳(return)

無

• 範例:

---

var l_objStream = IC.Video.Stream.getById(l_vid);

---

---------------------------------------------------------------

###stdin(i_obj)

功能說明

DVR 寫資料功能 { 'streamID': streamID, 'data': data, 'encode': 'binary' }

變數說明

• 傳入(input)

  • i_obj

  變數類型: Object

  變數說明: { 'streamID': streamID, 'data': data, 'encode': 'binary' }

• 傳出(output)

  無

• 回傳(return)

  無

範例

IC.Video.Stream.stdin({ 'streamID': streamID, 'data': data, 'encode': 'binary' } )

---------------------------------------------------------------