海康威视开发ActiveX控件接口说明V3.docx
- 文档编号:26460703
- 上传时间:2023-06-19
- 格式:DOCX
- 页数:35
- 大小:435.74KB
海康威视开发ActiveX控件接口说明V3.docx
《海康威视开发ActiveX控件接口说明V3.docx》由会员分享,可在线阅读,更多相关《海康威视开发ActiveX控件接口说明V3.docx(35页珍藏版)》请在冰豆网上搜索。
海康威视开发ActiveX控件接口说明V3
海康威视ActiveX控件接口说明
V2.3版本()控件版本更新说明:
1.版本号改为2•増加接口:
BMPCapturePicV23xJPEGCapturePicV23sStartRecordV23
3.支持第三方IPC的添加更新:
1.増加添加数字通道时获取第三方IPC协议的接口
2•増加GetServerlPBylPServer接口通过IP-SERVER模式获取IP地址接口更新:
1.GetServerlnfo接口中増加获取零通道个数的节点
2.增加零通道相关接口z开始零通道预览、停止零通道预览、零通道预览画面翻页更新:
1・GetIPCConfig和SetDigitChannel接口増加是否启用快速添加节点。
用于95NVR
2.増加通过SADF获取在线IPC信息列表接口:
GetIPCInfoBySadp
3.增加修改SADF获取的在线IPC信息接口:
SetIPCameraInfo
方法:
1.1注册
longLogin(LPCTSTRIpServerIP,longIPort,LPCTSTRIpUserName,LPCTSTRIpPassword)
功能:
注册用户到硬盘录像机
参数说明:
IpServerIP:
硬盘录像机的IP地址
IPort:
硬盘录像机端口号
IpUserName:
登陆的用户名
IpPassword:
登陆的密码返回值:
lUserlD提供给其他接口使用。
J表示注册失败。
1.2设置UserID
BOOLSetUserID(longlUserlD)功能:
设置UserID,如果注册成功,可以通过该接口传入UserID.参数说明:
lUserlD:
要传入的UserID值返回值:
TRUE表示成功,FALSE表示失败。
2.注销
2.1注销
BOOLLogout()功能:
从硬盘录像机上注销某个用户返回值:
TRUE表示成功,FALSE表示失败。
2.2释放OCX
BOOLClearOCXO功能:
停止一切操作,例如录像、预览等操作返回值:
TRUE表示成功,FALSE表示失败。
3.解析IP地址
3.1利用普通域名解析IP地址
BSTRGetServerIP(LPCTSTRIpURL)功能:
域名方式登陆时解析所连接硬盘录像机的IP参数说明:
IpURL:
域名地址返回值:
返回解析到的硬盘录像机的IP地址z返回空表示失败。
3.2利用IP-SERVERS式获取IP地址
BSTRGetServerIPByIPServer(LPCTSTRlpDNSIPfLPCTSTRIpServerName,LPCTSTRIpSerialNumber)
功能:
从IP-Server服务器上获取IP地址,序列号和设备名称不能同时为空。
参数说明:
IpDNSIP:
DNSIP地址IpServerName:
设备名称
IpSerialNumber:
序歹I」号返回值:
返回解析到的硬盘录像机的IP地址,返回空表示失败
4.获取硬盘录像机的信息
BSTRGetServerInfo()功能:
获取硬盘录像机的信息,注册成功后才有效返回值:
以XML形式记录硬盘录像机信息的一个字符串。
形式:
xmlversion=10'?
>
输入个数
vZeroChanNum>byZeroChanNum/零通道个数
5・预览
5.1开始预览
BOOLStartRealPlay(longIChannelNumJongIProtocolType,IongIStreamType)
功能:
开始预览(如果调用了SetPlayWndType接口,预览画面就按照设置的比例显示。
如果没有,当前预览通道是HD720p或者HD900p的分辨率,预览画面自动变成16:
9的比例;如果获取不到分辨率,预览画面大小就是当前控件大小;其他分辨率时,预览画面为4:
3的比例)
参数说明:
IChannelNum:
播放通道号,0-代表通道1,1■代表通道2
IProtocoIType:
协议类型,0-TCP,―UDP
IStreamType:
码流类型,0表示主码流,1表示子码流返回值:
TRUE表示成功,FALSE表示失败。
5.2停止预览
BOOLStopRealPlayO功能:
停止预览返回值:
TRUE表示成功,FALSE表示失败。
5.3设置播放器帧缓冲区的个数
BOOLSetRealPlayBufNumber(longIBufNumber)功能:
设置播放器帧缓冲区的个数,在预览时才有效参数说明:
IBufNumber:
设置播放器帧缓冲区最大的帧数,取值为「50。
缓冲区越大,图象越流畅;缓冲区越小,实时性越好。
若是复合流建议最小值设置成60返回值:
TRUE表示成功,FALSE表示失败。
BOOLReaIPIayThrowBFrame(IongIThrowBType)功能:
设置解码时丢弃B帧的个数,在预览时才有效参数说明:
IThrowBType法B帧个数,0■不丢,1■丢一个,2-丢2个返回值:
TRUE表示成功,FALSE表示失败。
5.5动态产生一个关键帧
BOOLMakeKeyFrame(IongIChannelNum)功能:
网络预览时动态产生一个关键帧参数说明:
IChannelNum:
通道号
返回值:
TRUE表示成功,FALSE表示失败。
5.6开始零通道预览
BOOLStartZeroReaIPIay(IongIZeroChannelNum,IongIProtocoIType,longIStreamType)
功能:
开始零通道预览(画面比例为4:
3,暂时不支持子码流预览,零通道不能控制云台,视频参数调节)
参数说明:
IZeroChannelNum:
播放零通道号,0-代表通道1,1■•代表通道2
IProtocolType:
协议类型,0-TCP,1-UDP
IStreamType:
码流类型,0表示主码流,1表示子码流返回值:
TRUE表示成功,FALSE表示失败。
5.7停止零通道预览
BOOLStopZeroRealPlayO功能:
停止零通道预览返回值:
TRUE表示成功,FALSE表示失败。
5.7零通道预览画面翻页
BOOLZeroTurnOver(longIZeroChannelNum,BOOLbNextPreview)功能:
零通道预览画面翻页
参数说明:
IZeroChannGlNum零通道号bNextPreview翻页zTRUE-下一页,FALSE-上一页返回值:
TRUE表示成功,FALSE表示失败。
6.抓图
6.1抓BMP图
BOOLBMPCapturePicture(LPCTSTRIpSavePath,BOOLbShowSaveFile)功能:
抓BMP图,在预览时才有效
参数说明:
IpSavePath设置保存图片的路径。
默认为“C:
\OCXBMPC叩tureFiles;图片保存在写
入路径的BMPCapture文件夹中
bShowSaveFile抓图成功后是否弹岀保存图片文件的文件夹返回值:
TRUE表示成
功zFALSE表示失败。
&2抓JPEG图
BOOLJPEGCapturePicture(longIChannelNum,shortiPicSize,shortiPicQuality,LPCTSTRIpSavePath,BOOLbShowSaveFile)
功能:
抓JPEG图,不需要预览。
当图像压缩分辨率为VGA时,支持O=CIFZ"QCIF,2=4CIF抓图z当分辨率为3=UXGA(1600xl200)z4=SVGA(800x600)z
5=HD720p(1280x720)/6=VGAz7=XVGA/8=HD900p仅支持当前分辨率的抓图
参数说明:
IChannelNum:
通道号。
1■代表通道1,2-代表通道2
iPicSize:
分辨率0=CIF,1二QCIF,2=4CIF3=UXGA(1600xl200),4=SVGA(800x600),
5=HD720p(1280x720),6=VGA
iPicQuality:
图片质量0■最好1■较好2-—般
IpSavePath设置保存图片的路径。
默认为“C:
\OCXJPEGCaptureFiles”。
图片保存在写入路径的JPEGCapture文件夹中。
bShowSaveFile抓图成功后是否弹出保存图片文件的文件夹返回值:
TRUE表示成功zFALSE表示失败。
6.3按传入文件名抓BMF图
BOOLBMPCapturePicV23(LPCTSTRIpSavePath,BOOLbShowSaveFile,LPCTSTRIpSaveFileName)
功能:
抓BMP图z在预览时才有效
参数说明:
IpSavePath设置保存图片的路径。
默认为”C:
\OCXBMPCaptuvFiles”,图片保存在写入路径的BMPCapture文件夹中
bShowSaveFile抓图成功后是否弹出保存图片文件的文件夹
IpSaveFileName:
保存文件的名称,默认为”匚通道号一时间.bmp”返回值:
TRUE表示成功/FALSE表示失败。
6・4按传入文件名抓JPEG图
BOOLJPEGCapturePicV23(longIChannelNum,shortiPicSize,shortiPicQuality,LPCTSTRIpSavePath,BOOLbShowSaveFile,LPCTSTRIpSaveFileName)
功能:
抓JPEG图,不需要预览。
当图像压缩分辨率为VGA时z支持0二CIF,"QCIF,2=4CIF抓图,当分辨率为3=UXGA(1600xl200)/4=SVGA(800x600)/
5=HD720p(1280x720)r6=VGAz7=XVGAz8=HD900p仅支持当前分辨率的抓图参数说明:
IChannelNum:
通道号。
1■代表通道1,2-代表通道2
iPicSize:
分辨率0=CIF,1=QCIF,2=4CIF3=UXGA(1600xl200)/4=SVGA(800x600)z
5=HD720p(1280x720)z6=VGA
iPicQuality:
图片质量0■最好1■较好2-—般
IpSavePath设置保存图片的路径。
默认为“C:
\OCXJPEGCaptuvFiles”。
图片保存在写入路径的JPEGCapture文件夹中。
bShowSaveFile抓图成功后是否弹出保存图片文件的文件夹IpSaveFileName保存图片的文件名,默认为"_通道号一时间jpeg”返回值:
TRUE表示成功,FALSE表示失败。
7.对讲
7.1开始对讲
BOOLStartTalk(longITalkChanNum)功能:
开始对讲参数说明:
ITalkChanNum:
对讲通道返回值:
TRUE表示成功,FALSE表示失败。
7.2停止对讲
BOOLStopTalk()功能:
停止对讲返回值:
TRUE表示成功,FALSE表示失败。
7.3设置语音对讲声音
BOOLSetVoiceComClientVolume(longIVolume)功能:
设置语音对讲PC端的音量参数说明:
IVolume:
设置的音量z取值为0TO
返回值:
TRUE表示成功,FALSE表示失败。
&云台控制
8.1云台控制开始
BOOLPTZCtrlStart(longICtrlType,longISpeed)
功能:
云台开始控制命令,在预览时才有效
参数说明:
ICtrlType:
为云台动作:
0-云台向上,1-云台向下,2-云台向左,3-云台向右,4-焦距缩进,5-焦距拉远,6-焦点近,7一焦点远z8-光圈小,9一光圈大,10-自动Q■灯光,12-雨刷,13■云台左上云台右上,15-云台左下,16-云台右下。
ISpeed云台速度,范围为1-70如果值为0,则按照无带速接口控制
云台。
返回值:
TRUE表示成功,FALSE表示失败。
8.2云台控制停止
BOOLPTZCtrlStop(longICtrlType,longISpeed)
功能:
云台停止控制命令,在预览时才有效
参数说明:
ICtrlType:
为云台动作:
0-云台向上,1-云台向下,2-云台向左,3-云台向右,4-焦距缩进,5-焦距拉远,6-焦点近,7-焦点远,8-光圈小,9一光圈大,10■自动Q-灯光,12-雨刷,13■云台左上"■云台右上,15-云台左下,16-云台右下。
ISpeed云台速度,范围为1・7。
如果值为0,则按照无带速接口控制
云台。
返回值:
TRUE表示成功,FALSE表示失败。
8.3设置预置点
BOOLPTZCtrISetPreset(IongIPresetNumber)功能:
设置云台预置位,需要预览参数说明:
IPresetNumbe:
云台预置位号z最多支持256个返回值:
TRUE表示成功zFALSE表示失败。
8.4调用预置点
BOOLPTZCtrIGotoPreset(IongIPresetNumber)功能:
调用云台预置位/需要预览参数说明:
IPresetNumbe:
云台预置位号,最多支持256个
返回值:
TRUE表示成功,FALSE表示失败。
9.视频参数
9.1获取视频参数
BSTRGetVideoEffect()功能:
获取视频参数,需要预览返回值:
以XML形式记录视频参数的一个字符串,返回空表示失败形式:
xmlversion='1.0'?
>
9.2设置视频参数
BOOLSetVideoEffect(longIBrightValue,longIContrastValue,IongISaturationValue,longIHueValue)
功能:
设置视频参数,需要预览参数说明:
IBrightValue:
亮度(取值为1TO)IContrastValue:
对比度(取值为1-10)
ISaturationValue:
饱和度(取值为1-10)
IHueValue:
色调(取值为1-10)
返回值:
TRUE表示成功,FALSE表示失败。
10.声音控制
10.1设置声音模式
BOOLSetAudioMode(longISoundMode)功能:
设置声音播放模式,需要在预览前设置参数说明:
ISoundMode:
打开声音模式。
1-独占模式,2-共享模式返回值:
TRUE表示成功,FALSE表示失败
10.2打开声音
BOOLOpenSound(longISoundMode)功能:
打开声音,需要预览参数说明:
ISoundMode:
打开声音模式。
1-独占模式,2-共享模式返回值:
TRUE表示成功,FALSE表示失败。
10.3关闭声音
BOOLCIoseSound(IongISoundMode)功能:
关闭声音,需要预览参数说明:
ISoundMode:
关闭声音模式。
1■■独占模式,2-共享模式返回值:
TRUE表示成功,FALSE表示失败。
10.4调节音量
BOOLSetVolume(longIVolume)功能:
调节音量参数说明:
IVolume:
设置的音量,取值为0-9
返回值:
TRUE表示成功,FALSE表示失败。
11.录像
11.1开始录像
BOOLStartRecord(LPCTSTRIpSavePath)功能:
开始录像,在预览时才有效参数说明:
IpSavePath设置保存录像文件的路径。
默认为”C:
\OCXRecordFiles"。
录像文件保
存在写入路径的当前日期下。
例如:
C:
\OCXRecordFiles\2009-07-13返回值:
TRUE表示成功,FALSE表示失败。
11.2停止录像
BOOLStopRecord(BOOLbShowSaveFile)功能:
停止录像,在预览时才有效参数说明:
bShowSaveFile停止录像后是否弹岀保存录像文件的文件夹返回值:
TRUE表示成功/FALSE表示失败。
113开始远程录像
BOOLStartRemoteRecord(longIChannelNum)功能:
开始远程录像参数说明:
IChannelNum:
录像通道号,0-代表通道1返回值:
TRUE表示成功,FALSE表示失败。
11.4停止远程录像
BOOLStopRemoteRecord(longIChannelNum)功能:
停止远程录像参数说明:
IChannelNum:
录像通道号,0-代表通道1返回值:
TRUE表示成功,FALSE表示失败。
11.5按传入文件名开始录像
BOOLStartRecordV23(LPCTSTRIpSavePath,LPCTSTRIpSaveFileName)功能:
开始录像,在预览时才有效
参数说明:
IpSavePath设置保存录像文件的路径。
默认为“C:
\OCXRecordFiles00录像文件保存在写入路径的当前日期下。
例如:
C:
\OCXRecordFiles\2009-07-13
IpSaveFileName保存图片的文件名,默认为TP_通道号_时间.mp4”返回值:
TRUE表示成功,FALSE表示失败。
12.远程回放
12.1获取录像文件
BSTRSearchRemoteRecordFile(longIChannelNum,longIFileType,LPCTSTRIpStartTime,LPCTSTRIpStopTime,BOOLbATMType,BOOLbNeedCardNum,LPCTSTRIpCardNumber)
功能:
获取录像文件
参数说明:
IChannelNum:
通道号,0-代表通道1,1—代表通道2
IFileType:
查找文件的类型。
如果不是ATM机:
bATMTyp为false,0-全部z1■■定时录像,2-移动侦测,3■报警触发,4-报警|动测,5■报警&动测,6-命令触发,7-手动触发。
如果是ATM机:
bATMType为true,0-全部,1-定时录像,2-移动侦测z3-接近报警,4■出钞报警z5-进钞报警,6-命令触发,7■手动触发,8■震动报警。
IpStartTime:
开始时间,格式为:
2007-3-82:
30:
50o不能为空IpStopTime:
结束时间,格式为:
2007-3-910:
30:
47。
不能为空bATMType:
是否按卡号查询,TRUE表示是/FALSE表示不是bNeedCardNum是否需要卡号信息,TRUE表示是,FALSE表示不是IpCardNumber:
卡号信息
返回值:
以XML形式记录所查询的远程录像文件的一个字符串。
如果是
〃null〃,代表没有录像文件。
如果是空表示失败,失败原因:
lUserlD小于0,通道号不存在,开始时间大于结束时间,获取文件列表失败,由于服务器忙,或网络故障,获取文件列表异常终止。
形式:
xmlversion二,1.0'?
>
vlndex>dwlndexv/Index>
〃录像文件名称
〃录像文件开始时间
〃录像文件结束时间
〃录像文件的大小
〃录像文件名称
〃录像文件开始时间
〃录像文件结束时间
vlndex>dwlndexv/Index>
〃一样的N条记录
12.2按文件名回放
BOOLPlayBackByName(LPCTSTRIpFileName)
功能:
按文件名回放录像文件,如果调用了SetPlayWndType接口,就按设置的比例进行显示,否则就按主码流分辨率进行对应的比例显示。
参数说明:
IpFileName:
回放的文件名
返回值:
-TRUE表示成功,FALSE表示失败。
12.3按时间回放
BOOLPlayBackByTime(longIChannelNum,LPCTSTRIpStartTime,LPCTSTR
IpStopTime)
功能:
按时间回放录像文件,如果调用了SetPlayWndType接口,就按设置的比例进行显示,否则就按主码流分辨率进行对应的比例显示。
参数说明:
IChannelNum
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 康威 开发 ActiveX 控件 接口 说明 V3