海康威视OCX控件接口文档.docx
《海康威视OCX控件接口文档.docx》由会员分享,可在线阅读,更多相关《海康威视OCX控件接口文档.docx(25页珍藏版)》请在三一文库上搜索。
1、OCX控件接口说明V2.3版本方法:1.注册1.1 注册longLogin(LPCTSTRlpServerIP,long!Port,LPCTSTRIpUserName,LPCTSTRIpPassword)功能:注册用户到硬盘录像机参数说明:IpServerIP:硬盘录像机的IP地址!Port:硬盘录像机端口号IpUserName:登陆的用户名IpPassword:登陆的密码返回值:1USerlD提供应其他接口使用。-1表示注册失败。1.2 设置USerlDBOOLSetUserlD(longIUserID)功能:设置USeHD,如果注册成功,可以通过该接口传入USeUD.参数说明:IUserI
2、D:要传入的USeHD值返回值:TRUE表示成功,FALSE表示失败。2 .注销2.1 注销BOOLLogout()功能:从硬盘录像件上注销某个用户返回值:TRUE表示成功,FALSE表示失败。2.2 释放OCXBOOLClearOCXO功能:停止一切操作,例如录像、预览等操作返回值:TRUE表示成功,FALSE表示失败。3 .解析IP地址BSTRGetServerIP(LPCTSTRIpURL)功能:域名方式登陆时解析所连接硬盘录像机的IP参数说明:IpURL:域名地址返回值:返回解析到的硬盘录像机的IP地址,返回空表示失败。4 .获取硬盘录像机的信息BSTRGetServerInfoO功能
3、获取硬盘录像机的信息,注册成功后才有效返回值:以XML形式记录硬盘录像机信息的一个字符串。形式:byChanNum/模拟通道个数byDVRType类型byDiskNum硬盘数bySerialNumber序列号byAlarmInPortNum模拟通道报警输入个数byAIarmOutPortNum模拟通道报警输出个数byStartChan起始通道号byAudioChanNum语音通道个数VMaxDigitchannelNumAbyMaxDigitChannelNumv/MaXDigitCharmeINUm最大数字通道插槽数5.预览5.1 开始预览BOOLStartRealPlay(IongICh
4、annelNum,longIProtocolType,longIStreamType)功能:开始预览(如果调用了SetPlayWndTyPe接口,预览画面就按照设置的比例显示。如果没有,当前预览通道是HD720p或者HD900p的分辨率,预览画面自动变成16:9的比例;如果获取不到分辨率,预览画面大小就是当前控件大小;其他分辨率时,预览画面为4:3的比例)参数说明:IChannelNum:播放通道号,O-代表通道1,1-代表通道2lProtocolType:协议类型,0TCP,1-UDPIStreamType:码流类型,0表示主码流,1表示子码流返回值:TRUE表示成功,FALSE表示失败。5
5、 2停止预览BOOLStopRealPlayO功能:停止预览返回值:TRUE表示成功,FALSE表示失败。5.3设置播放器帧缓冲区的个数BOOLSetRealPlayBufNumber(longIBufNumber)功能:设置播放器帧缓冲区的个数,在预览时才有效参数说明:IBUfNUmber:设置播放器帧缓冲区最大的帧数,取值为1-50。缓冲区越大,图象越流畅;缓冲区越小,实时性越好。假设是复合流建议最小值设置成6o返回值:TRUE表示成功,FALSE表示失败。5 .4设置预览时丢B帧个数BOOLRealPlayThrowBFrame(longIThrowBType)功能:设置解码时丢弃B帧
6、的个数,在预览时才有效参数说明:IThrowBType:丢B帧个数,O-不丢,1-丢一个,2-丢2个返回值:TRUE表示成功,FALSE表示失败。6 .5动态产生一个关键帧BOOLMakeKeyFrame(longIChanneINum)功能:网络预览时动态产生一个关键帧参数说明:IChanneINum:通道号返回值:TRUE表示成功,FALSE表示失败。7 .抓图7.1 抓BMP图BOOLBMPCapturePicture(LPCTSTRIpSavePath,BOOLbShowSaveFile)功能:抓BMP图,在预览时才有效参数说明:IpSavePath:设置保存图片的路径。默认为C:OC
7、XBMPCaptureFiles”,图片保存在写入路径的BMPCapture文件夹中bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹返回值:TRUE表示成功,FALSE表示失败。7.2 抓JPEG图BOOLJPEGCapturePicture(longIChannelNum,shortiPicSize,shortiPicQuality,LPCTSTRIpSavePath,BOOLBShowSaveFiIe)功能:抓JPEG图,不需要预览。当图像压缩分辨率为VGA时,支持O=CIF,I=QCIF,2=4CIF抓图,当分辨率为3=UXGA(16(X)xl200),4=SVGA(8
8、00x600),5=HD720p(1280x720),6=VGA,7=XVGA,8=HD900p仅支持当前分辨率的抓图参数说明:IChannelNum:通道号。I-代表通道1,2-代表通道2iPicSize:分辨率O=CIF,I=QClF,2=4CIF3=UXGA(1600x1200),4=SVGA(800x600),5=HD720p(l280x720),6=VGAiPicQuality:图片质量O-最好I-较好2一般IpSavePath:设置保存图片的路径。默认为C:OCXJPEGCaptureFiles”。图片保存在写入路径的JPEGCapture文件夹中。bShowSaveFile:抓图
9、成功后是否弹出保存图片文件的文件夹返回值:TRUE表示成功,FALSE表示失败。8 .对讲8.1 开始对讲BOOLStartTalk(longITalkChanNum)功能:开始对讲参数说明:ITalkChanNum:对讲通道返回值:TRUE表示成功,FALSE表示失败。7. 2停止对讲BOOLStopTalkO功能:停止对讲返回值:TRUE表示成功,FALSE表示失败。8. 3设置语音对讲声音BOOLSetVoiceComClientVolume(long!Volume)功能:设置语音对讲PC端的音量参数说明:!Volume:设置的音量,取值为0-10返回值:TRUE表示成功,FALSE表示
10、失败。9. 云台控制9.1 云台控制开始BOOLPTZCtrlStart(longICtrlType,long!Speed)功能:云台开始控制命令,在预览时才有效参数说明:ICtrlType:为云台动作:O-云台向上,1-云台向下,2-云台向左,3-云台向右,4-焦距缩进,5-焦距拉远,6-焦点近,7-焦点远,8光圈小,9-光圈大,10-自动,11-灯光,12-雨刷,13-云台左上,14-云台右上,15-云台左下,16-云台右下。!Speed:云台速度,范围为如果值为0,那么按照无带速接口控制云台。返回值:TRUE表示成功,FALSE表示失败。9.2 云台控制停止BOOLPTZCtrlStop
11、longICtrlType,long!Speed)功能:云台停止控制命令,在预览时才有效参数说明:ICtrlType:为云台动作:O-云台向上,1-云台向下,2-云台向左,3-云台向右,4-焦距缩进,5-焦距拉远,6-焦点近,7-焦点远,8-光圈小,9-光圈大,10-自动,11-灯光,12-雨刷,13-云台左上,14-云台右上,15-云台左下,16-云台右下。!Speed:云台速度,范围为1-7。如果值为0,那么按照无带速接口控制云台。返回值:TRUE表示成功,FALSE表示失败。8 .3设置预置点BOOLPTZCtrlSetPreset(longIPresetNumber)功能:设置云台预
12、置位,需要预览参数说明:IPresetNumber:云台预置位号,最多支持256个。返回值:TRUE表示成功,FALSE表示失败。9 .4调用预置点BOOLPTZCtrlGotoPreset(longIPresetNumber)功能:调用云台预置位,需要预览参数说明:IPresetNumber:云台预置位号,最多支持256个。返回值:TRUE表示成功,FALSE表示失败。9.视频参数9.1 获取视频参数BSTRGetVideoEffectO功能:获取视频参数,需要预览返回值:以XML形式记录视频参数的一个字符串,返回空表示失败形式:byBright亮度(取值为1-10)byContrast比照
13、度(取值为1-10)bySaturation饱和度(取值为1-10)byHue色调(取值为1-10)9 .2设置视频参数BOOLSetVideoEffect(longIBrightVaIue,longIContrastValue,longISaturationValue,longIHueValue)功能:设置视频参数,需要预览参数说明:IBrightVaIue:亮度(取值为1-10)IContrastVaIue:比照度(取值为1-10)ISaturationValue:饱和度(取值为1-10)IHueValue:色调(取值为1-10)返回值:TRUE表示成功,FALSE表示失败。10 .声音控
14、制10.1 设置声音模式BOOLSetAudioMode(longISoundMode)功能:设置声音播放模式,需要在预览前设置参数说明:ISoundMode:翻开声音模式。1-独占模式,2-共享模式返回值:TRUE表示成功,FALSE表示失败10.2 翻开声音BOOLOpenSound(longISoundMode)功能:翻开声音,需要预览参数说明:ISoundMode:翻开声音模式。1-独占模式,2-共享模式返回值:TRUE表示成功,FALSE表示失败。10 .3关闭声音BOOLCloseSound(longISoundMode)功能:关闭声音,需要预览参数说明:ISoundMode:关闭
15、声音模式。1-独占模式,2-共享模式返回值:TRUE表示成功,FALSE表示失败。11 .4调节音量BOOLSetVolume(long!Volume)功能:调节音量参数说明:!Volume:设置的音量,取值为0-9返回值:TRUE表示成功,FALSE表示失败。11 .录像11.1 开始录像BOOLStartRecord(LPCTSTRIpSavePath)功能:开始录像,在预览时才有效参数说明:IpSavePath:设置保存录像文件的路径。默认为“C:OCXRecordFiles”。录像文件保存在写入路径的当前日期下。例如:C:OCXRecordFiles2009-07-l3返回值:TRUE
16、表示成功,FALSE表示失败。11.2 停止录像BOOLStopRecord(BOOLbShowSaveFile)功能:停止录像,在预览时才有效参数说明:bShowSaveFile停止录像后是否弹出保存录像文件的文件夹返回值:TRUE表示成功,FALSE表示失败。11.3 开始远程录像BOOLStartRemoteRecordClongIChannelNum)功能:开始远程录像参数说明:IChannelNum:录像通道号,0-代表通道1返回值:TRUE表示成功,FALSE表示失败。11.4 停止远程录像BOOLStopRemoteRecord(longIChannelNum)功能:停止远程录像
17、参数说明:IChannelNum:录像通道号,0-代表通道1返回值:TRUE表示成功,FALSE表示失败。12 .远程回放12.1 获取录像文件BSTRSearchRemoteRecordFile(longIChannelNum,longIFileType,LPCTSTRIpStartTime,LPCTSTRIpStopTime,BOOLbATMType,BOOLbNeedCardNum,LPCTSTRIpCardNumber)功能:获取录像文件参数说明:IChannelNum:通道号,。-代表通道1,1代表通道2IFileType:查找文件的类型。如果不是ATM机:bATMTyp为false
18、0-全部,1-定时录像,2-移动侦测,3-报警触发,4-报警I动测,5-报警&动测,6-命令触发,7-手动触发。如果是ArM机:bATMType为true,。-全部,1-定时录像,2-移动侦测,3-接近报警,4-出钞报警,5-进钞报警,6-命令触发,7-手动触发,8-震动报警。IpStartTime:开始时间,格式为:2007-3-82:30:50。不能为空IpStopTime:结束时间,格式为:2007-3-910:30:47。不能为空bATMType:是否按卡号查询,TRUE表示是,FALSE表示不是bNeedCardNum:是否需要卡号信息,TRUE表示是,FALSE表示不是IpCar
19、dNumber:卡号信息返回值:以XML形式记录所查询的远程录像文件的一个字符串。如果是“null”,代表没有录像文件。如果是空表示失败,失败原因:IUserID小于0,通道号不存在,开始时间大于结束时间,获取文件列表失败,由于效劳器忙,或网络故障,获取文件列表异常终止。形式:dwlndexsFileName录像文件名称StruStarlTimev/Starmme录像文件开始时间StruStopTime录像文件结束时间dwFileSize录像文件的大小dwlndexsFileName录像文件名称StrUStartTime/录像文件开始时间StruStopTime录像文件结束时间dwFileSi
20、ze录像文件的大小.一样的N条记录12.2 按文件名回放BOOLPlayBackByName(LPCTSTRIpFileName)功能:按文件名回放录像文件,如果调用了SetPIayWndTyPe接口,就按设置的比例进行显示,否那么就按主码流分辨率进行对应的比例显示。参数说明:IpFileName:回放的文件名返回值:-TRUE表示成功,FALSE表示失败。12.3 按时间回放BOOLPlayBackByTime(longIChannelNum,LPCTSTRIpStartTime,LPCTSTRIpStopTime)功能:按时间回放录像文件,如果调用了SetPlayWndTyPe接口,就按设
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 康威 OCX 控件 接口 文档
