海康威视开发ActiveX控件接口说明V23.docx

1、海康威视开发ActiveX控件接口说明V23海康威视ActiveX控件接口说明V2.3版本(20100611)控件版本更新说明：1. 版本号改为2.3.9.12. 增加接口：BMPCapturePicV23、JPEGCapturePicV23、StartRecordV233. 支持第三方IPC的添加20100115更新：1. 增加添加数字通道时获取第三方IPC协议的接口2. 增加GetServerIPByIPServer接口通过IP-SERVER模式获取IP地址接口20100405更新：1. GetServerInfo接口中增加获取零通道个数的节点2. 增加零通道相关接口，开始零通道预览、停止

2、零通道预览、零通道预览画面翻页20100510更新：1 GetIPCConfig和SetDigitChannel接口增加是否启用快速添加节点。用于95NVR2 增加通过SADP获取在线IPC信息列表接口：GetIPCInfoBySadp3 增加修改SADP获取的在线IPC信息接口：SetIPCameraInfo方法:1.注册1.1 注册 long Login(LPCTSTR lpServerIP, long lPort, LPCTSTR lpUserName, LPCTSTR lpPassword)功能：注册用户到硬盘录像机 参数说明：lpServerIP：硬盘录像机的IP地址lPort：硬盘

3、录像机端口号lpUserName：登陆的用户名lpPassword：登陆的密码 返回值：lUserID提供给其他接口使用。-1表示注册失败。 1.2 设置UserID BOOL SetUserID(long lUserID) 功能：设置UserID，如果注册成功，可以通过该接口传入UserID. 参数说明： lUserID：要传入的UserID值 返回值：TRUE表示成功，FALSE表示失败。 2.注销2.1 注销BOOL Logout() 功能：从硬盘录像机上注销某个用户 返回值：TRUE表示成功，FALSE表示失败。2.2 释放OCX BOOL ClearOCX() 功能：停止一切操作，例

4、如录像、预览等操作 返回值：TRUE表示成功，FALSE表示失败。3.解析IP地址3.1 利用普通域名解析IP地址BSTR GetServerIP(LPCTSTR lpURL) 功能：域名方式登陆时解析所连接硬盘录像机的IP 参数说明： lpURL：域名地址 返回值：返回解析到的硬盘录像机的IP地址，返回空表示失败。3.2 利用IP-SERVER模式获取IP地址BSTR GetServerIPByIPServer (LPCTSTR lpDNSIP, LPCTSTR lpServerName, LPCTSTR lpSerialNumber) 功能：从IP-Server服务器上获取IP地址，序列号

5、和设备名称不能同时为空。 参数说明： lpDNSIP： DNS IP地址 lpServerName： 设备名称 lpSerialNumber：序列号 返回值：返回解析到的硬盘录像机的IP地址，返回空表示失败4.获取硬盘录像机的信息BSTR GetServerInfo() 功能：获取硬盘录像机的信息,注册成功后才有效 返回值：以XML形式记录硬盘录像机信息的一个字符串。 形式： byChanNum /模拟通道个数 byDVRType /类型 byDiskNum /硬盘数 bySerialNumber /序列号 byAlarmInPortNum /模拟通道报警输入个数 byAlarmOutPort

6、Num /模拟通道报警输出个数 byStartChan /起始通道号 byAudioChanNum /语音通道个数 byMaxDigitChannelNum /最大数字通道插槽数 byZeroChanNum/零通道个数 5.预览5.1 开始预览 BOOL StartRealPlay(long lChannelNum ,long lProtocolType, long lStreamType) 功能：开始预览(如果调用了SetPlayWndType接口，预览画面就按照设置的比例显示。如果没有，当前预览通道是HD720p或者HD900p的分辨率，预览画面自动变成16：9的比例；如果获取不到分辨率，

7、预览画面大小就是当前控件大小；其他分辨率时，预览画面为4：3的比例)参数说明：lChannelNum：播放通道号， 0 代表通道1，1 代表通道2lProtocolType：协议类型，0 TCP， 1 - UDPlStreamType： 码流类型，0 表示主码流， 1 表示子码流返回值：TRUE表示成功，FALSE表示失败。5.2 停止预览BOOL StopRealPlay()功能：停止预览返回值：TRUE表示成功，FALSE表示失败。5.3 设置播放器帧缓冲区的个数 BOOL SetRealPlayBufNumber(long lBufNumber) 功能：设置播放器帧缓冲区的个数，在预览时

