iVMS7200SDK接口应用开发说明文档.docx

1、iVMS7200SDK接口应用开发说明文档iVMS-7200-SDK接口应用开发说明文档3,1,0,33171版 目录第1章 简要概述 31.1 面向的读者 31.2 本文宗旨 31.3 本文目的 31.4 适用范围 3第2章 SDK相关接口说明 42.1 初始化与注销SDK 42.2 连接设备与断开设备 42.3 实时预览开启与关闭 52.4 订阅报警与取消订阅报警 62.5 订阅GPS与取消订阅GPS 72.6 云台控制 8第3章 附录 9简要概述 面向的读者本文面向的读者是软件开发人员，工程人员及相关工作人员。 本文宗旨本文主要针对iVMS-7200-SDK接口参数作详细说明。旨在提供开

2、发人员，工程人员以及相关工作人员对iVMS-7200-SDK接口有一个较为清晰的理解，以便日后工作的展开。 本文目的本文旨在帮助软件开发人员，工程人员及相关工作人员快速理解并利用iVMS-7200-SDK接口进行快速定制开发活动。本文档目前提供了大部分重要接口说明，更为详细说明将在日后陆续完善。 适用范围拥有一定开发经验的软件开发人员，工程人员及相关工作人员。SDK相关接口说明初始化与注销SDKInt AlarmInitLib( void )、int PPVInitLib()、int InitRSMClientLib()函数说明Function: AlarmInitLib、PPVInitLib

3、、InitRSMClientLibDescription:初始化SDK（所有操作之前必须调用）Input:Output:Return: 0:成功;-1:失败Int AlarmFiniLib( void )、int PPVFiniLib(void)、int FiniRSMClientLib(void)函数说明：Function: AlarmFiniLib、PPVFiniLib、FiniRSMClientLibDescription: 注销SDK（所有操作结束后记住调用）Input:Output:Return: 0:成功;-1:失败连接设备与断开设备typedef void(_stdcall *

4、pProgressNotifyCallBack)(unsigned int nUserData, unsigned int nReserved, const char *pDesc)回调函数说明：Function: pProgressNotifyCallBackDescription: 过程回调函数Parameters:nUserData 用户数据 nReserved 保留 pDesc 当前过程描述 Return:voidInt PPVConnectDeviceByACS( const char* pszDeviceID, ST_ACCESS_SERVER_INFO stPassbyServe

5、r, pProgressNotifyCallBack pfnProgressNotifyUser, unsigned int nUserDataForCallBack, EN_CONN_MODE* pConnMode )函数说明：Function: PPVConnectDeviceByACSDescription:连接设备Input:pszDeviceID 要连接的设备ID stPassbyServer 设备注册的服务器 pfnProgressNotifyUser 过程回调nUserDataForCallBack 用户数据,回调时传给回调函数 Output:pConnMode 指向存放连接类型

6、的地址,函数返回后该地址存放的是连接类型 Return:=0：连接标识=0:取流成功，即流标识-1:失败Void StopRSMAVStreamByTCP( HSESSION hSessionID )函数说明：Function: StopRSMAVStreamByTCPDescription:停止取流Input: hSessionID 流标识(通过PlayRSMAVStreamByTCP得到) Output:Return:订阅报警与取消订阅报警typedef void(_stdcall * pAlarmCallBack)(unsigned int nUserDataForCallBack, u

7、nsigned int nReserved, const void *pDesc, size_t dwDescLen)回调函数说明：Function: pAlarmCallBackDescription:报警或者GPS回调函数Parameters:nUserDataForCallBack 用户数据ID nReserved 保留 pDesc 报警或者GPS信息数据 dwDescLen 报警或者GPS信息长度 Return:voidInt AlarmSubscribe( ST_ALARM_SERVER_INFO stAlarmServerInfo, pAlarmCallBack pfnAlarmC

8、allBack, unsigned int nUserDataForCallBack )函数说明：Function: AlarmSubscribeDescription:订阅报警Input:stAlarmServerInfo 报警服务器的信息 pfnAlarmCallBack 接收报警的回调函数 nUserDataForCallBack 接收报警的回调函数的用户数据 Output:Return:=0代表订阅成功返回的句柄-1代表失败Void AlarmUnSubscribe( int iAlarmUsrID )函数说明：Function: AlarmUnSubscribeDescription

