控件对外接口有以下类型:
u布局
u模式
1.启动控件连接服务端
接口 |
VARIANT StartDWControl() |
返回值 |
[long] 0:成功,其他错误码:失败。 |
2.启动控件连接服务端,使用用户名和群组登录
接口 |
VARIANT StartDWControlByUserInfo(const VARIANT UserName, const VARIANT GroupName) |
参数 |
[string] UserName——用户名 [string] GroupName——群组名 |
返回值 |
[long] 0:成功,其他错误码:失败。 |
3.结束控件连接客户端
接口 |
VARIANT StopDWControl() |
返回值 |
[long] 0:成功,其他错误码:失败。 |
4.整个大屏开机
接口 |
VARIANT StartUpAllScreen() |
返回值 |
[long] 0:成功,其他错误码:失败。 |
5.整个大屏关机
接口 |
VARIANT ShutDownAllScreen() |
返回值 |
[long] 0:成功,其他错误码:失败。 |
6.当前选中单块大屏开机
接口 |
VARIANT StartUpCurScreen() |
返回值 |
[long] 0:成功,其他错误码:失败。 |
7.当前选中单块大屏关机
接口 |
VARIANT ShutDownCurScreen() |
返回值 |
[long] 0:成功,其他错误码:失败。 |
8.获取大屏连接状态
接口 |
VARIANT GetScreenConnStatus() |
返回值 |
[long] 1:连接,0:不连接。 |
9.获取当前所有单块大屏开关状态
接口 |
VARIANT GetScreenProjStatus() |
返回值 |
[string] 状态信息,nProjNum(,nStatus) |
备注 |
1.状态信息——0:成功,其他错误码:失败; 2."("、")"不是格式内容,表示()里面的内容可重复; 3.nProjNum——当前单块大屏总数; 4.nStatus——单块大屏开关状态,1:打开,0:关闭; 例:返回"0,2,1,0"——读取成功,两个单块大屏,第一个打开,第二个关闭。 |
1.设置是否自适应合并
接口 |
VARIANT SetAutoCombine(const VARIANT nCombineStatus) |
参数 |
[long] nCombineStatus——是否自适应合并,1:自适应合并,0:非自适应合并 |
返回值 |
[long] 0:成功,其他错误码:失败。 |
2.自适应合并状态改变时的通知事件
接口 |
void NotifyAutoCombineChange(nAutoCombine) |
返回值 |
[long] nAutoCombine ——是否自适应合并,1:自适应合并,0:非自适应合并。 |
3.设置是否离线编辑
接口 |
VARIANT SetLocalEdit(const VARIANT nLocalEdit) |
参数 |
[long] nLocalEdit——是否离线编辑,1:离线编辑,0:在线编辑。 |
返回值 |
[long] 0:成功,其他错误码:失败。 |
4.离线编辑状态改变时的通知事件
接口 |
void NotifyLocalEditChange(nLocalEdit) |
返回值 |
[long] nLocalEdit——是否离线编辑,1:离线编辑,0:在线编辑。 |
5.获取当前窗口ID
接口 |
VARIANT GetCurWndID() |
返回值 |
[long] 窗口ID:选中一个窗口,-1:选择多个或失败。 |
6.获取当前大屏行列值和单块大屏像素宽高
接口 |
VARIANT GetScreenProjLayout() |
返回值 |
[string] 状态信息,nRow,nCol,nWidth,nHeight |
备注 |
状态信息——0:成功,其他错误码:失败; |
7.删除选中窗口
接口 |
VARIANT DeleteCurWnd() |
返回值 |
[long] 0:成功,其他错误码:失败。 |
8.分割当前选中单块大屏
接口 |
VARIANT CutSingleScreen(const VARIANT nRows) |
参数 |
[long] nRows——分割行数(列数自动等于行数) |
返回值 |
[long] 0:成功,其他错误码:失败。 |
9.分割当前选中单块大屏
接口 |
VARIANT CutScreen(const VARIANT nRows, const VARIANT nColumns) |
参数 |
[long] nRows——分割行数,1《nRows《32 [long] nColumns——分割列数,1《nColumns《64 |
返回值 |
[long] 0:成功,其他错误码:失败。 |
1.显示模式管理对话框
接口 |
void OpenModeManageDlg() |
2.显示模式管理对话框
接口 |
void NotifyOpenModeManageDlg(nOpen) |
返回值 |
[long] nOpen,0:关闭,1:打开 |
3.获取当前大屏布局模式
接口 |
VARIANT GetScreenLayout() |
返回值 |
[string] nWndNum(,lX,lY,dwW,dwH,ulSourceType,strSourceName) |
备注 |
1.nWndNum——当前大屏幕的窗口总数, lX——窗口左上角点的横坐标, lY——窗口左上角点的纵坐标, dwW——窗口的宽度, dwH——窗口的高度, ulSourceType——信号源类型,1:视频信号,2:RGB信号,3:网络信号,4:RGB直连,5:网络直连, strSourceName——信号源名称; 2."("、")"不是格式内容,()中的内容重复nWndNum值的次数。 |
4.保存当前大屏布局为新模式
接口 |
void SaveNewMode() |
5.获取自定义模式名称信息
接口 |
VARIANT GetCustModeNames() |
返回值 |
[string] nRet,[名称1,名称2,…,] |
备注 |
nRet,0:成功,其他错误码:失败 |
6.应用自定义模式到大屏
接口 |
VARIANT ApplyModebyName(VARIANT strModeName) |
参数 |
[string] strModeName——模式名称 |
返回值 |
[long] 0:成功,其他错误码:失败 |
7.应用模式(buffer)到大屏
接口 |
VARIANT ApplyModebyBuffer(VARIANT strParam) |
参数 |
[string] nWndNum(,lX,lY,dwW,dwH,strSigName) |
返回值 |
[long] 0:成功,其他:错误码 |
备注 |
1.nWndNum——模式的窗口总数, lX——窗口左上角点的横坐标, lY——窗口左上角点的纵坐标, dwW——窗口的宽度, dwH——窗口的高度, strSigName——信号源名称; 2."("、")"不是格式内容,()中的内容重复nWndNum值的次数。 |
8.模式变化时(增删改)的事件通知
接口 |
void NotifyModeChange() |
1.获取当前窗口信号源信息
接口 |
VARIANT GetSRCofCurWnd() |
返回值 |
[string] nRet,信号源类型,信号源名称 |
备注 |
nRet,0:成功,其他错误码:失败 |
2.获取所有信号源名称信息
接口 |
VARIANT GetAllSignalSourceNames(const VARIANT nType) |
参数 |
[long] nType——信号源类型,1:RGB信号,2:视频信号,3:网络信号,4:RGB直连,5:网络直连 |
返回值 |
[[string] nRet,nNum,[名称1,名称2,…,] |
备注 |
1.nRet,0:成功,其他错误码:失败; nNum——信号源数量。 |
3.匹配信号源到当前窗口
接口 |
VARIANT MatchSCRtoCurWnd(VARIANT strSRCName) |
参数 |
[string] strSRCName——信号源名称 |
返回值 |
[long] 0:成功,其他错误码:失败 |
4.匹配信号源到任意窗口
接口 |
VARIANT MatchSCRstoWnds(VARIANT strParam) |
参数 |
[string] 欲匹配信号源的窗口数(,左上角行,左上角列,右下角行,右下角列,信号源名称) |
返回值 |
[long] 0:成功,其他错误码:失败 |
备注 |
1.行列数从1开始; 2.例:"1,1,1,1,…"表示左上角单块大屏窗口,"1,1,2,2,…"表示左上角4块单块大屏合并而成的窗口; 3."("、")"不是格式内容,()中的内容重复 欲匹配信号源的窗口数 值的次数。 |
5.获取轮询名称
接口 |
VARIANT GetCycleMonitorName() |
返回值 |
[string] 状态信息,轮询数量(,轮询名称) |
备注 |
1.状态信息——0:成功,其他错误码:失败; 3."("、")"不是格式内容,()中的内容重复 轮询数量 值的次数。 |
6.获取单个轮询
接口 |
VARIANT GetSingleCycleMonitor(const Variant strParam) |
参数 |
[string] strParam——轮询的名称 |
返回值 |
[string] 返回值(,信号源索引,信号源名称,信号源类型,轮询时间间隔) |
备注 |
1.返回值——0:成功,其他错误码:失败; 3."("、")"不是格式内容,()中的内容重复若干次数。 |
7.获取单个轮循后服务端返回消息时的通知事件
接口 |
void NotifyGetSingalCycle(const LPCTSTR strParam) |
返回值 |
[string] 轮询名称,(信号源序号,信号源名称,信号源类型,轮询时间间隔) |
备注 |
"("、")"不是格式内容,()中的内容重复若干次数 |
8.新增轮询
接口 |
VARIANT AddCycleMonitor(const VARIANT strParam) |
参数 |
[string] 轮询名称,轮询描述(,信号源名称,信号源类型,轮询时间间隔) |
返回值 |
[long] 0:成功,其他错误码:失败 |
备注 |
"("、")"不是格式内容,()中的内容重复若干次数 |
9.修改轮询
接口 |
VARIANT ModifyCycleMonitor(const VARIANT strParam) |
参数 |
[string] 轮询名称,轮询描述(,信号源名称,信号源类型,轮询时间间隔) |
返回值 |
[long] 0:成功,其他错误码:失败 |
备注 |
"("、")"不是格式内容,()中的内容重复若干次数 |
10.删除轮询
接口 |
VARIANT DelCycleMonitor(const VARIANT strParam) |
参数 |
[string] strParam——轮询名称 |
返回值 |
[long] 0:成功,其他错误码:失败 |
11.应用轮询(buffer)
接口 |
VARIANT CycleMonitorBuf(const Variant strParam) |
参数 |
[string] 窗口位置,轮询名称,轮询描述(,信号源名称,信号源类型,轮询时间间隔) |
返回值 |
[string] 状态信息——0:成功,其他错误码:失败 |
备注 |
1.窗口位置:Left(窗口左端位置),Top(窗口上端位置),Width(窗口宽),Height(窗口高),均以像素为单位; 2."("、")"不是格式内容,()中的内容重复若干次数。 |
12.应用轮询(名称)
接口 |
VARIANT CycleMonitorByName(const VARIANT nWndId, const VARIANT strName) |
参数 |
[int] nWndId——轮询的窗口id, [string] strName——轮询名称。 |
返回值 |
[string] 状态信息——0:成功,其他错误码:失败 |
13.结束轮询
接口 |
VARIANT CloseCycleMonitor(const VARIANT nWndID) |
参数 |
[int] nWndID——窗口ID |
返回值 |
[long] 0:成功,其他错误码:失败 |
以上接口可在组态脚本中调用,也可在其他编程语言中调用。