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

Record

start(i_vid, i_callback) -- 開始錄影

stop(i_vid, i_callback) -- 結束錄影

getList() -- 取得錄影檔案資料列表 / 取得單一影像資料

setFilePath(i_vid, i_path, callback) -- 設定錄影存檔位置

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

###start(i_vid, i_callback);

功能說明:啟動錄影

變數說明:

  • 傳入(input)

變數名稱: i_vid

變數類型: string

變數說明: 影片ID

  • 傳出(output)

    • callback(error,o_infoArr);

      • error

      變數類型:字串

      變數說明:錯誤訊息 or NULL

      • o_infoArr

      變數類型: object

      變數說明: 錄影資訊


object = 
{
    string    'state': 動作名稱
    object[]  'info': 資訊陣列
}
info = 
{
string 'url' : ,       //來源串流網址
string 'vid' : ,       //來源影片ID
string 'fileName' : ,  //檔案名稱
string 'fileType' : ,  //檔案類型
string 'path' : ,      //檔案位置
int    'startTime' : , //開始時間
int    'stopTime' : ,  //結束時間
bool   'autoDelete' :  //自動刪除
}

  • 回傳(return)

  • 範例:

IC.Video.Record.start(Vid,
    function ( error , o_info )
    {
});	

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

###stop(i_vid, i_callback);

功能說明:停止錄影

變數說明:

  • 傳入(input)

變數名稱: i_vid

變數類型: string

變數說明: 影片ID

  • 傳出(output)

    • callback(error,o_infoArr);

      • error

      變數類型:字串

      變數說明:錯誤訊息 or NULL

      • o_infoArr

      變數類型: object

      變數說明: 錄影資訊


object = 
{
    string    'state': 動作名稱
}

  • 回傳(return)

  • 範例:

IC.Video.Record.stop(Vid,
    function ( error , o_info  )
    {
});	

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

###getList();

功能說明:取得 全部的錄製資訊

變數說明:

  • 傳入(input)

變數名稱: 不傳入(undefine)

變數類型: undefine

變數說明: 取得全部

變數名稱: i_vid

變數類型: string

變數說明: 指定影像ID

  • 傳出(output)

  • 回傳(return)

變數名稱: 錄影資訊

變數類型: 物件陣列 object{ vid: object[], ... }

變數說明:


EX: 
object = 
{
"EA8F2B00-DD79-4FE3-A8F7-C8EAFD0FE7A6": [
    {
       "vid": "EA8F2B00-DD79-4FE3-A8F7-C8EAFD0FE7A6",
       "url": "rtsp://163.22.32.118/live1.sdp",
       "fileName": "EA8F2B00-DD79-4FE3-A8F7-C8EAFD0FE7A6_20150727-145900",
       "fileType": ".webm",
       "path": "/tmp/EA8F2B00-DD79-4FE3-A8F7-C8EAFD0FE7A6_20150727-145900.webm",
       "startTime": 1438046940530,
       "stopTime": 1438048860660,
       "autoDelete": false 
    },
]}
分隔線----------------------------------
object = 
{
    string 'url' : ,       //來源串流網址
    string 'vid' : ,       //來源影片ID
    string 'fileName' : ,  //檔案名稱
    string 'fileType' : ,  //檔案類型
    string 'path' : ,      //檔案位置
    int    'startTime' : , //開始時間
    int    'stopTime' : ,  //結束時間
    bool   'autoDelete' :  //自動刪除
}

  • 範例:

var l_recordAr = IC.Video.Record.getList();	

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

###setFilePath(i_vid, i_path, callback)

功能說明:設定錄影存檔位置

變數說明:

  • 傳入(input)

變數名稱: i_vid

變數類型: string

變數說明: 影像ID

變數名稱: i_path

變數類型: 字串

變數說明: 錄影存檔位置

  • 傳出(output)

    • callback(err);

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

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

  • 回傳(return)

  • 範例:

IC.Video.Record.setFilePath(i_vid, i_path, function(err){ } ) ;

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