NVR的SKD二次開發(fā)接口文檔

1、NVR得SDK二次開發(fā)接口文檔采購得海康 NVR及IP C得產品需支持 SDK版本在XXX上能夠支持輸出 RTSP協(xié)議流以下SD K得接口就是必須得1 賬號驗證 ?用戶登錄NVR實現用戶得認證功能，登錄成功后，返回得用戶ID作 為其她功能操作得唯一標識。1.1 SDK初 始化1) 初始化S DK接口： NETDVR In it函數:BOO L N E T_DVR_n it ()參數：返回值：TRUE表示成功，FAL SE表示失敗。說明：調用設備網絡 SDK 其她函數得前提。2) 釋放 SDK 資源接口： NE T_DVRC l e anup函數：B OCL NET DVR Cle an u p

2、()參數：返回值:TR UE表示成功，FALSE 表示失敗。說明：在結束之前最后調用。接口返回失敗請調用NE T_DVR_GetLastEr ro r獲取錯誤碼，通過錯誤碼判斷出錯原因。1.2 NVR用戶得認證/登錄1) 激活設備 接口 ：NET D VR A ctiva teDev ic e函數：BO OLNE T_DVR_A ct iva t e Device(c h ar* sDVR IP,WOR DwD VR P ort , L PNET _DVR _AC TI VAT ECFGl pAt iv ate Cfg) 參 數：i n s DVRI P設備IP地址 i n wDVR Port

3、 設備端口in 1 pAc t i vateCfg激活參數，包括激活使用得初始密碼 返回值 ： TRUE 表示成功 ,FALSE 表示失敗。接口返回失敗請調用NET_DVR_GetLa s t Er ror 獲取錯誤碼，通過錯誤碼判斷 出錯原因.說明： 出廠設備需要先激活，然后再使用激活使用得初始密碼登 錄設備.2) IPServer 或者 DDNS 域名解析，獲取動態(tài) IP 地址與端口接口： NET_DVR_G t D VR IPBy Re so 1 veSv r _EX 函數：BOOL NET_D VR_G tDVRIPB yResolv eSv r_ E X (char * sS e r

4、ve r I P, WORD wServerPor t, BYTE* sDVRNme, WORD wDVRNam Len , BYTE 興 sD V RS eri a l Number, WORD wDV RSeria 1Le n, char* s G eti P, D W RD *dwPo rt )參數：in S Serve r IP解析服務器得 IP 地址in wServer P ort ?解析服務器得端口號，IP Server解析服務 器端口號為7 071, Hl DDN 服務器得端口號為80in sDVdame?設備名稱 inwD VR Nams Le n ?設備名稱得長度 i n s

5、D V RS e r ia 1 Nu mber 設備得序列號 inw D VRS erial L en?設備序列號得長度o uts Getl P?獲取到得設備IP地址指針o ut dw Po r t ?獲取到得設備端口號指針返回值：敗請調用T RUE表示成功，FALSE表示失敗。接口返回失NET_DVR_GetLaBErro r獲取錯誤碼，通過錯誤碼判斷出錯原因說 明：該接口中得設備名稱與設備序列號不能同時為空。通過設備域名或者序列號解析出設備當前 IP 地址與端口,然后調用NET_3 VR_Login_V40登錄設備。支持得解析服務器有IPS e rve r 與hi DDNS.3) 用戶注冊

