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

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

《海康威视开发ActiveX控件接口说明V23.docx》由会员分享，可在线阅读，更多相关《海康威视开发ActiveX控件接口说明V23.docx（34页珍藏版）》请在冰豆网上搜索。

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

海康威视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.1注册

longLogin（LPCTSTRlpServerIP,longlPort,LPCTSTRlpUserName,LPCTSTRlpPassword）

功能：

注册用户到硬盘录像机

参数说明：

lpServerIP：

硬盘录像机的IP地址

lPort：

硬盘录像机端口号

lpUserName：

登陆的用户名

lpPassword：

登陆的密码

返回值：

lUserID提供给其他接口使用。

-1表示注册失败。

1.2设置UserID

BOOLSetUserID（longlUserID）

功能：

设置UserID，如果注册成功，可以通过该接口传入UserID.

参数说明：

lUserID：

要传入的UserID值

返回值：

TRUE表示成功，FALSE表示失败。

2.注销

2.1注销

BOOLLogout（）

功能：

从硬盘录像机上注销某个用户

返回值：

TRUE表示成功，FALSE表示失败。

2.2释放OCX

BOOLClearOCX（）

功能：

停止一切操作，例如录像、预览等操作

返回值：

TRUE表示成功，FALSE表示失败。

3.解析IP地址

3.1利用普通域名解析IP地址

BSTRGetServerIP（LPCTSTRlpURL）

功能：

域名方式登陆时解析所连接硬盘录像机的IP

参数说明：

lpURL：

域名地址

返回值：

返回解析到的硬盘录像机的IP地址，返回空表示失败。

3.2利用IP-SERVER模式获取IP地址

BSTRGetServerIPByIPServer（LPCTSTRlpDNSIP,LPCTSTRlpServerName,LPCTSTRlpSerialNumber）

功能：

从IP-Server服务器上获取IP地址，序列号和设备名称不能同时为空。

参数说明：

lpDNSIP：

DNSIP地址

lpServerName：

设备名称

lpSerialNumber：

序列号

返回值：

返回解析到的硬盘录像机的IP地址，返回空表示失败

4.获取硬盘录像机的信息

BSTRGetServerInfo（）

功能：

获取硬盘录像机的信息,注册成功后才有效

返回值：

以XML形式记录硬盘录像机信息的一个字符串。

形式：

xmlversion='1.0'?

>

byChanNum//模拟通道个数

byDVRType//类型

byDiskNum//硬盘数

bySerialNumber//序列号

byAlarmInPortNum//模拟通道报警输入个数

byAlarmOutPortNum//模拟通道报警输出个数

byStartChan//起始通道号

byAudioChanNum

//语音通道个数

byMaxDigitChannelNum

//最大数字通道插槽数

byZeroChanNum//零通道个数

5.预览

5.1开始预览

BOOLStartRealPlay（longlChannelNum,longlProtocolType,longlStreamType）

功能：

开始预览（如果调用了SetPlayWndType接口，预览画面就按照设置的比例显示。

如果没有，当前预览通道是HD720p或者HD900p的分辨率，预览画面自动变成16：

9的比例；如果获取不到分辨率，预览画面大小就是当前控件大小；其他分辨率时，预览画面为4：

3的比例）

参数说明：

lChannelNum：

播放通道号，0–代表通道1，1–代表通道2

lProtocolType：

协议类型，0–TCP，1-UDP

lStreamType：

码流类型，0表示主码流，1表示子码流

返回值：

TRUE表示成功，FALSE表示失败。

5.2停止预览

BOOLStopRealPlay（）

功能：

停止预览

返回值：

TRUE表示成功，FALSE表示失败。

5.3设置播放器帧缓冲区的个数

BOOLSetRealPlayBufNumber（longlBufNumber）

功能：

设置播放器帧缓冲区的个数，在预览时才有效

参数说明：

lBufNumber：

设置播放器帧缓冲区最大的帧数，取值为1-50。

缓冲区越大，图象越流畅；缓冲区越小，实时性越好。

若是复合流建议最小值设置成6。

返回值：

TRUE表示成功，FALSE表示失败。

5.4设置预览时丢B帧个数

BOOLRealPlayThrowBFrame（longlThrowBType）

功能：

设置解码时丢弃B帧的个数，在预览时才有效

参数说明：

lThrowBType：

丢B帧个数，0-不丢，1–丢一个，2–丢2个

返回值：

TRUE表示成功，FALSE表示失败。

5.5动态产生一个关键帧

BOOLMakeKeyFrame（longlChannelNum）

功能：

网络预览时动态产生一个关键帧

参数说明：

lChannelNum：

通道号

返回值：

TRUE表示成功，FALSE表示失败。

5.6开始零通道预览

BOOLStartZeroRealPlay（longlZeroChannelNum,longlProtocolType,longlStreamType）

功能：

开始零通道预览（画面比例为4：

3，暂时不支持子码流预览，零通道不能控制云台，视频参数调节）