8、才有效 参数说明： lBufNumber：设置播放器帧缓冲区最大的帧数，取值为1-50。缓冲区越大， 图象越流畅；缓冲区越小，实时性越好。若是复合流建议最 小值设置成6。 返回值：TRUE表示成功，FALSE表示失败。5.4 设置预览时丢B帧个数 BOOL RealPlayThrowBFrame(long lThrowBType) 功能：设置解码时丢弃B帧的个数，在预览时才有效 参数说明： lThrowBType：丢B帧个数，0 - 不丢，1 丢一个， 2 丢2个 返回值：TRUE表示成功，FALSE表示失败。5.5 动态产生一个关键帧 BOOL MakeKeyFrame(long lChan

9、nelNum) 功能：网络预览时动态产生一个关键帧 参数说明： lChannelNum：通道号 返回值：TRUE表示成功，FALSE表示失败。5.6 开始零通道预览BOOL StartZeroRealPlay(long lZeroChannelNum, long lProtocolType, long lStreamType) 功能：开始零通道预览(画面比例为4：3，暂时不支持子码流预览，零通道不能控制云台，视频参数调节)参数说明：lZeroChannelNum: 播放零通道号， 0 - 代表通道1，1 - 代表通道2lProtocolType：协议类型，0 TCP， 1 - UDPlStre

10、amType： 码流类型，0 表示主码流， 1 表示子码流返回值：TRUE表示成功，FALSE表示失败。5.7 停止零通道预览BOOL StopZeroRealPlay()功能：停止零通道预览返回值：TRUE表示成功，FALSE表示失败。5.7 零通道预览画面翻页BOOL ZeroTurnOver(long lZeroChannelNum, BOOL bNextPreview)功能：零通道预览画面翻页参数说明：lZeroChannelNum 零通道号bNextPreview 翻页， TRUE - 下一页， FALSE - 上一页返回值：TRUE表示成功，FALSE表示失败。6.抓图6.1 抓B

11、MP图 BOOL BMPCapturePicture(LPCTSTR lpSavePath, BOOL bShowSaveFile) 功能：抓BMP图，在预览时才有效参数说明： lpSavePath：设置保存图片的路径。默认为C:OCXBMPCaptureFiles ，图片保存在写入路径的BMPCapture文件夹中bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹返回值：TRUE表示成功，FALSE表示失败。6.2 抓JPEG图 BOOL JPEGCapturePicture(long lChannelNum, short iPicSize, short iPicQualit

12、y, LPCTSTR lpSavePath, BOOL bShowSaveFile) 功能：抓JPEG图，不需要预览。当图像压缩分辨率为VGA时，支持0=CIF, 1=QCIF, 2=4CIF抓图，当分辨率为3=UXGA(1600x1200), 4=SVGA(800x600), 5=HD720p(1280x720),6=VGA,7=XVGA, 8=HD900p仅支持当前分辨率的抓图 参数说明： lChannelNum：通道号。1 - 代表通道1，2 代表通道2 iPicSize：分辨率 0=CIF, 1=QCIF, 2=4CIF 3=UXGA(1600x1200), 4=SVGA(800x60

13、0), 5=HD720p(1280x720),6=VGA iPicQuality：图片质量 0-最好 1-较好 2-一般 lpSavePath：设置保存图片的路径。默认为C:OCXJPEGCaptureFiles。图片保存在写入路径的JPEGCapture文件夹中。 bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹 返回值：TRUE表示成功，FALSE表示失败。6.3 按传入文件名抓BMP图BOOL BMPCapturePicV23(LPCTSTR lpSavePath, BOOL bShowSaveFile, LPCTSTR lpSaveFileName)功能：抓BMP图，

14、在预览时才有效参数说明： lpSavePath：设置保存图片的路径。默认为C:OCXBMPCaptureFiles ，图片保存在写入路径的BMPCapture文件夹中bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹lpSaveFileName：保存文件的名称，默认为IP_通道号_时间.bmp返回值：TRUE表示成功，FALSE表示失败。6.4 按传入文件名抓JPEG图BOOL JPEGCapturePicV23(long lChannelNum, short iPicSize, short iPicQuality, LPCTSTR lpSavePath, BOOL bShow

15、SaveFile, LPCTSTR lpSaveFileName)功能：抓JPEG图，不需要预览。当图像压缩分辨率为VGA时，支持0=CIF, 1=QCIF, 2=4CIF抓图，当分辨率为3=UXGA(1600x1200), 4=SVGA(800x600), 5=HD720p(1280x720),6=VGA,7=XVGA, 8=HD900p仅支持当前分辨率的抓图 参数说明： lChannelNum：通道号。1 - 代表通道1，2 代表通道2 iPicSize：分辨率 0=CIF, 1=QCIF, 2=4CIF 3=UXGA(1600x1200), 4=SVGA(800x600), 5=HD72