6、設備接口 ： N ET_DVRL ogin_V 4 0L OGIN I N FO函 數:L ONG NET_DVRLogin _V4 0(LPNE T_DVR_US ERpL o g i nl n f o,L PNE T_DR _DE VICEI NF O_V 40 IpDev ic eln f o)i n pL oginl n fo登錄參數 , 包括設備地址、登錄用戶、密碼等out 1 p Dev i c eI nfo ?設備信息(同步登錄即pL ogi ninfo 中bUse Asy nL o gi n 為 0 時有效返回值：異步登錄得狀態(tài)、用戶ID與設備信息通過NET DRUSER _L

7、 OG IN_INF O 結構體中設置得回調函數 (f L ogi n Resu It C all B ac k )返回。對于同步登錄，接口返回-1表示登錄失敗，其她值表示返回得用戶 ID 值。用戶I D具有唯一性，后續(xù)對設備得操作都需要通過此ID 實現。接口返回失敗請調用NET DR Ge tLastEr ro r獲取錯誤碼 , 通過錯誤碼判斷出錯原因。說明：p L o gi n Inf o中b UseA synLogin 為0時登錄為同步模式，接口返回成功即表示登錄成功；pLo gi nl nf o中bUseAsy nLogi n 為 1 時登錄為異步模式，登錄就是否成功在輸入參數設置得回

8、調函數中返回。設備同時最多允許 12 8 個用戶注冊.SDK支持2 0 4 8個注冊，返回UserI D 得取值范圍為02047。4) 用戶注銷接口 ：NET_DV R_Log out函數: B OCL NET_DR_Lo gout( LONG 1 Use r I D)inl Us er I D用戶 I D 號，NET_D VF_L ogin_V 4 0得返回值返回值：TRUE表示成功，F ALSE表示失敗.接口返回失敗請調用NE T_DV_GetLa stError獲取錯誤碼，通過錯誤碼判斷出錯原因.說 明： 建議使用此接口實現注銷功能。2 視頻監(jiān)控瀏覽1) 啟動預覽 接口： NET_3VR

9、_RealPlay_V40 函 數: LO NGNE T_D VR_Rea IP lay_V40(L ON GlUs e rl D , LPNET_DVR_PREIEWINFO 1 pPre v iewlnfo ,RE ALDATACALLBACK R ealDataCal 1 Back_V 30, void *p U ser) 參 數：:i n 1 UserID? NET_DVR_Log n_V 40 得返回值i n1p Pre vie w Inf o預覽參數，包括通道號、碼流類型、 取流協(xié)議 in f Rea lDataC a llBac k _V3 0網流數據回調函數inpU ser ?

10、用戶數據返回值：一1表示失敗，其她值作為 NET_DVRSto pRc al Pl ay 等函數得句柄參數。接口返回失敗請調用N ET_DVR_GetL s tError 獲取錯誤碼，通過錯誤碼判斷出錯原因說 明：該接口預覽參數結構中可以設置當前預覽操作就是否阻 塞（通過bBlocked參數設置）,若設為不阻塞，表示發(fā)起與設備得連 接就認為連接成功，如果發(fā)生碼流接收失敗、播放失敗等情況以預覽異常得方式通知上層。在循環(huán)播放得時候可以減短停頓得時間，與 NET_DVR_RealPlay 處理一致。若設為阻塞，表示直到播放操作完成才返回成功與否.該接口中得回調函數可以置為空,這樣該函數將不回調碼流數

11、據給用戶，不過用戶仍可以通過接口NE T DVR S etRealData CallBack 或 NET_DVR_et S tan d ard Da taC a ll B ack 注冊捕獲碼 流數據 得回調函數以捕獲碼流數據。fRealDa t aCallBack V30回調函數中不能執(zhí)行可能會占用時間較長得接口或操作，不建議調用該S DK（ HCM t S DK、dll ）本身 得接口。Li n ux 64位系統(tǒng)不支持軟解碼功能，因此需要將窗口句柄傳NULL設置回調函數，只取流不解碼顯示.客戶端異常離線時，設備端對取流連接得保持時間為10秒.2）停止預覽 接口 ：NEJDV R_Stop R

12、ea lPla y函數： L ONG N E T_DVR_Stop R e a 1 P 1 ay ( LONG lRealHandle ) 參數：in : IR e a 1 Handl e 預覽句柄，NET_DV_ReaI P lay _V40 得返回值 返回值: TRUE 表示成功， FALSE 表示失敗.接口返回失敗請調用 NET_ DV R_GetL astErr or獲取錯誤碼，通過錯誤碼判斷出錯原因。3) 獲取預覽時用來解碼與顯示得播放庫句柄函 數：接口 ：NET_DV R_Ge tR e al P1 a y e r In dexint N E T D V R _GetRe a lP

