OCX控件接口说明
V2.3版本
方法:
1.注册
1.1 注册
long Login(LPCTSTR lpServerIP, long lPort, LPCTSTR lpUserName, LPCTSTR lpPassword)
功能:注册用户到硬盘录像机
参数说明:
lpServerIP:硬盘录像机的IP地址
lPort:硬盘录像机端口号
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()
功能:停止一切操作,例如录像、预览等操作
返回值:TRUE表示成功,FALSE表示失败。
3.解析IP地址
BSTR GetServerIP(LPCTSTR lpURL)
功能:域名方式登陆时解析所连接硬盘录像机的IP
参数说明:
lpURL:域名地址
返回值:返回解析到的硬盘录像机的IP地址,返回空表示失败。
4.获取硬盘录像机的信息
BSTR GetServerInfo()
功能:获取硬盘录像机的信息,注册成功后才有效
返回值:以XML形式记录硬盘录像机信息的一个字符串。
形式:
<?xml version='1.0'?>
<ServerInfo>
< ChannelNumber> byChanNum </ChannelNumber >//getsavefilename模拟通道个数
< DVRType> byDVRType </DVRType> //类型
< DiskNumber> byDiskNum </DiskNumber> //硬盘数
< SerialNumber> bySerialNumber </SerialNumber> //序列号
< AlarmInPortNum> byAlarmInPortNum </AlarmPortNum> //模拟通道报警输入个数
<AlarmOutPortNum> byAlarmOutPortNum </AlarmOutPortNum> //模拟通道报警输出个数
< StartChannel> byStartChan </StartChannel> //起始通道号
<AudioChanNum>byAudioChanNum</AudioChanNum>
//语音通道个数
<MaxDigitChannelNum>byMaxDigitChannelNum</MaxDigitChannelNum>
//最大数字通道插槽数
</ServerInfo>
5.预览
5.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.2 停止预览
BOOL StopRealPlay()
功能:停止预览
返回值:TRUE表示成功,FALSE表示失败。
5.3 设置播放器帧缓冲区的个数
BOOL SetRealPlayBufNumber(long lBufNumber)
功能:设置播放器帧缓冲区的个数,在预览时才有效
参数说明:
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 lChannelNum)
功能:网络预览时动态产生一个关键帧
参数说明:
lChannelNum:通道号
返回值:TRUE表示成功,FALSE表示失败。
6.抓图
6.1 抓BMP图
BOOL BMPCapturePicture(LPCTSTR lpSavePath, BOOL bShowSaveFile)
功能:抓BMP图,在预览时才有效
参数说明:
lpSavePath:设置保存图片的路径。默认为"C:\OCXBMPCaptureFiles" ,图片保存在写入路径的BMPCapture文件夹中
bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹
返回值:TRUE表示成功,FALSE表示失败。
6.2 抓JPEG图
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:\OCXJPEGCaptureFiles"。图片保
存在写入路径的JPEGCapture文件夹中。
bShowSaveFile:抓图成功后是否弹出保存图片文件的文件夹
返回值:TRUE表示成功,FALSE表示失败。
7.对讲
7.1 开始对讲
BOOL StartTalk(long lTalkChanNum)
功能:开始对讲
参数说明:
lTalkChanNum:对讲通道
返回值: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:为云台动作: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)
功能:云台停止控制命令,在预览时才有效
参数说明:
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 设置预置点
BOOL PTZCtrlSetPreset(long lPresetNumber)
功能:设置云台预置位,需要预览
参数说明:
lPresetNumber:云台预置位号,最多支持256个。
返回值:TRUE表示成功,FALSE表示失败。
8.4 调用预置点
BOOL PTZCtrlGotoPreset(long lPresetNumber)
功能:调用云台预置位,需要预览
参数说明:
lPresetNumber:云台预置位号,最多支持256个。
返回值:TRUE表示成功,FALSE表示失败。
9.视频参数
9.1 获取视频参数
BSTR GetVideoEffect()
功能:获取视频参数,需要预览
返回值:以XML形式记录视频参数的一个字符串,返回空表示失败
形式:
<?xml version='1.0'?>
<VideoEffect>
<Bright>byBright</Bright> //亮度 ( 取值为 1 – 10 )
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论