IC.Video.Stream

Stream

init(i_strName, i_kmsServerURL, i_callback) -- 初始化 KMS工具

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

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

start(i_vid, i_connID, i_sdpOffer, i_callback) -- 播放串流

clear(i_connID) -- 釋放 WEBRTC 資源

getList() -- 取得串流列表

getById(i_vid) -- 取得指定串流資料

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

###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_strUrl, i_callback);

功能說明：新增串流

變數說明：

• 傳入(input)

變數名稱: i_strUrl

變數類型: string

變數說明: 串流網址

• 傳出(output)

變數名稱: callback( error, 影像ID )

變數類型:

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

• 回傳(return)

無

• 範例:

---

IC.Video.Stream.new(tempUrl ,function ( error , o_id  ){
});

---

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

###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)

無

• 傳出(output)

變數名稱: 未定義

變數類型: Array[Object]

變數說明: 串流資料的陣列

• 回傳(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);

---

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