NVR的SKD二次开发接口文档

1、NVR得SDK二次开发接口文档采购得海康NVR及IPC得产品需支持SDK版本在XXX上能够支持输由RTSP协议流以下SDK得接口就是必须得1 账号验证?用户登录NVR实现用户得认证功能，登录成功后，返回得用户ID作为其她功能操作得唯一标识。1.1 SD创始化1)初始化SDK接口：NET_DVR_Init函数：BODLNET_DVR_hit()参数：无返回值：TRUE表示成功，FALSE表示失败。说明：调用设备网络SDK其她函数得前提。2)释放SDK资源接口：NET_DVRCleanup函数：BOOLNET_DVR_Cleanup()参数：无返回值：TRUE表示成功，FALSE表示失败。说明：在

2、结束之前最后调用。接口返回失败请调用NET_DVR_GetLastError获取错误码，通过错误码判断出错原因。1.2 NVR用户得认证/登录1) 激活设备接口：NET_DVR_ActivateDevice函数：BOOLNET_DVR_ActivateDevice(char*sDVRIP,VW)RDwDVRPort,LPNET_DVR_ACTIVATECFGlpActivateCfg)参数：insDVRIP设备IP地址inwDVRPort设备端口in1pActivateCfg激活参数，包括激活使用得初始密码返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NETDVRGetLas

3、tError获取错误码，通过错误码判断出错原因.说明:出厂设备需要先激活，然后再使用激活使用得初始密码登录设备.2) IPServer或者DDNS域名解析，获取动态IP地址与端口号接口：NET_DVR_GtDVRIPByReso1veSvr_EX函数：BOOLNET_DVR_QtDVRIPByResolveSvr_EX(char*sServerIP,WORDwServerPort,BYTE*sDVRNane,WCRDwDVRNamLen,BYTE*sDVRSerialNumber,WORDwDVRSeria1Len,char*sGetlP,DWDRD*dwPort)参数：insServerIP

4、解析服务器得IP地址inwServerPort71s析服务器彳#端口号，IPServer解析服务器端口号为7071,HiDDN5服务器得端口号为80insDVFName?没备名称inwDVRNamsLen骰备名称得长度insDVRSeria1Number设备得序列号inwDVRSerialLen?备序列号得长度outsGetIP?获取到得设备IP地址指针outdwPort欲取到得设备端口号指针返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_GetLasError获取错误码，通过错误码判断出错原因。说明：该接口中得设备名称与设备序列号不能同时为空。通过设备域名或者

5、序列号解析出设备当前IP地址与端口，然后调用NETpVR_Login_V40登录设备。支持得解析服务器有IPServer与hiDDNS.3) 用户注册设备接口：NET_DVR_ogin_V40函数：LONGNET_DV甩oginV40(LPNETDVR_USERLOGIN_INFOpLoginlnfo,LPNET_DR_DEVICEINFO_V40IpDeviceinfo)参数:inpLogininfo登录参数，包括设备地址、登录用户、密码等out1pDeviceinfo骰备信息(同步登录即pLogininfo中bUseAsynLogin为0时有效返回值：异步登录得状态、用户ID与设备信息通过

6、NET_DR_USER_LOGIN_INFO结构体中设置得回调函数(fLoginResuItCallBack)返回。对于同步登录，接口返回-1表示登录失败，其她值表示返回得用户ID值。用户ID具有唯一性，后续对设备得操作都需要通过此iD实现。接口返回失败请调用NET_DV_GetLastError获取错误码，通过错误码判断出错原因。说明：pLogininfo中bUseAsynLogin为0时登录为同步模式，接口返回成功即表示登录成功；pLogininfo中bUseAsynLogin为1时登录为异步模式，登录就是否成功在输入参数设置得回调函数中返回。设备同时最多允许128个用户注册.SDK支持2

7、048个注册，返回UseriD得取值范围为02047。4) 用户注销接口:NET_DVRLogout函数：BOCLNET_DVl_Logout(LONG1UserID)参数:inlUserID用户ID号，NET_DVFCLogin_V40得返回值返回彳1:TRUE表示成功，FALSE表示失败.接口返回失败请调用NET_DVR_GetLastError获取错误码，通过错误码判断出错原因.说明：建议使用此接口实现注销功能。2 视频监控浏览1)启动预览接口：NET_DVR_RealPlay_V40函数：LONGNETDVR_RealPlay_V40(LONGlUseriD,LPNET_DVR_PRE

8、IEWINFO1pPreviewInfo,REALDATACALLBACKRealDataCal1Back_V30,void*pUser)参数：in1UserID?NET_DVR_LognV40得返回值in1pPreviewInfo预览参数，包括通道号、码流类型、取流协议infReaIDataCallBack_V30涧流数据回调函数inpUser狎户数据返回值：一1表示失败，其她值作为NET_DVRStopRealP1ay等函数得句柄参数。接口返回失败请调用NET_DVR_GetLstError获取错误码，通过错误码判断出错原因.说明：该接口预览参数结构中可以设置当前预览操作就是否阻塞（通过b

