客户端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, 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
属性说明:
控件选择通道的边框高亮颜色, 以RGB(r,g,b)标准取值, 默认值为RGB(255,255,255)
类型:
long(读/写)
7) ConnectTimeout
属性说明:
连接超时门限值, 默认值为5000毫秒
类型:
long(读/写)
8) RecordPath
属性说明:
录像存储路径, 客户端录像时调用, 当参数为空字符串时弹出路径选择对话框, 默认为空字符串
类型:
BSTR(读/写)
9) SnapshotPath
属性说明:
实时抓图存储路径, 客户端实时抓图时调用, 当参数为空字符串时弹出路径选择对话框, 默认为空字符串
类型:
BSTR(读/写)
10) DownloadPath
属性说明:
远程录像文件下载存储路径, 客户端远程录像文件检索和下载时调用, 当参数为空字符串时弹出路径选择对话框, 默认为空字符串
类型:
BSTR(读/写)
11) AudioEnabled
属性说明:
客户端静音标志, 赋值为0开启静音功能, 赋值为1关闭静音功能, 默认初始值为1
类型:
long(读/写)
12) CurrentChannel
属性说明:
客户端当前选中的本地通道号, 也就是高亮通道号
类型:
long(读/写)
13) AutoCutLower
属性说明:
自动断开低级连接, 赋值为1开启此功能, 赋值为0关闭此功能, 默认初始值为0
类型:
long(读/写)
14) PicInPic
属性说明:
启用画中画功能, 赋值为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
类型:
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) void SetWarnConnect(long LocalChannel, long SetToWarn)
功能说明:
设置指定连接通道为报警连接, 应在Connect之前调用
参数说明:
long LocalChannel
本地通道号
long SetToWarn
报警连接标志, 赋值为1表示报警连接, 赋值为0表示非报警连接
返回值
无返回值
5) void SetPipChildren(long LocalChannel, long Chlidren)
功能说明:
设置启用画中画的子窗口
参数说明:
long LocalChannel
本地通道号
long Chlidren
画中画窗口标志, 1表示此通道作为画中画子窗口之一, 0表示为普通视频窗口, 最多设置4个画中画子窗口
返回值:
无返回值
6) long GetPipChildren(long LocalChannel)
功能说明:
查询指定通道是否为画中画的子窗口
参数说明:
long LocalChannel
本地通道号
返回值:
0 表示此通道为普通视频窗口
1 表示此通道为画中画子窗口
7) BSTR SelectFolder()
功能说明:
弹出路径选择对话框, 做为控件提供的一个辅助工具
参数说明:
无参数
返回值:
路径选择操作后的全路径
8) boolean IsExist()
功能说明:
判断客户端控件是否存在, 用于辅助JavaScript等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) long GetServerChannelNum(BSTR ServerAddress, long ServerMessagePort)
功能说明:
获取服务器端的通道数
参数说明:
BSTR ServerAddress
服务器的IP地址或者域名
long ServerMessagePort
服务器的控制命令端口
返回值:
服务器通道数(小于等于零为连接异常)
11) BSTR GetServerChannelName(BSTR ServerAddress, long ServerMessagePort, long ChannelIndex)
功能说明:
获取服务器端的通道名
参数说明:
BSTR ServerAddress
服
务器的IP地址或者域名
long ServerMessagePort
服务器的控制命令端口
long ChannelIndex
服务器端的通道号(通道号从0开始编号)
返回值:
服务器端的通道名
12) boolean IsConnected(long LocalChannel)
功能说明:
查询指定的本地通道是否已经连接
参数说明:
long LocalChannel
本地通道号
返回值
TRUE 已连接
FALSE 未连接
13) boolean IsRecording(long LocalChannel)
功能说明:
查询指定通道是否正在录像
参数说明:
long LocalChannel
本地通道号
返回值:
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","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" (设置预置位)
"GotoPoint" (调用预置位)
"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 LocalChannel
本地通道号
返回值:
TRUE 成功
FALSE 失败
17) boolean StopRecord(long LocalChannel)
功能说明:
指定通道停止录像
参数说明:
long LocalChannel
本地通道号
返回值:
TRUE 成功
FALSE 失败
18) void StartRecordAll()
功能说明:
启动所有通道录像
参数说明:
无参数
返回值:
无返回值
19) void StopRecordAll()
功能说明:
停止所有通道录像
参数说明:
无参数
返回值:
无返回值
20) void Download(BSTR ServerAddress, long ServerMessagePort, 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 LocalChannel
本地通道号
BSTR ServerAddress
服务器的IP地址或者域名
long ServerMessagePort
服务器的控制命令端口
long ServerChannel
服务器端通道号
BSTR UserName
用户名
BSTR Password
密码
返回值:
TRUE 成功
FALSE 失败
23) boolean Snapshot(long LocalChannel, long Browse)
功能说明:
客户端实时抓图
参数说明:
long LocalChannel
本地通道号
long Browse
指示抓图成功后是否自动浏览该图片, 1表示需要浏览, 0表示不需要浏览
返回值:
TRUE 成功
FALSE 失败
24) long GetTotalPanelCount()
功能说明:
获取当前分割模式的实际窗口数目
参数说明:
无参数
返回值:
返回当前分割模式的实际窗口数目
25) long GetFirstChannel()
功能说明:
获取当前显示的第一个本地通道号
参数说明:
无参数
返回值:
返回当前显示的第一个本地通道号
26) void DisconnectFromServer(BSTR ServerAddress, long ServerMessagePort)
功能说明:
断开指定服务器相关的所有视频连接
参数说明:
BSTR ServerAddress
服务器的IP地址或者域名
long ServerMessagePort
服务器的控制命令端口
返回值:
无返回值
27) void SwitchSingleScreen()
功能说明:
切换到单屏显示, 如启用了画中画功能, 则自动显示画中画子窗口
参数说明:
无参数
返回值:
无返回值
28) void SwitchFullScreen()
功能说明:
切换到全屏显示
参数说明:
无参数
返回值:
无返回值
29) void SetAudioVolume(long Volume)
功能说明:
设置客户端音量大小
参数说明:
long Volume
音量大小(0-100)
返回值:
无返回值
30) long GetAudioVolume()
功能说明:
获取客户端音量大小
参数说明:
无参数
返回值:
音量大小(0-100)
31) long GetDefaultSaturation(long LocalChannel)
功能说明:
获取指定通道的默认饱和度
参数说明:
long LocalChannel
本地通道号
返回值:
默认饱和度(1-100)
32) long GetDefaultHue(long LocalChannel)
功能说明:
获取指定通道的默认色调
参数说明:
LocalChannel
本地通道号
返回值:
默认色调(1-100)
33) long GetDefaultContrast(long LocalChannel)
功能说明:
获取指定通道的默认对比度
参数说明:
long LocalChannel
本地通道号
返回值:
默认对比度(1-100)
34) long GetDefaultBrightness(long LocalChannel)
功能说明:
获取指定通道的默认亮度
参数说明:
long LocalChannel
本地通道号
返回值:
默认亮度(1-100)
35) long GetCurrentHue(long Loca
lChannel)
功能说明:
获取指定通道的当前色调
参数说明:
long LocalChannel
本地通道号
返回值:
当前色调(1-100)
36) long GetCurrentBrightness(long LocalChannel)
功能说明:
获取指定通道的当前亮度
参数说明:
long LocalChannel
本地通道号
返回值:
当前亮度(1-100)
37) long GetCurrentContrast(long LocalChannel)
功能说明:
获取指定通道的当前对比度
参数说明:
long LocalChannel
本地通道号
返回值:
当前对比度(1-100)
38) long GetCurrentSaturation(long LocalChannel)
功能说明:
获取指定通道的当前饱和度
参数说明:
long LocalChannel
本地通道号
返回值:
当前饱和度(1-100)
39) boolean SetCurrentBrightness(long LocalChannel, long NewValue)
功能说明:
设置指定通道的当前亮度
参数说明:
long LocalChannel
本地通道号
long NewValue
新设置的亮度值(1-100)
返回值:
TRUE 成功
FALSE 失败
40) boolean SetCurrentContrast(long LocalChannel, long NewValue)
功能说明:
设置指定通道的当前对比度
参数说明:
long LocalChannel
本地通道号
long NewValue
新设置的对比度值(1-100)
返回值:
TRUE 成功
FALSE 失败
41) boolean SetCurrentSaturation(long LocalChannel, long NewValue)
功能说明:
设置指定通道的当前饱和度
参数说明:
long LocalChannel
本地通道号
long NewValue
新设置的饱和度值(1-100)
返回值:
TRUE 成功
FALSE 失败
42) boolean SetCurrentHue(long LocalChannel, long NewValue)
功能说明:
设置指定通道的当前色调
参数说明:
long LocalChannel
本地通道号
long NewValue
新设置的色调值(1-100)
返回值:
TRUE 成功
FALSE 失败
43) boolean GetRecentVideoParam(long LocalChannel)
功能说明:
获取指定通道的最新视频参数, 成功后使用GetCurrentHue, GetCurrentBrightness, GetCurrentContrast, GetCurrentSaturation获取更新参数值
参数说明:
long LocalChannel
本地通道号
返回值:
TRUE 成功
FALSE 失败
44) boolean IsServerChannelConnected(BSTR ServerAddress, long ServerMessagePort, long ServerChannel)
功能说明:
查询指定服务器端的视频通道是否已在本地成功连接
参数:
BSTR ServerAddress
服务器的IP地址或者域名
long ServerMessagePort
服务器的控制命令端口
long ServerChannel
服务器端通道号
返回值:
TRUE 已连接
FALSE 未连接