13、layerIndex( LONG 1RealHandle)參 數 : inIRealH a nd 1 e 預覽句柄，NEJDVRRea 1 Play_V40得返回值返回值: -1表示失敗 , 其她值表示播放句柄。接口返回失敗請調用NE T_DVRGa Last Erro r獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明：用戶可以通過返回得句柄自行實現播放庫SDK 提供得其她功能, 詳見本公司提供得軟解碼庫函數說明播放器SDK 編程指南.3 IPC錄像3.1 I P C信息操作1）獲取IP C信息列表接口 ： NET_DVRGe t Sadp Inf o L iL ist (LONG lU se r

14、ID , Lnfo Li st)函 數：B001NE T_DVR_GetSa p InfoPNET _DV _SAD PI NFO_LIST Ip SadpE參 數： i n1 UserIDNET_DVR_oLgin_V40 得返回值outlp S adpinfo L i s t IPC 信息列表結構 返回值：TRU E表示成功，FAL SE表示失敗。接口返回失敗請調用NET_ DVR_GetLat Err or 獲取錯誤碼，通過錯誤碼判斷出錯原 因.2）修改IPC信息 接口： N ET_D7R_Upcb teSa d pin f o 函 數：BOOLNEJDVR_UpdatS adpinfo

15、 ( L ON G 1 U serID,LP NETjyR_SA DP_VEL IF Y IpS a dp Ver i f y,LP NET_DVR_SAD PI NFO Sa dpi n f o)參數： i nIU se rID NET_ D VR_Logi n_V40 得返回值in lpSa dp Verify 校驗信息in lpSa dp Info修改得I PC信息列表結構返回值： TRUE 表示成功， FALSE 表示失敗。接口返回失敗請調用NELDVR_GetLa s t Er r or獲取錯誤碼，通過錯誤碼判斷出錯原因。3.2 聲音控制功能1) 設置聲音播放模式 接口 ： N ET

16、 D VR Se t A udioM o de函 數：參 數：BO OL NET_DR_Se tAu d i o Mod e(DWORDl wM ode)i n d wMo de聲音播放模式：1 獨占聲卡，單路音頻模式；2 共享聲卡，多路音頻模式返回值：T R UE表示成功，FA LSE表示失敗。接口返回失敗請調用NET_DVR_GetLa s tEr r o r獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明： 不調用該接口設置聲音播放模式 ,默認為獨占播放。2) 獨占聲卡模式下開啟聲音接口 :NET_DVR_OpenSund函 數：B OOL NET_DVR_One5ou nd ( LONG I

17、RealHan dle)參 數：i n IR e alHandle NET_ DVR_ RealPlay_V40 得返回返回值：TRUE表示成功，F ALSE表示失敗。接口返回失敗請調用NE T_DVR_Ge tLas t Error獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明： 如果當前就是共享模式播放，調用該接口將返回失敗。以獨占方式只能打開一路通道播放 , 即依次打開多個通道時僅打開最后一路。3) 獨占聲卡模式下關閉聲音接口： NET DVRLC l o s e Sou nd函 數：BOOL NT_DVR_C loseSou nd()參數：無返回值： TRUE 表示成功， FAL SE 表

18、示失敗。接口返回失敗請調用NELDV_GetL as t Er ror獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明：4) 共享聲卡模式下開啟聲音接口： NET_D VR_O)enSo un d Sha r e函 數：B 00L NETD VR_ Opern ou ndS ha re (LONG IReal Handle)參 數：in I Rea lHa n dl e NET_3 VR_Rea P lay_V40 得返回值返回值：TRUE 表示成功， FAL SE 表示失敗。接口返回失敗請調用NETDVR_Ge tL a st Er ror 獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明：5) 共享聲