参数说明：

lZeroChannelNum:

播放零通道号，0-代表通道1，1-代表通道2

lProtocolType：

协议类型，0–TCP，1-UDP

lStreamType：

码流类型，0表示主码流，1表示子码流

返回值：

TRUE表示成功，FALSE表示失败。

5.7停止零通道预览

BOOLStopZeroRealPlay（）

功能：

停止零通道预览

返回值：

TRUE表示成功，FALSE表示失败。

5.7零通道预览画面翻页

BOOLZeroTurnOver（longlZeroChannelNum,BOOLbNextPreview）

功能：

零通道预览画面翻页

参数说明：

lZeroChannelNum零通道号

bNextPreview翻页，TRUE-下一页，FALSE-上一页

返回值：

TRUE表示成功，FALSE表示失败。

6.抓图

6.1抓BMP图

BOOLBMPCapturePicture（LPCTSTRlpSavePath,BOOLbShowSaveFile）

功能：

抓BMP图，在预览时才有效

参数说明：

lpSavePath：

设置保存图片的路径。

默认为"C:

\OCXBMPCaptureFiles"，图片保存在写入路径的BMPCapture文件夹中

bShowSaveFile:

抓图成功后是否弹出保存图片文件的文件夹

返回值：

TRUE表示成功，FALSE表示失败。

6.2抓JPEG图

BOOLJPEGCapturePicture（longlChannelNum,shortiPicSize,shortiPicQuality,LPCTSTRlpSavePath,BOOLbShowSaveFile）

功能：

抓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=4CIF3=UXGA（1600x1200）,4=SVGA（800x600）,5=HD720p（1280x720）,6=VGA

iPicQuality：

图片质量0-最好1-较好2-一般

lpSavePath：

设置保存图片的路径。

默认为"C:

\OCXJPEGCaptureFiles"。

图片保存在写入路径的JPEGCapture文件夹中。

bShowSaveFile:

抓图成功后是否弹出保存图片文件的文件夹

返回值：

TRUE表示成功，FALSE表示失败。

6.3按传入文件名抓BMP图

BOOLBMPCapturePicV23（LPCTSTRlpSavePath,BOOLbShowSaveFile,LPCTSTRlpSaveFileName）

功能：

抓BMP图，在预览时才有效

参数说明：

lpSavePath：

设置保存图片的路径。

默认为"C:

\OCXBMPCaptureFiles"，图片保存在写入路径的BMPCapture文件夹中

bShowSaveFile:

抓图成功后是否弹出保存图片文件的文件夹

lpSaveFileName：

保存文件的名称，默认为"IP_通道号_时间.bmp"

返回值：

TRUE表示成功，FALSE表示失败。

6.4按传入文件名抓JPEG图

BOOLJPEGCapturePicV23（longlChannelNum,shortiPicSize,shortiPicQuality,LPCTSTRlpSavePath,BOOLbShowSaveFile,LPCTSTRlpSaveFileName）

功能：

抓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=4CIF3=UXGA（1600x1200）,4=SVGA（800x600）,5=HD720p（1280x720）,6=VGA

iPicQuality：

图片质量0-最好1-较好2-一般

lpSavePath：

设置保存图片的路径。

默认为"C:

\OCXJPEGCaptureFiles"。

图片保存在写入路径的JPEGCapture文件夹中。

bShowSaveFile:

抓图成功后是否弹出保存图片文件的文件夹

lpSaveFileName:

保存图片的文件名，默认为"IP_通道号_时间.jpeg"

返回值：

TRUE表示成功，FALSE表示失败。

7.对讲

7.1开始对讲

BOOLStartTalk（longlTalkChanNum）

功能：

开始对讲

参数说明：

lTalkChanNum：

对讲通道

返回值：

TRUE表示成功，FALSE表示失败。

7.2停止对讲

BOOLStopTalk（）

功能：

停止对讲

返回值：

TRUE表示成功，FALSE表示失败。

7.3设置语音对讲声音

BOOLSetVoiceComClientVolume（longlVolume）

功能：

设置语音对讲PC端的音量

参数说明：

lVolume：

设置的音量，取值为0–10

返回值：

TRUE表示成功，FALSE表示失败。

8.云台控制

8.1云台控制开始

BOOLPTZCtrlStart（longlCtrlType，longlSpeed）

功能：

云台开始控制命令，在预览时才有效

参数说明：

lCtrlType：

为云台动作：

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云台控制停止

BOOLPTZCtrlStop（longlCtrlType，longlSpeed）

功能：

云台停止控制命令，在预览时才有效

参数说明：

lCtrlType：

为云台动作：

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设置预置点

BOOLPTZCtrlSetPreset（longlPresetNumber）

功能：

设置云台预置位，需要预览

参数说明：

lPresetNumber：

云台预置位号，最多支持256个。

返回值：

TRUE表示成功，FALSE表示失败。

8.4调用预置点