16、0p(1280x720),6=VGA iPicQuality：图片质量 0-最好 1-较好 2-一般 lpSavePath：设置保存图片的路径。默认为C:OCXJPEGCaptureFiles。图片保存在写入路径的JPEGCapture文件夹中。 bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹 lpSaveFileName: 保存图片的文件名，默认为IP_通道号_时间.jpeg返回值：TRUE表示成功，FALSE表示失败。7.对讲7.1 开始对讲 BOOL StartTalk(long lTalkChanNum) 功能：开始对讲 参数说明： lTalkChanNum：对讲通

17、道 返回值：TRUE表示成功，FALSE表示失败。7.2 停止对讲 BOOL StopTalk()功能：停止对讲 返回值：TRUE表示成功，FALSE表示失败。7.3 设置语音对讲声音 BOOL SetVoiceComClientVolume(long lVolume) 功能：设置语音对讲PC端的音量 参数说明： lVolume：设置的音量，取值为 0 10 返回值：TRUE表示成功，FALSE表示失败。8.云台控制8.1 云台控制开始BOOL PTZCtrlStart(long lCtrlType，long lSpeed)功能：云台开始控制命令，在预览时才有效参数说明： lCtrlType：

18、为云台动作：0 - 云台向上，1 - 云台向下，2 - 云台向左，3 - 云台向右， 4 - 焦距缩进，5 - 焦距拉远，6 - 焦点近，7 - 焦点远，8 - 光圈小，9 - 光圈大，10 自动, 11 灯光， 12 雨刷，13 - 云台左上, 14 - 云台右上, 15 - 云台左下, 16 - 云台右下。lSpeed：云台速度，范围为1 7。 如果值为0，则按照无带速接口控制云台。返回值：TRUE表示成功，FALSE表示失败。8.2 云台控制停止 BOOL PTZCtrlStop(long lCtrlType，long lSpeed) 功能：云台停止控制命令，在预览时才有效参数说明： l

19、CtrlType： 为云台动作：0 - 云台向上，1 - 云台向下，2 - 云台向左，3 - 云台向右， 4 - 焦距缩进，5 - 焦距拉远，6 - 焦点近，7 - 焦点远，8 - 光圈小，9 - 光圈大， 10 自动, 11 灯光， 12 雨刷，13 - 云台左上, 14 - 云台右上, 15 - 云台左下, 16 - 云台右下。lSpeed：云台速度，范围为1 7。 如果值为0，则按照无带速接口控制云台。返回值：TRUE表示成功，FALSE表示失败。8.3 设置预置点 BOOL PTZCtrlSetPreset(long lPresetNumber) 功能：设置云台预置位，需要预览参数说明

20、： lPresetNumber：云台预置位号，最多支持256个。返回值：TRUE表示成功，FALSE表示失败。8.4 调用预置点 BOOL PTZCtrlGotoPreset(long lPresetNumber) 功能：调用云台预置位，需要预览参数说明： lPresetNumber：云台预置位号，最多支持256个。返回值：TRUE表示成功，FALSE表示失败。9.视频参数9.1 获取视频参数 BSTR GetVideoEffect() 功能：获取视频参数，需要预览 返回值：以XML形式记录视频参数的一个字符串，返回空表示失败 形式： byBright /亮度 ( 取值为 1 10 ) byC