9、Blocked参数设置），若设为不阻塞，表示发起与设备得连接就认为连接成功，如果发生码流接收失败、播放失败等情况以预览异常得方式通知上层。在循环播放得时候可以减短停顿得时间与NET_DW_RealPlay处理一致。若设为阻塞，表示直到播放操作完成才返回成功与否.该接口中得回调函数可以置为空，这样该函数将不回调码流数据给用户，不过用户仍可以通过接口NET_DVR_SetRealDataCallBack或NET_DVR_etStandardDataCallBack注册捕获码流数据得回调函数以捕获码流数据。fRealDataCallBackV30回调函数中不能执行可能会占用时间较长得接口或操作，不建

10、议调用该SDK（HCNbtSDK、dll）本身得接口。Linux64位系统不支持软解码功能，因此需要将窗口句柄传NULL设置回调函数，只取流不解码显示.客户端异常离线时，设备端对取流连接得保持时间为10秒.2）停止预览接口:NET_DVR_StopRealPlay函数：LONGNET_DVR_StopRealP1ay(LONGlRealHandle)参数：in1Rea1Handle预览句柄，NET_DVR_RealPlayV40得返回值返回值:TRUE表示成功，FALSE表示失败.接口返回失败请调用NET_DVR_GetLastError获取错误码，通过错误码判断出错原因。说明:3) 获取预览

11、时用来解码与显示得播放库句柄接口：NET_DVR_GstRealP1ayerIndex函数：intNETDVR_GetRealPlayerIndex(LONG1RealHandle)参数：inlRealHand1e预览句柄，NET_DVRRea1PlayV40得返回值返回值:-1表示失败,其她值表示播放句柄。接口返回失败请调用NET_DVR_GeLastError获取错误码，通过错误码判断出错原因。说明：用户可以通过返回得句柄自行实现播放库SDK提供得其她功能，详见本公司提供得软解码库函数说明播放器SDK编程指南3IPC录像3.1 IPC信息操作1)获取IPC信息列表接口：NET_DVR_et

12、SadpInfoList函数：BOOINET_DVR_GetSapInfoList(LONSlUserID,LPNET_DVR_SADPINFO_LISTlpSadpEnfoList)参数：in1UserIDNET_DVR_Lgin_V40得返回值outlpSadpInfoListIPC信息列表结构返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NETDVRGetLastError获取错误码，通过错误码判断出错原因.说明:2)修改IPC信息接口：NET_D7R_UpditeSadpInfo函数：BOOLNET_DVR_UpdateSadpInfo(LONG1UserID,LPN

13、ET_DR_SADP_VELIFYlpSadpVerify,LPNET_DVR_SADPINFlSadpInfo)参数：inlUserIDNET_DVR_Login_V40得返回值inlpSadpVerify校验信息inlpSadpInfo修改得IPC信息列表结构返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NELDVR_GetLastError获取错误码，通过错误码判断出错原因。说明:3.2 声音控制功能1) 设置声音播放模式接口：NET_DVR_SfetAudioMode函数：BOOLNET_DV_SetAudioMode(DWORD!WVtode)参数：indwMode

14、声音播放模式：1独占声卡，单路音频模式；2-共享声卡，多路音频模式返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_GetLastError获取错误码，通过错误码判断出错原因。说明：不调用该接口设置声音播放模式,默认为独占播放。2) 独占声卡模式下开启声音接口:NET_DVR_OpenSund函数：BOOLNET_DVR_OpeSound(LONGlRealHandle)参数：inlRealHandleNET_DVRRealPlay_V40得返回值返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVRGetLastError获取错误码，通过

15、错误码判断出错原因。说明：如果当前就是共享模式播放，调用该接口将返回失败。以独占方式只能打开一路通道播放,即依次打开多个通道时仅打开最后一路。3) 独占声卡模式下关闭声音接口：NET_DVR_CloseSound函数：BOOLNEDVR_CloseSound()参数:无返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NETDW_GetLastError获取错误码，通过错误码判断出错原因。说明：4) 共享声卡模式下开启声音接口：NETDVR_O)enSoundShiare函数：BOOLNET_VR_OpenoundShare(LONGlRealHandle)参数：inlRealH

16、andleNET_)VR_RedPlay_V40得返回值返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_QtLastError获取错误码，通过错误码判断出错原因。说明：5) 共享声卡模式下关闭声音接口:NET_DVl_CloseSoundShare函数：BOOLNET_DVR_CloseSoundShaee(LONIGlRea1Handle)参数：inIRea1Hand1eNET_”R_RealPlayV40得返回值返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_GetLastError获取错误码，通过错误码判断出错原因。说明:6

