IC.KMS - imonology/ImonCloud-Doc GitHub Wiki

IC.KMS

• init(i_obj , callback )

  • 初始化 KMS工具

• newStream(i_uri,callback)

  • 新增一個串流

• delStream(i_id,callback)

  • 刪除一個串流

• startWebRtc(i_vid,i_sdpOffer,callback,i_uid)

  • 開啟一個 WEBRTC

• clearWebRtcPool(i_uid)

  • 釋放 WEBRTC 資源

• getStreamDataArr()

  • 獲得串流資訊陣列

• getStreamDataById(i_id)

  • 獲得特定 串流資訊

• startRecorder(i_vid,callback)

  • 開啟 錄製影像

• stoptRecorder(i_vid,callback)

  • 關閉 錄製影像

• getRecorderInfo()

  • 獲得 全部的錄製資訊

• getRecorderInfoById(i_vid)

  • 獲得 特定的ID 的錄製資訊

• setOneRecorderFilePath(i_vid,i_path,callback)

  • 設定 錄影存檔位置

• setAllRecorderFilePath(i_path,callback)

  • 設定 錄影存檔位置

• getRecorderDL(i_vid,i_startTime,i_endTime,callback)

  • 獲得 裁切後的錄影檔案

• dvrStdin(i_obj)

  • 寫入DVR 資料 工具 { vid , data , encode }

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

###IC.KMS.init(i_obj,callback)

功能說明

初始化 KMS工具

變數說明

• 傳入(input)

  • i_obj

  變數類型: Object

  變數說明:{ url : type=String , sysCallback : type=function }

• 傳出(output)

  callback(obj)

• 回傳(return)

  無

範例

IC.KMS.init({ url : "ws://xxxxx.xxxx.xx" , sysCallback : sysCallbackFunctoin } ,function (err) {} )

functoin sysCallbackFunctoin ( obj ) { }

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

###IC.KMS.newStream(i_uri,callback)

功能說明

新增一個串流

變數說明

• 傳入(input)

  • i_uri

  變數類型:字串

  變數說明:串流位置

• 傳出(output)

  • callback(error,id);

    • error

    變數類型:字串

    變數說明:錯誤訊息 or NULL

    • id

    變數類型:字串

    變數說明:串流 ID 編號

• 回傳(return)

  無

範例

