海康威视海康威视 ActiveX 控件接口说明控件接口说明V2.3 版本版本(20100611)控件版本更新说明: 1. 版本号改为 2.3.9.1 2. 增加接口:BMPCapturePicV23、JPEGCapturePicV23、StartRecordV23 3. 支持第三方 IPC 的添加 20100115 更新: 1. 增加添加数字通道时获取第三方 IPC 协议的接口 2. 增加 GetServerIPByIPServer 接口通过 IP-SERVER 模式获取 IP 地址接口 20100405 更新: 1. GetServerInfo 接口中增加获取零通道个数的节点 2. 增加零通道相关接口,开始零通道预览、停止零通道预览、零通道预览画面 翻页 20100510 更新: 1. GetIPCConfig 和 SetDigitChannel 接口增加是否启用快速添加节点用于 95NVR 2. 增加通过 SADP 获取 IPC 信息列表接口:GetIPCInfoBySadp 3. 增加修改 SADP 获取的 IPC 信息接口:SetIPCameraInfo方法方法:1.注册注册1.11.1 注册注册long Login(LPCTSTR lpServerIP, long lPort, LPCTSTR lpUserName, LPCTSTR lpPassword) 功能:注册用户到硬盘录像机 参数说明: lpServerIP:硬盘录像机的 IP 地址 lPort:硬盘录像机端口号 lpUserName:登陆的用户名 lpPassword:登陆的密码 返回值:lUserID 提供给其他接口使用。
1 表示注册失败1.2 设置设置 UserIDUserIDBOOL SetUserID(long lUserID)功能:设置 UserID,如果注册成功,可以通过该接口传入 UserID.参数说明: lUserID:要传入的 UserID 值 返回值:TRUE 表示成功,FALSE 表示失败2.2.注销注销2.12.1 注销注销BOOL Logout() 功能:从硬盘录像机上注销某个用户 返回值:TRUE 表示成功,FALSE 表示失败2.2 释放释放 OCXOCXBOOL ClearOCX() 功能:停止一切操作,例如录像、预览等操作 返回值:TRUE 表示成功,FALSE 表示失败3.3.解析解析 IPIP 地址地址3.13.1 利用普通域名解析利用普通域名解析 IPIP 地址地址BSTR GetServerIP(LPCTSTR lpURL) 功能:域名方式登陆时解析所连接硬盘录像机的 IP 参数说明: lpURL:域名地址 返回值:返回解析到的硬盘录像机的 IP 地址,返回空表示失败3.23.2 利用利用 IP-SERVERIP-SERVER 模式获取模式获取 IPIP 地址地址BSTR GetServerIPByIPServer (LPCTSTR lpDNSIP, LPCTSTR lpServerName, LPCTSTR lpSerialNumber) 功能:从 IP-Server 服务器上获取 IP 地址,序列号和设备名称不能同时为 空。
参数说明: lpDNSIP: DNS IP 地址 lpServerName: 设备名称 lpSerialNumber:序列号 返回值:返回解析到的硬盘录像机的 IP 地址,返回空表示失败4.获取硬盘录像机的信息获取硬盘录像机的信息BSTR GetServerInfo() 功能:获取硬盘录像机的信息,注册成功后才有效 返回值:以 XML 形式记录硬盘录像机信息的一个字符串 形式:byChanNum //模拟通道个 数byDVRType //类型byDiskNum //硬盘数bySerialNumber //序列号byAlarmInPortNum //模拟通道报警输入个数byAlarmOutPortNum //模拟通道报警输出个数byStartChan //起始通道号 byAudioChanNum //语音通道个数byMaxDigitChannelNum //最大数字通道插槽数 byZeroChanNum//零通道个数5.5.预览预览5.15.1 开始预览开始预览BOOL StartRealPlay(long lChannelNum ,long lProtocolType, long lStreamType) 功能:开始预览(如果调用了 SetPlayWndType 接口,预览画面就按照设 置的比例显示。
如果没有,当前预览通道是 HD720p 或者 HD900p 的分辨率,预 览画面自动变成 16:9 的比例;如果获取不到分辨率,预览画面大小就是当前控 件大小;其他分辨率时,预览画面为 4:3 的比例) 参数说明: lChannelNum:播放通道号, 0 – 代表通道 1,1 – 代表通道 2 lProtocolType:协议类型,0 – TCP, 1 - UDP lStreamType: 码流类型,0 表示主码流, 1 表示子码流 返回值:TRUE 表示成功,FALSE 表示失败5.25.2 停止预览停止预览BOOL StopRealPlay() 功能:停止预览 返回值:TRUE 表示成功,FALSE 表示失败5.35.3 设置播放器帧缓冲区的个数设置播放器帧缓冲区的个数BOOL SetRealPlayBufNumber(long lBufNumber) 功能:设置播放器帧缓冲区的个数,在预览时才有效 参数说明: lBufNumber:设置播放器帧缓冲区最大的帧数,取值为 1-50缓冲区越 大, 图象越流畅;缓冲区越小,实时性越好若是复合流建 议最 小值设置成 6 返回值:TRUE 表示成功,FALSE 表示失败。
5.45.4 设置预览时丢设置预览时丢 B B 帧个数帧个数BOOL RealPlayThrowBFrame(long lThrowBType) 功能:设置解码时丢弃 B 帧的个数,在预览时才有效 参数说明: lThrowBType:丢 B 帧个数,0 - 不丢,1 – 丢一个, 2 – 丢 2 个 返回值:TRUE 表示成功,FALSE 表示失败5.55.5 动态产生一个关键帧动态产生一个关键帧BOOL MakeKeyFrame(long lChannelNum) 功能:网络预览时动态产生一个关键帧 参数说明: lChannelNum:通道号 返回值:TRUE 表示成功,FALSE 表示失败5.65.6 开始零通道预览开始零通道预览BOOL StartZeroRealPlay(long lZeroChannelNum, long lProtocolType, long lStreamType) 功能:开始零通道预览(画面比例为 4:3,暂时不支持子码流预览,零通 道不能控制云台,视频参数调节) 参数说明: lZeroChannelNum:播放零通道号, 0 - 代表通道 1,1 - 代表通道 2 lProtocolType:协议类型,0 – TCP, 1 - UDPlStreamType: 码流类型,0 表示主码流, 1 表示子码流 返回值:TRUE 表示成功,FALSE 表示失败。
5.75.7 停止零通道预览停止零通道预览BOOL StopZeroRealPlay() 功能:停止零通道预览 返回值:TRUE 表示成功,FALSE 表示失败5.75.7 零通道预览画面翻页零通道预览画面翻页BOOL ZeroTurnOver(long lZeroChannelNum, BOOL bNextPreview) 功能:零通道预览画面翻页 参数说明: lZeroChannelNum零通道号 bNextPreview翻页, TRUE - 下一页, FALSE - 上一页 返回值:TRUE 表示成功,FALSE 表示失败6.6.抓图抓图6.16.1 抓抓 BMPBMP 图图BOOL BMPCapturePicture(LPCTSTR lpSavePath, BOOL bShowSaveFile) 功能:抓 BMP 图,在预览时才有效 参数说明: lpSavePath:设置保存图片的路径默认为“C:\OCXBMPCaptureFiles“ , 图片保存在写入路径的 BMPCapture 文件夹中 bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹 返回值:TRUE 表示成功,FALSE 表示失败。
6.26.2 抓抓 JPEGJPEG 图图BOOL JPEGCapturePicture(long lChannelNum, short iPicSize, short iPicQuality, 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(800x600), 5=HD720p(1280x720),6=VGA iPicQuality:图片质量 0-最好 1-较好 2-一般 lpSavePath:设置保存图片的路径默认为“C:\OCEGCaptureFiles“。
图片保存在写入路径的 JPEGCapture 文件夹中 bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹 返回值:TRUE 表示成功,FALSE 表示失败6.36.3 按传入文件名抓按传入文件名抓 BMPBMP 图图BOOL BMPCapturePicV23(LPCTSTR lpSavePath, BOOL bShowSaveFile, LPCTSTR lpSaveFileName) 功能:抓 BMP 图,在预览时才有效 参数说明: lpSavePath:设置保存图片的路径默认为“C:\OCXBMPCaptureFiles“ , 图片保存在写入路径的 BMPCapture 文件夹中 bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹 lpSaveFileName:保存文件的名称,默认为“IP_通道号_时间.bmp“ 返回值:TRUE 表示成功,FALSE 表示失败6.46.4 按传入文件名抓按传入文件名抓 JPEGJPEG 图图BOOL JPEGCapturePicV23(long lChannelNum, short iPicSize, short iPicQuality, LPCTSTR lpSavePath, BOOL bShowSaveFile, 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=HD720p(1280x720),6=。