19、卡模式下關閉聲音接口 ： N ET DR Cl o se S o u nd Shar e函 數：BOOL N ET_D VR_C Io s eSou ndShar e ( LO NG l Re a1 Ha ndl e )參數:in lRe al Ha n dieNETDV R_ReaIPlay _V4 0得返回值返回值： TRU E表示成功，F ALSE表示失敗。接口返回失敗請調用 NE T DR_ GetLas t Err o r獲取錯誤碼，通過錯誤碼判斷出錯原因。6) 調節(jié)播放音量接口： NETDVRVoume函 數：BOOLNET_DR_Vo 1 ume( LONG 1 Real Han

20、dl e, WR DwVol ume)參數：i n1R eal H and 1 eN ET_DV R_Real Pl ay_V40得返回值i n w Vo 1 ume音量,取值范圍0,0x ffff 返回值：TRUE表示成功，FALSE表示失敗。接口返回失敗請調用NE T_D VR_Get La st Error獲取錯誤碼，通過錯誤碼判斷出錯原 因。3.3實時預覽數據捕獲 1）注冊回調函數，捕獲實時碼流數據 接口： NETLDVk SetRe alD a taCallBack 函 數：BOO L NET_EFR_ SetRe alDataCal 1 Back(LONGRea 1 Hand le

21、 , fRealDataCa 1 lBack cb Real D ata CallBack, D WORDd wUser)i n IR ea lHandle 預覽句柄，NET_DV R_Ra lPlay_V40 得返 回值in cbReal Data Ca1 l B ack碼流數據回調函數i n dwUs er ?用戶數據 返回值：T RUE表示成功，FALSE表示失敗。接口返回失敗請調用NET_D_Get L astEr r or獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明：此函數包括開始與停止用戶處理 SDK捕獲得數據，當回調 函數cb Re alData C a 1 lBack設為非NLL