17、) 调节播放音量接口：NET_DVR_Voume函数：BOONET_DR_Volume(LONG1RealHandle,WOLDwVo1ume)参数：in1RealHand1eNETDVR_RealP1ay_V40得返回值inwVolume音量，取值范围0,0xffff返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NETDVR_QtLastError获取错误码，通过错误码判断出错原因。说明:3.3 实时预览数据捕获1)注册回调函数，捕获实时码流数据接口：NETDVRSetRealDataCallBack函数：BOOLNET_»RSetRealDataCal1Back

18、(LONGRea1Handle,fRealDataCa1lBackcbRealDataCallBack,DVW)RDdwUser)参数：inlRealHandle预览句柄，NETDVR_RealPlay_V40得返回值incbRealDataCa1lBack码流数据回调函数indwUser狎户数据返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DV_GetLastError获取错误码，通过错误码判断出错原因。说明：此函数包括开始与停止用户处理SDK捕获得数据，当回调函数cbRealDataCa1lBack设为非NLLL值时，表示回调与处理数据；当设为NLLL时表示停止回

19、调与处理数据。回调得第一个包就是40个字节得文件头，供后续解码使用，之后回调得就是压缩得码流。回调数据最大为256K字节。cbRealDataCal1Back回调函数中不能执行可能会占用时间较长得接口或操作，不建议调用该SDK(HCNetSDKdll)本身得接口。2)注册回调函数，捕获实时码流数据(标准码流)接口:NET_DVl_SetStandardDataCallBack函数：BOOLNET_DVR_StStandardDataCallBack(LONGIRea1Handle,fStdDataCal1BackcbStdDataCallBack,DWORDdwUser)参数：in1ReaIH

20、andle预览句柄，NET_DVR_eaIPlayV40得返回值incbStdDataCallBack标准码流回调函数indwUser狎户数据返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_GetastError获取错误码，通过错误码判断出错原因。说明：此函数包括开始与停止用户处理SDK捕获得数据，当回调函数cbStdDataCallBack设为非NULL值时，表示回调与处理数据；当设为NULL时表示停止回调与处理数据.回调得第一个包就是40个字节得文件头，供后续解码使用，之后回调得就是标准码流(含12字节得RTP头)。cbStdDataCallBack回调函数

21、中不能执行可能会占用时间较长得接口或操作，不建议调用该SDK(HCNetSDK、dll)本身得接口.此函数仅支持对于支持RTSP协议取流得设备彳#标准码流回调.3)捕获数据并保存到指定得文件中接口：NET_DVR_SaveealData函数:BOOLNEET_DVR_SaveRealData(LONGRea1Handle,char*s)参数：inlRea1HandleNET_DVRRealPlay_V40得返回值ins农件路径指针返回值：TRUE表示成功，FALSE表示失败.接口返回失败请调用NEET_DVR_GetLastError获取错误码，通过错误码判断出错原因。说明：V5、0、3、2或

22、以后版本，通过该接口保存录像，文件最大限制为1024MB大于1024M时，SDK自动新建文件进行保存,文件开始将40字节头自动写入，文件名命名规则为“在接口传入得文件名基础上增加数字标识(例如：*_1、mp4、*_2、mpi)”.4) 停止数据捕获接口：NET_DVR_StopSaveRealData函数：BOOLNETDVRStopSaveRealData(LONGIRealHandle)参数：inlRealHandleNET_DVR_RealPlay_V40得返回值返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NETDVR_GetLastError获取错误码，通过错误码判

23、断出错原因。说明：3.4预览抓图1) 设置抓图模式接口：NELDVR_SetCapturePictureMode函数：BOOLNET_DV_SetCapturePictureMode(DWORDdwCaptureMode)参数：indwCaptureMode抓图模式：enumtagPDC_PARM_CEYBMP_MODE=0,/BMP模式JPEG_MODE=1/JPEG模式CAPTURE_MODE返回值：TRUE表示成功,FALSE表示失败.接口返回失败请调用NET_DVR_GetLastError获取错误码，通过错误码判断出错原因。说明：调用该接口设置抓图模式后，NET_DVR_0pture

24、Picture可抓取相应得图片。2) 预览时，单帧数据捕获并保存成图片接口：NET_WR_CapturePicture函数：BOOLNETDVR_QpturePicture(LONGlRealHandle,char*sPic)参数：inIRea1HandleEJDVR_RalPlay_V40得返回值insPic保存图象得文件路径。路径长度与操作系统有关，sdk不做限制，windows默认路径长度小于等于256字节（包括文件名在内）。返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_etLastError获取错误码，通过错误码判断出错原因。说明：在调用该接口之前可以

