客户端ocx控件开发说明

《客户端ocx控件开发说明》由会员分享，可在线阅读，更多相关《客户端ocx控件开发说明（26页珍藏版）》请在金锄头文库上搜索。

1、客户端客户端 OCXOCX 控件开发说明控件开发说明客户端 TCNVC.OCX 控件开发文档成都致精数码科技有限公司1. 简介TCNVC.OCX 是用来和视频监控服务端软件接口的客户端 ActiveX 控件.本文就如何利用 TCNVC.OCX 开发视频监控软件进行详细的描述.2. TCNVC.OCX 控件属性介绍1) Language属性说明:提供控件语言选择, 赋值为 0 代表简体中文, 赋值为 1 代表英文, 默认初始值为 0类型:long(读/写)2) MaxScreenLevel 属性说明:控件最大分屏数, 取值范围为 0-9, 分别代表 1, 2, 4, 6, 7, 8, 9, 10

2、, 13, 16 分屏, 默认初始值为 9类型:long(读/写)3) PanelColor属性说明: 控件背景底色, 以 RGB(r,g,b)标准取值, 默认值为 RGB(64,64,64)类型:long(读/写)4) ScreenColor属性说明: 视频显示屏幕的底色, 以 RGB(r,g,b)标准取值, 默认值为RGB(100,100,100)类型:long(读/写)5) BorderColor属性说明:视频显示屏幕的边框色, 以 RGB(r,g,b)标准取值, 默认值为RGB(100,100,100)类型:long(读/写)6) FocusColor属性说明:控件选择通道的边框高亮颜

3、色, 以 RGB(r,g,b)标准取值, 默认值为RGB(255,255,255)类型:long(读/写)7) ConnectTimeout属性说明:连接超时门限值, 默认值为 5000 毫秒类型:long(读/写)8) RecordPath属性说明:录像存储路径, 客户端录像时调用, 当参数为空字符串时弹出路径选择对话框, 默认为空字符串类型:BSTR(读/写)9) SnapshotPath属性说明:实时抓图存储路径, 客户端实时抓图时调用, 当参数为空字符串时弹出路径选择对话框, 默认为空字符串类型:BSTR(读/写)10) DownloadPath属性说明:远程录像文件下载存储路径, 客

4、户端远程录像文件检索和下载时调用, 当参数为空字符串时弹出路径选择对话框, 默认为空字符串类型:BSTR(读/写)11) AudioEnabled属性说明:客户端静音标志, 赋值为 0 开启静音功能, 赋值为 1 关闭静音功能, 默认初始值为 1类型:long(读/写)12) CurrentChannel属性说明:客户端当前选中的本地通道号, 也就是高亮通道号类型:long(读/写)13) AutoCutLower属性说明:自动断开低级连接, 赋值为 1 开启此功能, 赋值为 0 关闭此功能, 默认初始值为 0类型:long(读/写)14) PicInPic属性说明:启用画中画功能, 赋值为

5、1 启用此功能, 赋值为 0 关闭此功能, 默认初始值为 0类型:boolean(读/写)15) ScreenPicture属性说明控件视频窗口显示背景, 赋值为一个有效的 JPG 文件名, 此文件需和注册控件 TCNVC.OCX 文件在同一个目录类型:BSTR(读/写)16) ScreenMode属性说明:控件的分屏模式, 取值范围为 0-9, 分别代表 1, 2, 4, 6, 7, 8, 9, 10, 13, 16 分屏, 默认初始值为 0类型:long(读/写)17) DefaultServerMessagePort属性说明:默认远端服务器的控制命令端口号, 默认初始值为 8000类型:

6、long(读/写)18) DefaultServerAddress属性说明:默认远端服务器的 IP 地址或域名, 默认初始值为 127.0.0.1类型:long(读/写)3. TCNVC.OCX 控件方法介绍1) void DisconnectAll()功能说明:断开所有通道的连接 参数说明:无参数返回值:无返回值2) void Playback()功能说明:调用播放器 参数说明:无参数返回值:无返回值3) long GetUserType(long LocalChannel)功能说明:获取用户类别和权限 参数说明:long LocalChannel 本地通道号返回值:用户权限类别4) voi

7、d SetWarnConnect(long LocalChannel, long SetToWarn)功能说明:设置指定连接通道为报警连接, 应在 Connect 之前调用参数说明:long LocalChannel本地通道号long SetToWarn 报警连接标志, 赋值为 1 表示报警连接, 赋值为 0 表示非报警连接返回值无返回值5) void SetPipChildren(long LocalChannel, long Chlidren)功能说明:设置启用画中画的子窗口参数说明:long LocalChannel 本地通道号long Chlidren 画中画窗口标志, 1 表示此通道