22、 L值時，表示回調與處理 數據；當設為NLL L時表示停止回調與處理數據?；卣{得第一個包 就是40個字節(jié)得文件頭，供后續(xù)解碼使用，之后回調得就是壓縮得碼流?；卣{數據最大為2 56K字節(jié)。cb Re alD a taCal 1 Back回調函數中不能執(zhí)行可能會占用時間較長得接口或操作，不建議調用該SDK（HCNet SDK dll ）本身得接口。2）注冊回調函數，捕獲實時碼流數據（標準碼流）接口 ： N ET DV Set Standa r dData Ca IIB a ck(LOV40函 數：BOO L NET DVR S t S tan d a r dD at aC all Ba ckN G

23、 IRea l Hand le , fS t dDataCal l Back c b S tdDa taIIBack,DWORD dwUser) 參數:i nl Rea lHa nd le預覽句柄，NET_DVFR ea IP lay 得返回值i ncbStd Data C allBack標準碼流回調函數 i n dwUse r 湘戶數據 返回值：TRU E表示成功,F A L S E表示失敗。接口返回失敗請調 用NET_DVR_GL a st Er ro r 獲取錯誤碼，通過錯誤碼判斷出錯 原因。說明：此函數包括開始與停止用戶處理 SDK 捕獲得數據，當回 調函數cbS td D ata C

24、a llB ac k設為非N ULL值時，表示回調與 處理數據；當設為 NULL時表示停止回調與處理數據.回調得第一個 包就是40個字節(jié)得文件頭，供后續(xù)解碼使用，之后回調得就是標準 碼流（含12字節(jié)得RT P頭）。cbStdDataCallB a ck回調函數中不能執(zhí)行可能會占用時間較長 得接口或操作，不建議調用該 SDK但CNetSD K、dll ）本身得接口 .此函數僅支持對于支持RTS P協(xié)議取流得設備得標準碼流回調.3）捕獲數據并保存到指定得文件中 接口： NET DVR SavRe a l D ata函 數：B 00L NET _DVR_SaveRealData( L ONGR ea

25、l Ha nd le ,cha r s)參 數：1 nIRea l Handl eNET_DVRReal Play_V4 0 得返回值:1 n s ?文件路徑指針返回值：TRUE表示成功,FAL SE 表示失敗 . 接口返回失敗請調用NET DV RGetL as tErr o r獲取錯誤碼，通過錯誤碼判斷出錯原因。說明：V 5、0、3、2或以后版本,通過該接口保存錄像，文件最大限制為1 0 2 4MB大于1 0 24 M時，SDK 自動新建文件進行保 存,文件開始將 40 字節(jié)頭自動寫入，文件名命名規(guī)則為“在接口傳 入得文件 名基礎上增加數字標識（例如：* _1、m p4、*_ 2、mp4）

26、”4）停止數據捕獲 接口 ： N ET_DVRSt op Save Real D ata 函 數：B O OL NE T _D VR_ St op Sa veRealData ( L ON G lReal Han d l e )參 數：in I R ealHandle NE T_DV_R eal P I a y_V4 0 得返 回值 返回值：TRUE 表示成功，FAL SE表示失敗。接口返回失敗請調用NE T_DVR_GetLa s tError獲取錯誤碼，通過錯誤碼判斷出 錯原因。說 明：3.4 預覽抓圖1) 設置抓圖模式 接口： NETLDVR_SetCapture Pic tu r eM

27、ode 函 數: BOOL NET_DR_Set Capt u rePi c tu r eMocle(DWO RD dwCapture Mod e)參數：in dwCa p ture Mode 抓圖模式:e n um t a gPDC_ PAR M占 EYBM_M ODE=0,/ B MP 模式J PEG_MODE = 1 /J PEG 模式 CA PTUffi_M ODE返回值：TRU E表示成功,F AL SE表示失敗.接口返回失敗請調用NET_DVRG etLastE r ror獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明：調用該接口設置抓圖模式后 ，NET_DVR_Qp t u rePi

28、 cture 可抓取相應得圖片。2) 預覽時，單幀數據捕獲并保存成圖片 接口： NETDTR_CaptureP ict ure函 數：BO OL NE T_ DVR_(a pt ureP ict u re(L O NG R ealHand le,charsPic )參 數：in IRea 1 Handl e?NELDVR_R alPlay _V40 得返回值:1 ns Pl c保存圖象得文件路徑。路徑長度與操作系統(tǒng)有關, sdk不做限制，w indows默認路徑長度小于等于 2 5 6 字節(jié)（包 括文件名在內）。返回值：T R UE表示成功，FALSE表示失敗。接口返回失敗請調用NET_DVF

29、GetLastE r ro r獲取錯誤碼，通過錯誤碼判斷出錯原因。在調用該接口之前可以調用 NET DV_ S etCa pture PictureMode設置抓圖模式，默認為BMP模 式。如果抓圖模式為BMP模式,抓取得就是BMP圖片，保存路徑后綴應為、bmp;如果抓圖模式為JP EG模式，抓取得就是JPE G圖片,保存路徑后綴應為、j pg。若設備得當前分辨率為2CIF,播放庫做了相關處理，抓取得圖像 為4CIF。調用NE T_DVR_CaptureR cture進行抓圖，實際就是播放庫解碼抓圖，要求在調用NET _DVR_R alP 1 ay_V4 0等接口時傳入非空 得播放句柄（播放庫

30、解碼顯示），否則時接口會返回失?。ㄕ{用次序錯 誤）.3）單幀數據捕獲并保存成JPEG圖片 接口： N ET_DVR_Capt ureJPEGPictu r e 函 數：B O 0L NE T_DV_C aptur e JPEGPic ture (L ONG l UserID ,LONG lC han n el, L P N ET _DVR_J PGPARAIpJp eg Para,char *sPi c)參數：i n l Use r ID ?JET_DVR_Lgin_ V4 0 得返回值inICh a nnel ?通道號inlpjp eg Par aJPEG 圖像參數i n sPi c保存J

31、P EG圖得文件路徑 返回值：T R UE表示成功，FALSE表示失敗。接口返回失敗請調用NET_DR_Ge tL ast Erro r獲取錯誤碼，通過錯誤碼判斷出錯原因.說 明： 該接口用于設備得單幀數據捕獲： SDK 發(fā)送命令給設備, 設 備抓圖之后返回客戶端，然后 SDK將接收到得JPEG圖片數據保存 成文件.抓圖功能與抓圖分辨率需要設備支持, I PC 設備一般只支持 當前視頻分辨率得抓取。4）單幀數據捕獲并保存成JPEG存放在指定得內存空間中 接口： N ET_D VR_Ca pturej PEG P icture_NEW 函 數: BOO L N E T_DVR_C apt u r

32、eJPEGPict ure_NEW(LONS lU se r I D, LONG lCha nn el, LP NETD VRPE GP ARA l pj p echa r *sJgP ara,p egPic B uffer, DWO RD dwPicSiz e.LPDWRODlp S izeR e tu r ne d )參 數：:l nlUse r ID NET_DVR_Login_V40 得返回值in l Ch annel ?通道號:inl p Jp e gPara?JPEG 圖像參數insJpegPi c Buf fer 保存J PEG 數據得緩沖區(qū)i n dw P ic Si z e

33、?輸入緩沖區(qū)大小out IpSizeR e tur n ed返回圖片數據得大小 返回值：TRUE表示成功，FALSE表示失敗。接口返回失敗請調用NET_D VR_ Ge tLas t Err o r獲取錯誤碼，通、過錯誤碼判斷出錯 原因。說 明：該接口用于設備得單幀數據捕獲：S DK發(fā)送命令給設備, 設備抓圖之后返回客戶端，然后 SDK將接收到得JPEG圖片數據保 存在 sJpe gP icBuffer 緩沖區(qū)里。抓圖功能與抓圖分辨率需要設 備支持,PC 設備一般只支持當前視頻分辨率得抓取。4 云臺控制操作 對 IPC 得操作，包括左、右、上、下移動等 .1） 云臺控制操作（需先啟動圖像預覽

34、） 接口 :NET DV R PTZControl函 數：B OO L NET_DVR_1P ZC ont rol (LONG lRealHa ndle,DWOR D dwP TZma ndD WORD dwSt op)參 數:i miRealH and leNEJDVR_Re a l PlajV40 得返回值i n d wP TZmand ?云臺控制命令in dwSt op ?云臺停止動作或開始動作 :0 開始， 1- 停止返回值：TRUE 表示成功,FALS E表示失敗。接口返回失敗請調 用NET _DVR_GetL京t Error獲取錯誤碼，通過錯誤碼判斷出錯原 因。說 明： 對云臺實施

35、得每一個動作都需要調用該接口兩次 ,分別就是 開始與停止控制，由接口中得最后一個參數（dwStop）決定.在調用此 接口之前需要先開啟預覽。 與設備之間得云臺各項操作得命令都對應 于設備與云臺之間得控制碼， 設備會根據目前設置得解碼器種類與解 碼器地址向云臺發(fā)送控制碼。 如果目前設備上設置得解碼器與云臺設 備得不匹配 ,需要重新配置設備得解碼器。如果云臺設備所需得解碼器設備不支持，則無法用該接口控制。云臺默認以最大速度動作。2）云臺控制操作（不用啟動圖像預覽） 接口： NET DV RPTZ： on t r olOther 函 數：BOOL NET_V RPTZont rol_ Other (

36、LO NG lUse rID,LONG Channel, DWORD dwP TZm an d, DWORD dwS to p ) 參 數：in lU serlD NET_D VR_Log in_ V4 0 得返回值in ICh annel ?通道號in dwPTZmand?云臺控制命令in d w St op云臺停止動作或開始動作：0-開始；1 -停返回值：TR UE表示成功,FALS E表示失敗。接口返回失敗請調用NET_DVR_Get LastErro r獲取錯誤碼，通過錯誤碼判斷出錯原因。說 明： 對云臺實施得每一個動作都需要調用該接口兩次 ,分別就是開 始與停止控制，由接口中得最后一個參數（ dwStop ）決定。在調用 此接口之前需要先注冊設備。 與設備之間得云臺各項操作得命令都對 應于設備與云臺之間得控制碼 ,設備會根據目前設置得解碼器種類與 解碼器地址向云臺發(fā)送控制碼。 如果目前設備上設置得解碼器與云臺 設備得不匹配,需要重新配置設備得解碼器。如果云臺設備所需得解碼器設備不支持，則無法用該接口控制 云臺默認以最大速度動作 .3）帶速度得云臺控制操作（需先啟動圖像預覽 ） 接口 ：NE