NetVideoActiveX视频OCX控件接口定义.docx
《NetVideoActiveX视频OCX控件接口定义.docx》由会员分享，可在线阅读，更多相关《NetVideoActiveX视频OCX控件接口定义.docx（20页珍藏版）》请在冰豆网上搜索。
NetVideoActiveX视频OCX控件接口定义
OCX控件接口定义
属性:
lLanguageType语言版本.0—简体中文,1—英文,2—繁体中文
方法:
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地址
BSTRGetServerIP（LPCTSTRlpURL）
功能：
域名方式登陆时解析所连接硬盘录像机的IP
参数说明：
lpURL：
域名地址
返回值：
返回解析到的硬盘录像机的IP地址，返回空表示失败。
4.获取硬盘录像机的信息
BSTRGetServerInfo（）
功能：
获取硬盘录像机的信息,注册成功后才有效
返回值：
以XML形式记录硬盘录像机信息的一个字符串。
形式：
xmlversion='1.0'?
>
byChanNum//通道个数
byDVRType//类型
byDiskNum//硬盘数
bySerialNumber//序列号
byAlarmInPortNum//报警输入个数
byAlarmOutPortNum//报警输出个数
byStartChan//起始通道号
5.预览
5.1开始预览
BOOLStartRealPlay（longlChannelNum,longlProtocolType,longlStreamType）
功能：
开始预览
参数说明：
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表示失败。
6.抓图
6.1抓BMP图
BOOLBMPCapturePicture（LPCTSTRlpSavePath,BOOLbShowSaveFile）
功能：
抓BMP图，在预览时才有效
参数说明：
lpSavePath：
设置保存图片的路径。
默认为“C:
\OCXSaveAllFiles\”，图片保存在写入路径的BMPCapture文件夹中。
bShowSaveFile:
抓图成功后是否弹出保存图片文件的文件夹
返回值：
TRUE表示成功，FALSE表示失败。
6.2抓JPEG图
BOOLJPEGCapturePicture（longlChannelNum,shortiPicSize,shortiPicQuality,LPCTSTRlpSavePath,BOOLbShowSaveFile）
功能：
抓JPEG图，不需要预览
参数说明：
lChannelNum：
通道号。
1-代表通道1，2–代表通道2
iPicSize：
分辨率0--CIF,1--QCIF,2--D1
iPicQuality：
图片质量0-最好1-较好2-一般
lpSavePath：
设置保存图片的路径。
默认为“C:
\OCXSaveAllFiles\”。
图片保存在写入路径的JPEGCapture文件夹中。
bShowSaveFile:
抓图成功后是否弹出保存图片文件的文件夹
返回值：
TRUE表示成功，FALSE表示失败。
7.对讲
7.1开始对讲
BOOLStartTalk（）
功能：
开始对讲
返回值：
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：
云台预置位号，最多支持128个。
返回值：
TRUE表示成功，FALSE表示失败。
8.4调用预置点
BOOLPTZCtrlGotoPreset（longlPresetNumber）
功能：
调用云台预置位，需要预览
参数说明：
lPresetNumber：
云台预置位号，最多支持128个。
返回值：
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–独占模
升级会员 