8、作为画中画子窗口之一, 0 表示为普通视频窗口, 最多设置 4 个画中画子窗口返回值:无返回值6) long GetPipChildren(long LocalChannel)功能说明:查询指定通道是否为画中画的子窗口 参数说明:long LocalChannel 本地通道号返回值:0 表示此通道为普通视频窗口1 表示此通道为画中画子窗口7) BSTR SelectFolder()功能说明:弹出路径选择对话框, 做为控件提供的一个辅助工具参数说明:无参数返回值:路径选择操作后的全路径8) boolean IsExist()功能说明:判断客户端控件是否存在, 用于辅助 JavaScript 等

9、Html 脚本语言检查是否安装过控件 参数说明:无参数返回值:TRUE 存在FALSE 不存在9) boolean GetServerInfo(BSTR ServerAddress, long ServerMessagePort, BSTR UserName, BSTR Password)功能说明:获取服务端的信息, 也可应用于客户端登录操作参数说明:BSTR ServerAddress 服务器的 IP 地址或者域名long ServerMessagePort 服务器的控制命令端口BSTR UserName 用户名BSTR Password密码返回值:TRUE 获取信息成功FALSE 获取信息

10、失败10) long GetServerChannelNum(BSTR ServerAddress, long ServerMessagePort)功能说明:获取服务器端的通道数 参数说明:BSTR ServerAddress 服务器的 IP 地址或者域名long ServerMessagePort 服务器的控制命令端口返回值:服务器通道数(小于等于零为连接异常)11) BSTR GetServerChannelName(BSTR ServerAddress, long ServerMessagePort, long ChannelIndex)功能说明:获取服务器端的通道名参数说明:BSTR

11、ServerAddress 服务器的 IP 地址或者域名long ServerMessagePort 服务器的控制命令端口long ChannelIndex服务器端的通道号(通道号从 0 开始编号)返回值:服务器端的通道名12) boolean IsConnected(long LocalChannel)功能说明:查询指定的本地通道是否已经连接参数说明:long LocalChannel 本地通道号返回值TRUE 已连接FALSE 未连接13) boolean IsRecording(long LocalChannel)功能说明:查询指定通道是否正在录像 参数说明:long LocalChan

12、nel 本地通道号返回值:TRUR 正在录像FALSE 未录像14) boolean Disconnect(long LocalChannel)功能说明:断开指定通道连接参数说明:long LocalChannel 本地通道号返回值:TRUE 成功FALSE 失败15) boolean CtrlPTZ(long LocalChannel, BSTR CtrlCode, long ExternCode)功能说明:控制云台操作参数说明:long LocalChannel 本地通道号BSTR CtrlCode 云台控制命令“Up_Start“,“Up_Stop“ (向上)“Down_Start“,“

13、Down_Stop“ (向下)“Left_Start“,“Left_Stop“ (向左)“Right_Start“,“Right_Stop“ (向右)“DADD_Start“,“DADD_Stop“ (变倍增大)“DDEC_Start“,“DDEC_Stop“ (变倍减小)“AADD_Start“,“AADD_Stop“ (光圈增大)“ADEC_Start“,“ADEC_Stop“ (光圈减小)“FADD_Start“,“FADD_Stop“ (焦距增大)“FDEC_Start“,“FDEC_Stop“ (焦距减小)“Rotation“ (自动巡航)“SetPoint“ (设置预置位)“Got

14、oPoint“ (调用预置位)“SetPoint_Left“,“SetPoint_Right“ (设置左限位/右限位)“GotoPoint_Left“,“GotoPoint_Right“ (调用左限位/右限位)“Func1“,“Func2“,“Func3“,“Func4“ (辅助操作 1/辅助操作 2/辅助操作 3/辅助操作 4)long ExternCode云台控制扩展命令, 用于预置位调用时的预置位编号参数返回值:TRUE 成功FALSE 失败16) boolean StartRecord(long LocalChannel)功能说明:指定通道开始录像 参数说明:long LocalCha

15、nnel 本地通道号返回值:TRUE 成功FALSE 失败17) boolean StopRecord(long LocalChannel)功能说明:指定通道停止录像参数说明:long LocalChannel 本地通道号返回值:TRUE 成功FALSE 失败18) void StartRecordAll()功能说明:启动所有通道录像参数说明:无参数返回值:无返回值19) void StopRecordAll()功能说明:停止所有通道录像 参数说明:无参数返回值:无返回值20) void Download(BSTR ServerAddress, long ServerMessagePort,

16、BSTR UserName, BSTR Password)功能说明:下载远程录像文件 参数说明:BSTR ServerAddress 服务器的 IP 地址或者域名long ServerMessagePort 服务器的控制命令端口BSTR UserName 用户名BSTR Password 密码返回值:无返回值21) boolean IsWarnConnect(long LocalChannel)功能说明:查询指定通道是否为报警连接参数说明:long LocalChannel 本地通道号返回值:TRUE 是FALSE 否22) boolean Connect(long LocalChannel, BSTR ServerAddress, long ServerMessagePort, long ServerChannel, BSTR UserName, BSTR Password)功能说明:连接指定的服务器通道 参数说明:long LocalCha