9、:取消订阅报警Input:iAlarmUsrID 订阅报警的返回句柄 Output:Return:订阅GPS与取消订阅GPSInt GPSSubscribe( ST_ALARM_SERVER_INFO stAlarmServerInfo, pAlarmCallBack pfnAlarmCallBack, unsigned int nUserDataForCallBack )函数说明：Function: GPSSubscribeDescription:订阅GPSInput:stAlarmServerInfo 报警服务器的信息 pfnAlarmCallBack 接收GPS的回调函数 nUsrDat

10、a 用户参数 Output:Return:=0代表订阅成功返回的句柄-1代表失败Void GPSUnSubscribe( int iAlarmUsrID )函数说明：Function: GPSUnSubscribeDescription:取消订阅GPSInput:iAlarmUsrID 订阅GPS的返回句柄 Output:Return:云台控制Void PPVPTZControl( int iDevice, int iChan, int iPTZCommand, int iAction, int iSpeed )函数说明：Function: PPVPTZControlDescription:云

11、台控制Input:iDevice 设备标识 iChan 通道号,从1开始 iPTZCommand 云台控制的命令代号 iAction 云台启停,0停止1启动 iSpeed 云台运动的速度 Output:Return:0:代表成功0:代表失败订阅设备上下线通知与取消订阅typedef void (_stdcall *pNotifyCallBack)( int iNotifySubsribeID, const void* pNotifyBuffer, size_t dwNotifySize, unsigned int nUserDataForCallBack, unsigned int nRese

12、rved );回调函数说明：Function: pNotifyCallBackDescription:通知信息回调，主要是设备上下线信息Parameters:iNotifySubsribeID订阅标识,唯一性pNotifyBuffer通知信息，主要是设备上下线信息，参考格式：testOndwNotifySize信息长度nUserDataForCallBack用户数据nReserved扩展字段Return:Voidint PPVNotifySubscribe( ST_ACCESS_SERVER_INFO stPassbyServer, pNotifyCallBack pfnNotifyCallB

13、ack, unsigned int nUserDataForCallBack );函数说明：Function: PPVNotifySubscribeDescription: 通知信息订阅,包括设备上下线Input:stPassbyServer注册服务器信息 pfnNotifyCallBack消息回调 ，主要是设备上下线信息回调nUserDataForCallBack用户数据Output:Return:=0代表订阅成功返回的标识0代表失败注：每个注册服务器只需要订阅一次，不需要重复订阅void PPVNotifyUnSubscribe( int iNotifySubsribeID );函数说明：

14、Function: PPVNotifyUnSubscribeDescription: 取消通知信息订阅Input:iNotifySubsribeID订阅标识,PPVNotifySubscribe成功返回值Output:Return:void获取设备在线状态int PPVGetDeviceInfoOnServer( const char* pszDeviceID, ST_ACCESS_SERVER_INFO stPassbyServer, ST_DEVICEINFO_ONSERVER* pSTDeviceStatus );函数说明：Function: PPVGetDeviceInfoOnServ

15、erDescription:获取设备在注册服务器上状态信息Input:pszDeviceID设备注册IDstPassbyServer注册服务器信息Output:pSTDeviceStatus:状态信息，xml类型格式Return:0代表获取成功;0代表失败获取设备工作状态int PPVGetDeviceWorkStatus( int iDevice, char* pszDeviceStatusXML, size_t* nBufferSize );函数说明：Function: PPVGetDeviceWorkStatusDescription:获取设备工作状态Input:iDevice设备标识O

16、utput:pszDeviceStatusXML工作状态信息参考格式： 0 20 25 1-60000-30000-0 2-60-30-0/1/2 1-0-0-0-256-1 2-0-0-0-256-1 1,2,3,6,8 1,2,3,4,7,16 1 nBufferSize信息长度Return:0:代表成功0:代表失败附录头文件相应常用接口libPPVClient.hPPVInitLib 、PPVFiniLib 、PPVPTZControl、PPVDisConnectDevice、PPVConnectDeviceByACS、pProgressNotifyCallBack、PPVGetDevi

17、ceWorkStatus、PPVGetDeviceInfoOnServer、PPVNotifyUnSubscribe、PPVNotifySubscribelibAlarmClient.hAlarmInitLib 、AlarmFiniLib 、GPSSubscribe、GPSUnSubscribe、AlarmUnSubscribe、AlarmSubscribe、pAlarmCallBacklibRSMClient.hInitRSMClientLib 、FiniRSMClientLib 、StopRSMAVStreamByTCP、PlayRSMAVStreamByTCP、pRSMAVDataCallBack备注：所有接口函数以及结构体详细信息，请查看头文件（libPPVClient.h/libAlarmClient.h/libRSMClient.h）中说明。