BOOLPTZCtrlGotoPreset（longlPresetNumber）

功能：

调用云台预置位，需要预览

参数说明：

lPresetNumber：

云台预置位号，最多支持256个。

返回值：

TRUE表示成功，FALSE表示失败。

9.视频参数

9.1获取视频参数

BSTRGetVideoEffect（）

功能：

获取视频参数，需要预览

返回值：

以XML形式记录视频参数的一个字符串，返回空表示失败

形式：

xmlversion='1.0'?

>

byBright//亮度（取值为1–10）

byContrast//对比度（取值为1-10）

bySaturation//饱和度（取值为1-10）

byHue//色调（取值为1-10）

9.2设置视频参数

BOOLSetVideoEffect（longlBrightValue,longlContrastValue,longlSaturationValue,longlHueValue）

功能：

设置视频参数，需要预览

参数说明：

lBrightValue：

亮度（取值为1–10）

lContrastValue：

对比度（取值为1-10）

lSaturationValue：

饱和度（取值为1-10）

lHueValue：

色调（取值为1-10）

返回值：

TRUE表示成功，FALSE表示失败。

10.声音控制

10.1设置声音模式

BOOLSetAudioMode（longlSoundMode）

功能：

设置声音播放模式，需要在预览前设置

参数说明：

lSoundMode：

打开声音模式。

1–独占模式，2–共享模式

返回值：

TRUE表示成功，FALSE表示失败

10.2打开声音

BOOLOpenSound（longlSoundMode）

功能：

打开声音，需要预览

参数说明：

lSoundMode：

打开声音模式。

1–独占模式，2–共享模式

返回值：

TRUE表示成功，FALSE表示失败。

10.3关闭声音

BOOLCloseSound（longlSoundMode）

功能：

关闭声音，需要预览

参数说明：

lSoundMode：

关闭声音模式。

1–独占模式，2–共享模式

返回值：

TRUE表示成功，FALSE表示失败。

10.4调节音量

BOOLSetVolume（longlVolume）

功能：

调节音量

参数说明：

lVolume：

设置的音量，取值为0–9

返回值：

TRUE表示成功，FALSE表示失败。

11.录像

11.1开始录像

BOOLStartRecord（LPCTSTRlpSavePath）

功能：

开始录像，在预览时才有效

参数说明：

lpSavePath：

设置保存录像文件的路径。

默认为“C:

\OCXRecordFiles”。

录像文件保存在写入路径的当前日期下。

例如：

C:

\OCXRecordFiles\2009-07-13

返回值：

TRUE表示成功，FALSE表示失败。

11.2停止录像

BOOLStopRecord（BOOLbShowSaveFile）

功能：

停止录像,在预览时才有效

参数说明：

bShowSaveFile停止录像后是否弹出保存录像文件的文件夹

返回值：

TRUE表示成功，FALSE表示失败。

11.3开始远程录像

BOOLStartRemoteRecord（longlChannelNum）

功能：

开始远程录像

参数说明：

lChannelNum：

录像通道号，0–代表通道1

返回值：

TRUE表示成功，FALSE表示失败。

11.4停止远程录像

BOOLStopRemoteRecord（longlChannelNum）

功能：

停止远程录像

参数说明：

lChannelNum：

录像通道号，0–代表通道1

返回值：

TRUE表示成功，FALSE表示失败。

11.5按传入文件名开始录像

BOOLStartRecordV23（LPCTSTRlpSavePath,LPCTSTRlpSaveFileName）

功能：

开始录像，在预览时才有效

参数说明：

lpSavePath：

设置保存录像文件的路径。

默认为“C:

\OCXRecordFiles”。

录像文件保存在写入路径的当前日期下。

例如：

C:

\OCXRecordFiles\2009-07-13

lpSaveFileName:

保存图片的文件名，默认为"IP_通道号_时间.mp4"

返回值：

TRUE表示成功，FALSE表示失败。

12.远程回放

12.1获取录像文件

BSTRSearchRemoteRecordFile（longlChannelNum,longlFileType,LPCTSTRlpStartTime,LPCTSTRlpStopTime,BOOLbATMType，BOOLbNeedCardNum,LPCTSTRlpCardNumber）

功能：

获取录像文件

参数说明：

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-82:

30:

50。

不能为空

lpStopTime：

结束时间，格式为：

2007-3-910:

30:

47。

不能为空

bATMType：

是否按卡号查询，TRUE表示是，FALSE表示不是

bNeedCardNum：

是否需要卡号信息，TRUE表示是，FALSE表示不是

lpCardNumber：

卡号信息

返回值：

以XML形式记录所查询的远程录像文件的一个字符串。

如果是“null”，代表没有录像文件。

如果是空表示失败，失败原因：

lUserID小于0，通道号不存在，开始时间大于结束时间，获取文件列表失败，由于服务器忙,或网络故障,获取文件列表异常终止。

形式：

xmlversion='1.0'?

>