21、ontrast /对比度 ( 取值为 1- 10 ) bySaturation /饱和度 ( 取值为 1- 10 ) byHue /色调 ( 取值为 1 - 10 ) 9.2 设置视频参数 BOOL SetVideoEffect(long lBrightValue, long lContrastValue, long lSaturationValue, long lHueValue) 功能：设置视频参数，需要预览参数说明： lBrightValue：亮度 ( 取值为 1 10 ) lContrastValue： 对比度 ( 取值为 1- 10 ) lSaturationValue：饱和度 (

22、取值为 1- 10 ) lHueValue： 色调 ( 取值为 1 - 10 ) 返回值：TRUE表示成功，FALSE表示失败。10.声音控制10.1 设置声音模式 BOOL SetAudioMode(long lSoundMode) 功能：设置声音播放模式，需要在预览前设置参数说明： lSoundMode： 打开声音模式。 1 独占模式 ， 2 共享模式 返回值：TRUE表示成功，FALSE表示失败10.2 打开声音 BOOL OpenSound(long lSoundMode) 功能：打开声音，需要预览参数说明： lSoundMode： 打开声音模式。 1 独占模式 ， 2 共享模式 返回

23、值：TRUE表示成功，FALSE表示失败。10.3 关闭声音 BOOL CloseSound(long lSoundMode) 功能：关闭声音，需要预览参数说明： lSoundMode： 关闭声音模式。 1 独占模式， 2 共享模式 返回值：TRUE表示成功，FALSE表示失败。10.4 调节音量 BOOL SetVolume(long lVolume) 功能：调节音量参数说明： lVolume：设置的音量，取值为 0 9 返回值：TRUE表示成功，FALSE表示失败。11.录像11.1 开始录像 BOOL StartRecord(LPCTSTR lpSavePath) 功能：开始录像，在预览

24、时才有效参数说明： lpSavePath：设置保存录像文件的路径。默认为“C:OCXRecordFiles”。录像文件保存在写入路径的当前日期下。例如：C:OCXRecordFiles2009-07-13返回值：TRUE表示成功，FALSE表示失败。11.2 停止录像 BOOL StopRecord(BOOL bShowSaveFile) 功能：停止录像, 在预览时才有效 参数说明： bShowSaveFile 停止录像后是否弹出保存录像文件的文件夹 返回值：TRUE表示成功，FALSE表示失败。11.3 开始远程录像 BOOL StartRemoteRecord(long lChannelN

25、um) 功能：开始远程录像参数说明： lChannelNum：录像通道号 ，0 代表通道1 返回值：TRUE表示成功，FALSE表示失败。11.4 停止远程录像 BOOL StopRemoteRecord(long lChannelNum) 功能：停止远程录像 参数说明： lChannelNum：录像通道号，0 代表通道1 返回值：TRUE表示成功，FALSE表示失败。11.5 按传入文件名开始录像 BOOL StartRecordV23(LPCTSTR lpSavePath, LPCTSTR lpSaveFileName)功能：开始录像，在预览时才有效参数说明： lpSavePath：设置保

26、存录像文件的路径。默认为“C:OCXRecordFiles”。录像文件保存在写入路径的当前日期下。例如：C:OCXRecordFiles2009-07-13lpSaveFileName: 保存图片的文件名，默认为IP_通道号_时间.mp4返回值：TRUE表示成功，FALSE表示失败。12.远程回放12.1 获取录像文件 BSTR SearchRemoteRecordFile(long lChannelNum, long lFileType, LPCTSTR lpStartTime, LPCTSTR lpStopTime, BOOL bATMType， BOOL bNeedCardNum, LP

27、CTSTR lpCardNumber) 功能：获取录像文件 参数说明： lChannelNum：通道号，0 代表通道1，1 代表通道2 lFileType：查找文件的类型。如果不是 ATM机：bATMTyp为false, 0 全部， 1 定时录像， 2 移动侦测， 3 报警触发， 4 报警|动测， 5 报警&动测，6 命令触发， 7 手动触发。 如果是 ATM机：bATMType为true, 0 全部， 1 定时录像， 2 移动侦测， 3 接近报警， 4 出钞报警， 5 进钞报警， 6 命令触发， 7 手动触发， 8 震动报警。 lpStartTime：开始时间，格式为：2007-3-8 2:30:50。不能为空 lpStopTime：结束时间，格式为：2007-3-9 10:30:47。不能为空 bATMType：是否按卡号查询，TRUE表示 是，FALSE表示 不是 bNeedCardNum：是否需要卡号信息，TRUE表示是，FALSE表示不是 lpCardNumber：卡号信息 返回值：以XML形式记录所查询的远程录像文件的一个字符串。如果是“null”，代表没有录像文件。如果 是空表示失败，失败原因：lUserID小于0，通道号不存在，开始时间大于结束时间，获取文件列表失败，由于服务器忙,或网络故障,获取文件列表异常终止。 形式： SearchRem