25、调用NET_DVR_SetCapturePictureMode设置抓图模式，默认为BMP模式。如果抓图模式为BMP模式，抓取得就是BMP图片，保存路径后缀应为、bmp;如果抓图模式为JPEG模式，抓取得就是JPEG图片，保存路径后缀应为、jpg。若设备得当前分辨率为2CIF,播放库做了相关处理，抓取得图像为4CIF。调用NIET_DVR_CaptureRcture进行抓图，实际就是播放库解码抓图，要求在调用NET_DVR_RalP1ay_V40等接口时传入非空得播放句柄（播放库解码显示），否则时接口会返回失败（调用次序错误）.3）单帧数据捕获并保存成JPEG图片接口：NET_DVRCaptur

26、eJPEGPicture函数：BOOLNET_DVR_CaptureJPEGPicture（LONSlUserID,LONGlChannel,LPNET_DVR_JPEPARAlpJpegPara,char*sPic)参数：in1UserID?NET_DVR_Lgin_V40得返回值inlChannel漉道号inlpJpegParaJPEG图像参数insPic保存JPEG图得文件路径返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DV_GetLastError获取错误码，通过错误码判断出错原因.说明:该接口用于设备得单帧数据捕获：SDK发送命令给设备，设备抓图之后返回客

27、户端，然后SDK将接U到得JPEG图片数据保存成文件.抓图功能与抓图分辨率需要设备支持，IPC设备一般只支持当前视频分辨率得抓取。4)单帧数据捕获并保存成JPEG存放在指定得内存空间中接口：NETDVR_CaptureJPEGPicture_NEW函数：BOOLNET_DVR_CaptureJPEGPicture_NEW(LONGlUserID,LONGIChannel,LPNETDVRJPEGPARAlpJpegPara,char*sJpegPicBuffer,DWORDdwPicSize,LPDWODIpSizeReturned)参数：inIUserIDNET_DVR_Login_V40得

28、返回值in1Channel?通道号inlpJpegPara?JPEG图像参数insJpegPicBuffer保存JPEG数据得缓冲区indwPicSize输入缓冲区大小outIpSizeReturned返回图片数据得大小返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NETDVR_GetLastError获取错误码，通、过错误码判断出错原因。说明：该接口用于设备得单帧数据捕获：SDK发送命令给设备，设备抓图之后返回客户端，然后SDK将接收到得JPEG图片数据保存在sJpegPicBuffer缓冲区里。抓图功能与抓图分辨率需要设备支持,IPC设备一般只支持当前视频分辨率得抓取。4

29、云台控制操作对IPC得操作，包括左、右、上、下移动等.1） 云台控制操作(需先启动图像预览)接口:NET_DVR_PTZControl函数：BOOLNET_DVR_PZContro1(LONGlRealHandle,DWORDdwPTZmancjDWORDdwStop)参数:inlRealHand1eNETDVR_Rea1Pla匕V40得返回值indwPTZmand?云台控制命令indwStop?云台停止动作或开始动作：0开始，1-停止返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_GetLatError获取错误码，通过错误码判断出错原因。说明：对云台实施得每一

30、个动作都需要调用该接口两次,分别就是开始与停止控制，由接口中得最后一个参数（dwStop）决定.在调用此接口之前需要先开启预览。与设备之间得云台各项操作得命令都对应于设备与云台之间得控制码，设备会根据目前设置得解码器种类与解码器地址向云台发送控制码。如果目前设备上设置得解码器与云台设备得不匹配,需要重新配置设备得解码器。如果云台设备所需得解码器设备不支持，则无法用该接口控制。云台默认以最大速度动作。2） 云台控制操作（不用启动图像预览）接口：NETDVRPTZ：ontrolOther函数：BOOLNET_DR_PTZ：ontro1Other（LONGlUserID,LONGChannel,DW

31、ORDdwPTZmand,DWORDdwStop）参数：in1UserIDNET_DVR_LoginV40得返回值inlChannel?通道号indwPTZmand?云台控制命令indwStop云台停止动作或开始动作：0-开始；1-停止返回值：TRUE表示成功，FALSE表示失败。接口返回失败请调用NET_DVR_GetLastError获取错误码，通过错误码判断出错原因。说明:对云台实施得每一个动作都需要调用该接口两次,分别就是开始与停止控制，由接口中得最后一个参数（dwStop）决定。在调用此接口之前需要先注册设备。与设备之间得云台各项操作得命令都对应于设备与云台之间得控制码,设备会根据目前设置得解码器种类与解码器地址向云台发送控制码。如果目前设备上设置得解码器与云台设备得不匹配，需要重新配置设备得解码器。如果云台设备所需得解码器设备不支持，则无法用该接口控制.云台默认以最大速度动作.3） 带速度得云台控制操作（需先启动图像预览）接口:NET_DR_PTZControlWithSpeed函数：BOOLNET_DVR_P