IC.KMS.newStream("rtsp://xxxx.xx.xxxx.xx/live.sdp" ,function ( error , o_id ){

}

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

###IC.KMS.delStream(i_id,callback)

功能說明

刪除一個串流

變數說明

• 傳入(input)

  • i_id

  變數類型:字串

  變數說明:串流ID

• 傳出(output)

  • callback(error,succ);

    • error

    變數類型:字串

    變數說明:錯誤訊息 or NULL

    • succ

    變數類型:字串

    變數說明:刪除訊息

• 回傳(return)

  無

範例

IC.KMS.delStream("ID" ,function ( error , o_surc ){

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

###IC.KMS.startWebRtc(i_vid,i_sdpOffer,callback,i_uid)

功能說明

開啟一個 WEBRTC

變數說明

• 傳入(input)

  • i_vid

  變數類型:字串

  變數說明:輸入串流ID

  • i_sdpOffer

  變數類型:字串

  變數說明:輸入SDPOFFER 資訊

  + i_uid
  

  變數類型:字串

  變數說明:使用者 ID，作用方便回收WEBRTC , 預設 undefined。

• 傳出(output)

  • callback(error,o_sdpAnswer);

    • error

    變數類型:字串

    變數說明:錯誤訊息 or NULL

    • o_sdpAnswer

    變數類型:SDP 資訊DATA

    變數說明: SDP 資訊DATA

• 回傳(return)

  無

範例

IC.KMS.startWebRtc(id , sdpOffer , function(error, sdpAnswer){

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

###IC.KMS.clearWebRtcPool(i_uid)

功能說明

釋放 WEBRTC 資源

變數說明

• 傳入(input)

  • i_uid

  變數類型:字串

  變數說明:使用者 ID，作用方便回收WEBRTC , 預設 undefined。

• 傳出(output)

  無

• 回傳(return)

  無

範例

IC.KMS.clearWebRtcPool()

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

###IC.KMS.getStreamDataArr()

功能說明

獲得串流資訊陣列

變數說明

• 傳入(input)

  無

• 傳出(output)

  無

• 回傳(return)

  串流資訊陣列 { "id" : null , "url" :null }

範例

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

###IC.KMS.getStreamDataById(i_id)

功能說明

獲得特定 串流資訊

變數說明

• 傳入(input)

  • i_id

  變數類型:字串

  變數說明:串流ID

• 傳出(output)

  無

• 回傳(return)

  串流資訊資訊物件

範例

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

###IC.KMS.startRecorder(i_vid,callback)

功能說明

開啟 錄製影像

變數說明

• 傳入(input)

  • i_vid

  變數類型: 字串

  變數說明: 影片ID

• 傳出(output)

  • callback(error,o_infoArr);

    • error

    變數類型:字串

    變數說明:錯誤訊息 or NULL

    • o_infoArr

    變數類型: ARRAY( state , infoArr(url,fileName,startTime,stopTime) )

    變數說明: 錄影資訊

• 回傳(return)

  無

範例

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

###IC.KMS.stoptRecorder(i_vid,callback)

功能說明

關閉 錄製影像

變數說明

• 傳入(input)

  • i_vid

  變數類型: 字串

  變數說明: 影片ID

• 傳出(output)

  • callback(error,o_infoArr);

    • error

    變數類型:字串

    變數說明:錯誤訊息 or NULL

    • o_infoArr

    變數類型: ARRAY( state , infoArr(url,fileName,startTime,stopTime) )

    變數說明: 錄影資訊

• 回傳(return)

  無

範例

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

###IC.KMS.getRecorderInfo()

功能說明

獲得 全部的錄製資訊

變數說明

• 傳入(input)

  無

• 傳出(output)

  無

• 回傳(return)

  • INFO_ARR

  變數類型: 陣列 ALLARR( 0: infoArr(url,fileName,startTime,stopTime) , 1 : infoArr(url,fileName,startTime,stopTime) )

  變數說明: 全部的錄影資訊

範例

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

###IC.KMS.setOneRecorderFilePath(i_vid,i_path,callback)

功能說明

設定 單一錄影資訊的 錄影存檔位置

變數說明

• 傳入(input)

  • i_vid

  變數類型: 字串

  變數說明: 錄影存檔 串流名稱

  • i_path

  變數類型: 字串

  變數說明: 錄影存檔位置

• 傳出(output)

  • callback(err);

  變數類型: err = 判對 PATH 是否存在 ，錯誤回傳，成功不回傳

  變數說明: 判對 PATH 是否存在 ，錯誤回傳，成功不回傳

• 回傳(return)

範例

IC.KMS.setOneRecorderFilePath(i_vid,i_path,function(err){ } ) ;

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

###IC.KMS.setAllRecorderFilePath(i_path,callback)

功能說明

設定 全部錄影資訊的 錄影存檔位置

變數說明

• 傳入(input)

  • i_path

  變數類型: 字串

  變數說明: 錄影存檔位置

• 傳出(output)

  • callback(err);

  變數類型: err = 判對 PATH 是否存在 ，錯誤回傳，成功不回傳

  變數說明: 判對 PATH 是否存在 ，錯誤回傳，成功不回傳

• 回傳(return)

範例

IC.KMS.setAllRecorderFilePath(i_path,function(err){ } ) ;

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

###IC.KMS.getRecorderDL(i_vid,i_startTime,i_endTime,callback)

功能說明

獲得 裁切後的錄影檔案 資訊

變數說明

• 傳入(input)

  • i_vid

  變數類型: 字串 (必填)

  變數說明: 影片 ID

  • i_startTime

  變數類型: 數字(必填)

  變數說明: 開始時間 Date. time 格式

  • i_endTime

  變數類型: 數字(必填)

  變數說明: 結束時間 Date. time 格式

• 傳出(output)

  • callback(err, { filePath });

  變數類型: err 錯誤回傳，成功不回傳。 { filePath }

  變數說明: filePath 檔案位置

• 回傳(return)

範例

i_vid = 1 ;

var startDate = new Data();

var startTime = startDate.getTime();

var endDate = new Data(startTime + 360000);

var endTime = endDate.getTime();

IC.KMS.getRecorderDL(i_vid,startTime ,endTime,callback)

function callback(err,obj){

if (err) return console.log( err) ;

var filePath = obj.filePath ;

}

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

###IC.KMS.dvrStdin(i_obj)

功能說明

DVR 傳入資料工具

變數說明

• 傳入(input)

  • i_obj

  變數類型: 物件 { vid , data , encode }

  變數說明: 傳入 DVR 寫入資訊。 影片ID ， DVR 資料， DVR 格式

• 傳出(output)

• 回傳(return)

範例

IC.KMS.dvrStdin(i_obj)