《NVR的SKD二次开发接口文档.doc》由会员分享，可在线阅读，更多相关《NVR的SKD二次开发接口文档.doc（19页珍藏版）》请在金锄头文库上搜索。
1、NVR的SDK二次开发接口文档采购的海康NVR及IPC的产品需支持SDK版本在xxx上能够支持输出RTSP协议流以下SDK的接口是必须的1 账号验证用户登录NVR：实现用户的认证功能，登录成功后，返回的用户ID 作为其他功能操作的唯一标识。1.1 SDK初始化1) 初始化SDK接口：NET_DVR_Init函数： BOOL NET_DVR_Init()参数： 无返回值： TRUE 表示成功，FALSE 表示失败。说明： 调用设备网络SDK 其他函数的前提。2) 释放SDK 资源接口：NET_DVR_Cleanup函数： BOOL NET_DVR_Cleanup()参数： 无返回值： TRUE
2、表示成功，FALSE 表示失败。说明： 在结束之前最后调用。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。1.2 NVR用户的认证/登录1) 激活设备接口：NET_DVR_ActivateDevice函数： BOOL NET_DVR_ActivateDevice(char* sDVRIP, WORD wDVRPort, LPNET_DVR_ACTIVATECFGlpActivateCfg)参 数：insDVRIP 设备IP 地址inwDVRPort 设备端口inlpActivateCfg 激活参数，包括激活使用的初始密码返回值： TRUE 表示
3、成功，FALSE 表示失败。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说明： 出厂设备需要先激活，然后再使用激活使用的初始密码登录设备。2) IPServer 或者DDNS 域名解析，获取动态IP 地址和端口号接口：NET_DVR_GetDVRIPByResolveSvr_EX函数：BOOL NET_DVR_GetDVRIPByResolveSvr_EX (char* sServerIP, WORD wServerPort, BYTE* sDVRName, WORD wDVRNameLen, BYTE* sDVRSerialNumber,
4、WORD wDVRSerialLen, char* sGetIP, DWORD* dwPort)参数：insServerIP解析服务器的IP 地址inwServerPort解析服务器的端口号，IP Server 解析服务器端口号为7071，HiDDNS 服务器的端口号为80insDVRName设备名称inwDVRNameLen设备名称的长度insDVRSerialNumber设备的序列号inwDVRSerialLen设备序列号的长度outsGetIP获取到的设备IP 地址指针outdwPort获取到的设备端口号指针返回值： TRUE 表示成功，FALSE 表示失败。接口返回失败请调用NET_D
5、VR_GetLastError 获取错误码，通过错误码判断出错原因。说 明： 该接口中的设备名称和设备序列号不能同时为空。通过设备域名或者序列号解析出设备当前IP地址和端口，然后调用NET_DVR_Login_V40 登录设备。支持的解析服务器有IPServer 和hiDDNS。3) 用户注册设备接口：NET_DVR_Login_V40函 数： LONG NET_DVR_Login_V40(LPNET_DVR_USER_LOGIN_INFO pLoginInfo,LPNET_DVR_DEVICEINFO_V40 lpDeviceInfo)参 数： inpLoginInfo登录参数，包括设备地址
6、、登录用户、密码等outlpDeviceInfo设备信息(同步登录即pLoginInfo 中bUseAsynLogin 为0 时有效返回值： 异步登录的状态、用户ID 和设备信息通过 NET_DVR_USER_LOGIN_INFO 结构体中设置的回调函数(fLoginResultCallBack)返回。对于同步登录，接口返回-1 表示登录失败，其他值表示返回的用户ID 值。用户ID 具有唯一性，后续对设备的操作都需要通过此ID 实现。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明： pLoginInfo 中bUseAsynLogin 为0
7、 时登录为同步模式，接口返回成功即表示登录成功；pLoginInfo中bUseAsynLogin 为1 时登录为异步模式，登录是否成功在输入参数设置的回调函数中返回。设备同时最多允许128 个用户注册。SDK 支持2048 个注册，返回UserID 的取值范围为02047。4) 用户注销接口：NET_DVR_Logout函 数： BOOL NET_DVR_Logout(LONG lUserID)参 数： inlUserID 用户ID 号，NET_DVR_Login_V40 的返回值返回值：TRUE 表示成功，FALSE 表示失败。接口返回失败请调用NET_DVR_GetLastError 获取
8、错误码，通过错误码判断出错原因。说 明： 建议使用此接口实现注销功能。2 视频监控浏览1) 启动预览接口：NET_DVR_RealPlay_V40函 数： LONG NET_DVR_RealPlay_V40(LONG lUserID, LPNET_DVR_PREVIEWINFO lpPreviewInfo,REALDATACALLBACK fRealDataCallBack_V30, void *pUser)参 数： in lUserIDNET_DVR_Login_V40 的返回值in lpPreviewInfo 预览参数，包括通道号、码流类型、取流协议in fRealDataCallBack
9、_V30码流数据回调函数in pUser用户数据返回值： -1 表示失败，其他值作为NET_DVR_StopRealPlay 等函数的句柄参数。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明： l 该接口预览参数结构中可以设置当前预览操作是否阻塞（通过bBlocked 参数设置），若设为不阻塞，表示发起与设备的连接就认为连接成功，如果发生码流接收失败、播放失败等情况以预览异常的方式通知上层。在循环播放的时候可以减短停顿的时间，与NET_DVR_RealPlay处理一致。若设为阻塞，表示直到播放操作完成才返回成功与否。l 该接口中的回调函数
10、可以置为空，这样该函数将不回调码流数据给用户，不过用户仍可以通过接口NET_DVR_SetRealDataCallBack 或NET_DVR_SetStandardDataCallBack 注册捕获码流数据的回调函数以捕获码流数据。fRealDataCallBack_V30 回调函数中不能执行可能会占用时间较长的接口或操作，不建议调用该SDK（HCNetSDK.dll）本身的接口。l Linux 64 位系统不支持软解码功能，因此需要将窗口句柄传NULL，设置回调函数，只取流不解码显示。l 客户端异常离线时，设备端对取流连接的保持时间为10 秒。2) 停止预览接口：NET_DVR_StopRe
11、alPlay函 数： LONG NET_DVR_StopRealPlay (LONG lRealHandle)参 数： inlRealHandle 预览句柄，NET_DVR_RealPlay_V40 的返回值返回值： TRUE 表示成功，FALSE 表示失败。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明：3) 获取预览时用来解码和显示的播放库句柄接口：NET_DVR_GetRealPlayerIndex函 数： int NET_DVR_GetRealPlayerIndex(LONG lRealHandle)参 数： inlRealHan
12、dle 预览句柄，NET_DVR_RealPlay_V40 的返回值返回值： -1 表示失败，其他值表示播放句柄。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明： 用户可以通过返回的句柄自行实现播放库SDK 提供的其他功能，详见本公司提供的软解码库函数说明播放器SDK 编程指南。3 IPC录像3.1 IPC信息操作1) 获取IPC信息列表接口：NET_DVR_GetSadpInfoList函 数： BOOL NET_DVR_GetSadpInfoList(LONG lUserID, LPNET_DVR_SADPINFO_LIST lpSa
13、dpInfoList)参 数： inlUserIDNET_DVR_Login_V40 的返回值outlpSadpInfoListIPC 信息列表结构返回值： TRUE 表示成功，FALSE 表示失败。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明：2) 修改IPC信息接口：NET_DVR_UpdateSadpInfo函 数： BOOL NET_DVR_UpdateSadpInfo(LONG lUserID, LPNET_DVR_SADP_VERIFY lpSadpVerify,LPNET_DVR_SADPINFO lpSadpInfo)参
14、 数： inlUserIDNET_DVR_Login_V40 的返回值inlpSadpVerify校验信息inlpSadpInfo修改的IPC 信息列表结构返回值： TRUE 表示成功，FALSE 表示失败。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明：3.2 声音控制功能1) 设置声音播放模式接口：NET_DVR_SetAudioMode函 数： BOOL NET_DVR_SetAudioMode(DWORD dwMode)参 数： indwMode 声音播放模式：1- 独占声卡，单路音频模式；2- 共享声卡，多路音频模式返回值： T
15、RUE 表示成功，FALSE 表示失败。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明： 不调用该接口设置声音播放模式，默认为独占播放。2) 独占声卡模式下开启声音接口：NET_DVR_OpenSound函 数： BOOL NET_DVR_OpenSound(LONG lRealHandle)参 数： inlRealHandle NET_DVR_RealPlay_V40 的返回值返回值： TRUE 表示成功，FALSE 表示失败。接口返回失败请调用NET_DVR_GetLastError 获取错误码，通过错误码判断出错原因。说 明： 如果当前是共享模式播放，调用该接口将返回失败。以独占方式只能打开一路通道播放，即依次打开多个通道时仅打开最后一路。3) 独占声卡模式下关闭声音接口：NET_DVR_CloseSound函 数： BOOL NET_DVR_CloseSound()参 数： 无返回值： TRUE 表示成功，FALSE 表示失败。接口返回失败
