视频SDK接口定义表.doc

视频开发开发包功能初始化SDK和方中创HFZC_Startup(int uMessage ,HWND hWnd,BOOL bReadyRelay=FALSE)uMessage 窗口回调消息窗IDhWnd 窗口回调消息窗口句柄bReadyRelay 是否启动转发海康BOOL NET_DVR_Init()返回值：TRUE表示成功，FALSE表示失败大华BOOL CLIENT_Init( fDisConnect cbDisConnect, DWORD dwUser);参数说明： 断线回调函数，回调出当前网络已经断开的设备, 对调用SDK的ClIENT_LogOut()函数主动断开的设备不回调，设置为0时禁止回调 indwUser 用户数据 返回值:TRUE表示成功，FALSE表示失败恒亿BOOL MP4Net_ClientStartup(UINT nMessage , IN HWND hWnd ) 说明： 对客户端进行初始化，是客户端调用的第一个函数；设置客户端接收到服务器端命令字符串时，向客户端应用程序发送消息的目的窗口和消息ID。 参数： nMessage : 消息ID hWnd : 消息接收窗口,不使用时可以置为NULL 返回： 返回TRUE 表示成功, 返回FALSE 表示失败； 黄河HHNET_Startup(IN HWND hNotifyWnd,IN UINT nCommandID ,IN DWORD dwFrameBufNum= 0,IN BOOL bReadyRelay= FALSE,IN BOOL bReadyCenter= FALSE,IN char *pLocalAddr= NULL);功能登陆视频服务器和方中创HFZC_Login(char *pszDVRIP, WORD wPort,char *pszUserNamechar *pszPassword DWORD dwClientID)海康NET_DVR_Login_V30LONG NET_DVR_Login_V30 (char *sDVRIP, WORD wDVRPort, char *sUserName, char *sPassword, LPNET_DVR_DEVICEINFO_V30 lpDeviceInfo)参数说明sDVRIPin设备的IP地址wDVRPortin设备的埠号sUserNamein 登录的用户名sPasswordin密码lpDeviceInfoout指向NET_DVR_DEVICEINFO_V30结构返回值获得的用户ID号大华LONG CLIENT_Login( char *pchDVRIP, WORD wDVRPort, char *pchUserName, char *pchPassword, LPNET_DEVICEINFO lpDeviceInfo, int *error = 0);ParametersinpchDVRIP 设备IP inwDVRPort 设备埠 inpchUserName 用户名 inpchPassword 用户密码 outlpDeviceInfo 设备信息,属于输出参数 outerror (当函数返回成功时,该参数的值无意义)，返回登录错误码,如下表 恒亿HANDLE MP4Net_ClientLogin(IN char *sDVRIP,WORD wDVRPort, IN char *sUserName, IN char *sPassword, IN char* mac, OUT LPNET_DVR_DEVICEINFO lpDeviceInfo); 说明：远程登陆前端设备 输入参数： sDVRIP 设备的IP地址或者域名（域名最大支持256个字符） wDVRPort 设备的通讯端口 sUserName 设备登陆的用户名(最大支持32个字符) sPassword 设备的登陆密码（最大支持16个字符） mac 设备的MAC地址（在未获取MAC时可置为NULL，若MAC地址为NULL时，启动主动注册的设备也不会自动重新登录，只有在设备启动了主动注册，且客户端登录时MAC地址有效，才会进行自动登录） 输出参数： lpDeviceInfo DVR/DVS设备信息(此设备信息的获取暂未实现，可置为NULL) 返回值： 返回(HANDLE)0xFFFFFFFF表示失败;其它值作为后续函数的参数 黄河HHNET_LogonServer(IN char *pServerIP,IN UINT nServerPort,IN char *pDeviceName,IN char *pUserName,IN char *pUserPassword,IN DWORD wClientID,OUT HANDLE &hLogonServer,IN HWND hNotifyWindow = NULL);【参数】参数名称 描述 输入/输出 全局/局部 pServerIP 服务器地址URL(IP、域名)输入-nServerPort通讯端口号输入-pDeviceNameDVS设备名称(转发时使用)输入-pUserName登陆DVS使用的用户名输入-pUserPassword登陆DVS使用的密码输入-wClientID回调参数(可用做连接号等，如：当非正常关闭时，应用程序可知道是哪个连接断开了)输入-hLogonServer登录DVS返回的句柄输出-hNotifyWindow消息通知的窗口句柄，默认通知窗口为HHNET_Startup 函数中hNotifyWnd参数句柄功能打开通道预览和方中创LONG HFZC_RealPlay(LONG lLoginID,WORD wChannel, LONG lRealHandle, )海康NET_DVR_RealPlay_V30(可选connect是否在线程中处理)LONG NET_DVR_RealPlay_V30(LONG lUserID, LPNET_DVR_CLIENTINFO lpClientInfo,void(CALLBACK *fRealDataCallBack_V30) (LONG lRealHandle, DWORD dwDataType, BYTE *pBuffer, DWORD dwBufSize, void *pUser), void *pUser, BOOL bBlocked) 参数说明lUserIDinNET_DVR_Login或者NET_DVR_Login_V30的返回值lpClientInfoinNET_DVR_CLIENTINFO结构的指针fRealDataCallBack_V30 in视频数据回调函数dwUserin用户数据bBlockedin请求视频过程是否阻塞：0否；1是回调函数参数说明lRealHandle,NET_DVR_RealPlay_V30返回值dwDataType数据类型#define NET_DVR_SYSHEAD1系统头数据#define NET_DVR_STREAMDATA 2流数据/视频数据#define NET_DVR_AUDIODATA3音频资料pBuffer存放数据的缓冲区指针dwBufSize缓冲区的大小dwUser输入的用户数据返回值-1表示失败，其它值作为NET_DVR_StopRealPlay等函数的参数说明不阻塞：设备应答请求连接就认为连接成功，如果发生码流接收失败、播放失败等情况以预览异常的方式告知应用层。在循环播放的时候可以减短停顿的时间。与原来的NET_DVR_RealPlay功能一致。阻塞：直到播放成功才返回成功给应用层。大华LONG CLIENT_RealPlayEx( LONG lLoginID, int nChannelID, HWND hWnd, RealPlayType rType);ParametersinlLoginID CLIENT_Login的返回值。 innChannelID 实时监视通道号，如果rType为RType_Multiplay该参数保留。当rType为RType_Multiplay_1RType_Multiplay_16时，nChannelID决定了预览的画面，如当RType_Multiplay_4时，通道为4或5或6或7表示预览第5到第7通道的四画面预览。 inhWnd 窗口句柄。值为0（NULL）时对数据不译码不显示图像。 inrType 枚举类型，如下表： 枚举类型意义DH_RType_RealPlay 实时预览DH_RType_Multiplay多画面预览DH_RType_RealPlay_0实时监视-主码流，等同于DH_RType_RealplayDH_RType_RealPlay_1实时监视-从码流1DH_RType_RealPlay_2实时监视-从码流2DH_RType_RealPlay_3实时监视-从码流3DH_RType_Multiplay_1多画面预览1画面DH_RType_Multiplay_4多画面预览4画面DH_RType_Multiplay_8多画面预览8画面DH_RType_Multiplay_9多画面预览9画面DH_RType_Multiplay_16多画面预览16画面Return Values失败返回0，成功返回实时监视ID(实时监视句柄)，将作为相关函数的参数. 恒亿LONG MP4Net_ClientStart(IN PCLIENT_VIDEOINFO pClientInfo， IN void(*ReadDataCallBack)(DWORD dwStockHandle , IN UCHAR* pPacketBuffer , DWORD nPacketSize, int FrameType) 说明： 启动客户端连接 参数： pClientInfo 客户端连接信息结构体 ReadDataCallBack 函数是网络端口接收到数据的回调函数,客户端用它来读取数据流.如果ReadDataCallBack为NULL , 表示不需要读取数据流；ReadDataCallBack函数说明： dwStockHandle : 连接句柄（MP4Net_ClientStart返回值）, 可用于区分不同视频预览的回调 pPacketBuffer : 压缩数据缓冲区 nPacketSize : 压缩数据长度 FrameType : 压缩数据帧类型 返回： 返回1 表示失败,其它值表示成功并可作为后续操作的参数； 注： 对于软译码方式的连接，如果pClientInfo里的m_hShowVideo为NULL表示只获取音视频数据但不译码和显示；若需要得到音视频数据，则需要将ReadDataCallBack设置为有效函数位址，并需要调用MP4Net_ClientStartCapture启动捕获才能得到音视频数据;黄河HHNET_OpenChannel(IN char *pServerIP, IN UINT nServerPort,IN char *pDeviceName,IN char *pUserName,IN char *pUserPassword,IN HHOPEN_CHANNEL_INFO *pOpenInfo,OUT HANDLE &hOpenChannel,IN HWND hNotifyWindow = NULL);功能停止通道预览和方中创HFZC_StopRealPlay(LONG lRealHandle)海康NET_DVR_StopRealPlayBOOL NET_DVR_StopRealPlay (LONG lRealHandle)参数说明lRealHandleinNET_DVR_RealPlay或者NET_DVR_RealPlay_V30的返回值返回值TRUE表示成功，FALSE表示失败。大华停止实时监视或多画面预览。BOOL CLIENT_StopRealPlayEx( LONG lRealHandle);ParametersinlRealHandle CLIENT_RealPlayEx的返回值。 成功返回TRUE，失败返回FALSE。 恒亿BOOL MP4Net_ClientStop(LONG StockHandle) 说明： 停止客户端图像预览； 参数： StockHandle : MP4Net_ClientStart成功的返回值； 返回： TRUE 表示成功,否则表示失败； 黄河HHNET_CloseChannel(IN HANDLE hOpenChannel);功能退出设备登陆和方中创HFZC_Logout(LONG lLoginID)海康NET_DVR_Logout_V30 (强制注销某个用户)BOOL _stdcall NET_DVR_Logout_V30 (LONG lUserID)参数说明lUserIDin NET_DVR_Login或者NET_DVR_Login_V30的返回值返回值TRUE表示成功，FALSE表示失败说明强制停止该用户的所有操作和释放所有的资源，确保该ID对应的线程都安全退出，资源得到释放。注意NET_DVR_Logout_V30会等待或者强制将该用户的所有资源释放或者退出（如线程等），而 NET_DVR_Logout则不会，仅仅将当前的用户从设备上注销了大华BOOL CLIENT_Logout( LONG lLoginID); inlLoginID CLIENT_Login的返回值。 成功返回TRUE，失败返回FALSE。恒亿BOOL MP4Net_ClientLogout (IN HANDLE 说明：注销前端DVR/DVS设备 输入参数： hdev 设备句柄；MP4Net_返回值： TRUE 表示成功, FALSE表示失败 黄河HHNET_LogoffServer(IN HANDLE hServer);功能PTZ控制和方中创HFZC_PTZControl(LONG lLoginID,LONG lChannel,DWORD dwPTZCommand,DWORD dwPresetIndexDWORD dwStop)海康NET_DVR_PTZControl_OtherBOOL NET_DVR_PTZControl_Other (LONG lUserID,LONG lChannel,DWORD dwPTZCommand,DWORD dwStop)参数说明lUserIDinNET_DVR_Login 或者NET_DVR_Login_V30的返回值lChannelin硬盘录像机的信道号dwPTZCommandin云台控制命令，见上表dwStopin云台停止动作或开始动作：0开始；1停止。返回值TRUE表示成功，FALSE表示失败。注意云台的每一个动作都要调用该接口两次，前面三个参数一样，dwStop参数一次取值为0，一次取值为1NET_DVR_PTZPreset_OtherBOOL NET_DVR_PTZPreset_Other(LONG lUserID,LONG lChannel,DWORD dwPTZPresetCmd,DWORD dwPresetIndex)参数说明lUserIDinNET_DVR_Login 或者NET_DVR_Login_V30的返回值lChannelin硬盘录像机的信道号dwPTZPresetCmdin云台预置位命令，见上表dwPresetIndexin预置点的序号,最多支持255个预置点（具体数目和球机有关）返回值TRUE表示成功，FALSE表示失败。大华 BOOL CLIENT_PTZControl( LONG lLoginID, int nChannelID, DWORD dwPTZCommand, DWORD dwStep, BOOL dwStop);ParametersinlLoginID CLIENT_Login的返回值 innChannelID 通道号 indwPTZCommand 支持以下云台控制命令 操作类型功能PTZ_UP_CONTROL 上PTZ_DOWN_CONTROL下PTZ_LEFT_CONTROL左PTZ_RIGHT_CONTROL右PTZ_ZOOM_ADD_CONTROL变倍+PTZ_ZOOM_DEC_CONTROL变倍-PTZ_FOCUS_ADD_CONTROL调焦+ PTZ_FOCUS_DEC_CONTROL调焦-PTZ_APERTURE_ADD_CONTROL光圈+PTZ_APERTURE_DEC_CONTROL光圈- PTZ_POINT_MOVE_CONTROL转至预置点PTZ_POINT_SET_CONTROL设置 PTZ_POINT_DEL_CONTROL删除 PTZ_POINT_LOOP_CONTROL点间轮循PTZ_LAMP_CONTROL灯光雨刷indwStep 步进/速度,范围18, 8控制效果最明显,操作预置点时dwStep为预置点值. indwStop 是否停止，对云台八方向操作及镜头操作命令有效，进行其它操作时，本参数应填充FALSE。 Return Values成功返回TRUE，失败返回FALSE. Remarks对连接设备进行云台控制,通常的应用是打开监视通道,可以看到画面云台控制的效果,前提是控制云台的DVR的云台控制协议要和云台协议一致才能生效。 恒亿BOOL MP4Net_ClientPTZControl(IN HANDLE hdev, unsigned int uchannel, unsigned int ucommand, int iparam1, int iparam2, int iparam3, int iparam4) 说明：远程控制PTZ 参数： hdev：MP4Net_ClientLogin()函数的返回值 uchannel： 通道编号(从0开始) ucommand：PTZ命令字 iparam1： PTZ命令参数1 iparam2： PTZ命令参数2 iparam3： PTZ命令参数3 iparam4： PTZ命令参数4 返回值： TRUE表示成功， FALSE 表示失败 黄河【语法】HHNET_SetServerConfig(IN HANDLE hServer, IN HHCMD_NET nConfigCommand, IN char *pConfigBuf, IN UINT nConfigBufSize, IN DWORD dwAppend=0);【参数】参数名称 描述 输入/输出 全局/局部 hServer登录时返回的句柄输入-nConfigCommand命令输入-pConfigBuf 参数数据缓冲区输入-nConfigBufSize 数据长度输入-dwAppend 通道号或序号(没有序号的设为0)功能设置报警：和方中创海康BOOL _stdcall NET_DVR_SetDVRMessageCallBack_V30 (MSGCallBack fMessageCallBack, void *pUser);typedef void (CALLBACK *MSGCallBack) (LONG lCommand, NET_DVR_ALARMER *pAlarmer, char *pAlarmInfo, DWORD dwBufLen, void *pUser);参数说明fMessageCallBackin回调函数pUser:in用户数据回调函数参数说明lCommand报警消息类型pAlarmer报警设备信息，指向NET_DVR_ALARMER结构pAlarmInfo报警信息dwBufLen报警信息长度pUser输入的用户数据返回值TRUE表示成功,FALSE表示失大华 void CLIENT_SetDVRMessCallBack( fMessCallBack cbMessage, DWORD dwUser);ParameterscbMessage 消息回调函数，可以回调设备的状态, 如报警状态可以通过此回调获取; 当设置为0时表示禁止回调。 indwUser 用户自定义数据. Callback functiontypedef BOOL (CALLBACK *fMessageCallBack)( LONG lCommand, LONG lLoginID, char *pBuf, DWORD dwBufLen, char *pchDVRIP, LONG nDVRPort, DWORD dwUser);BOOL CLIENT_StartListen( LONG lLoginID); BOOL CLIENT_StopListen( LONG lLoginID);BOOL CLIENT_StopListen( LONG lLoginID);启动监听服务, 目前只实现了报警监听功能。LONG CLIENT_StartService( WORD wPort, char *pIp, fServiceCallBack pfscb, DWORD dwTimeOut, DWORD dwUserData);BOOL CLIENT_StopService( LONG lHandle);恒亿BOOL MP4Net_ClientAlarmSubscribe(IN HANDLE hdev, int iusrdata, IN CBF_AlarmInfo cbf) 说明：设备报警信息的订阅 输入参数： hdev 设备句柄；MP4Net_ClientLogin ()函数的返回值 iusrdata 用户自定义数据 CBF_AlarmInfo cbf 设备报警信息的回调函数 int(CALLBACK *CBF_AlarmInfo)(HANDLE hdevice, int iusrdata, int ialarmtype, int iparam, void * reserved); 返回值： TRUE 表示成功,FALSE 表示失败 注： /*报警类型及参数定义*/ /* /报警类型-ialarmtype 0x01 I O 报警 (iparam表示IO输入编号， 从0开始) 0x02 硬盘空间不够报警 (iparam不为0表示硬盘号) 0x03 视频移动报警 (iparam表示通道号) 0x04 视频遮蔽报警 (iparam表示通道号) 0x05 视频丢失报警 (iparam表示通道号) 0x06 非法用户登录报警 (iparam无意义) 0x07 存储设备丢失报警 (iparam无意义) 0x08 密码复位 (iparam无意义) 0x09 IP地址冲突 (iparam无意义) 0x010 硬盘出错 (iparam不为0表示硬盘号) 0x011 网线断 (iparam表示网线断,远程无此信息) 0x012 制式不匹配 (iparam无意义) */ 黄河HHNET_MessageCallback(MessageNotifyCallback pCallback);功能开始录像(本地录像，不包含远程硬盘录像机的录像)和方中创HFZC_StartRecord(LONG hRealHandle,char *pszFileName)hRealHandle: 预览通道句柄，pszFileName ：文件名海康NET_DVR_SaveRealData可用本函数实现客户端录像功能BOOL NET_DVR_SaveRealData (LONG lRealHandle,char *sFileName)参数说明lRealHandlein NET_DVR_RealPlay或者NET_DVR_RealPlay_V30的返回值sFileNamein文件名，后缀为 .mp4返回值TRUE表示成功，FALSE表示失败。大华BOOL CLIENT_SaveRealData( LONG lRealHandle, const char *pchFileName);ParametersinlRealHandle CLIENT_RealPlay的返回值 inpchFileName 实时监视保存文件名。 Return Values成功返回TRUE，失败返回FALSE。 恒亿BOOL MP4Net_ClientStartCapture(LONG StockHandle) 说明： 开始数据端的捕获(回调方式, 开始调用MP4_ClientStart设置的ReadDataCallBack函数)； 参数： StockHandle : MP4Net_ClientStart成功的返回值； 返回：返回TRUE表示成功，FALSE表示失败 黄河无，通过回调函数写文件实现功能停止录像和方中创HFZC_StopRecord(LONG lRealHandle )海康略大华略恒亿略黄河略功能获得报警信息和方中创HFZC_GetDeviceAlarmInfo(char * pszAlarmInfo );报警信息结构定义：Struct NET_DVR_ALARMINFO/报警设备IP/报警通道：（1-16 ）/报警类型：(探头，视频丢失，视频移动，通讯中断等)/报警信息。海康略大华略恒亿略黄河略功能视频报警和方中创HFZC_GetAlarmMessage(CPtrList *ptrMsg)海康布防方式，由SDK建立报警上传通道，主动连接设备，SDK一旦接收到有报警信息就通过回调函数反馈给客户端，这种方式下，无需配置上传中心的地址和端口信息，但需要配置报警处理NET_DVR_ALARMINCFG_V30【NET_DVR_HANDLEEXCEPTION_V30】中的上传中心使能功能。基本框架步骤D采用如下的接口NET_DVR_SetDVRMessCallBack_V30NET_DVR_SetupAlarmChan_V30NET_DVR_CloseAlarmChan_V30大华CLIENT_SetDVRMessCallBack设置设备消息回调函数, 用来得到设备