属性:
Language 语言版本. English—英文,SimpChinese—简体中文, TradChinese—繁体中文
方法:
1.注册
1.1注册
long Login (LPCTSTR lpServerIp,long lPort, LPCTSTR lpUserName, LPCTSTR lpPassword)
功能:登陆到硬盘录像机
参数说明:
lpServerIP:硬盘录像机的IP地址或者域名
lPort:硬盘录像机端口号
lpUserName:登陆的用户名
lpPassword:登陆的密码
返回值:lUserID提供给其他接口使用。-1表示注册失败
2.注销
2.1 注销
BOOL Logout()
功能:从硬盘录像机上注销某个用户
返回值:TRUE表示成功,FALSE表示失败。
3.预览
3.1开始单通道预览
BOOL StartChannelRealPlay(long nChannel,long lProtocolType, long lStreamType);
功能:开始某个通道的预览
参数说明:
nChannelNum:播放通道号, 0 – 代表通道1,1 – 代表通道2
lProtocolType:协议类型,0 – TCP, 1 – UDP,目前只支持TCP
lStreamType: 码流类型,0 表示主码流, 1 表示子码流
返回值:TRUE表示成功,FALSE表示失败。
3.2开始全通道预览
BOOL StartPlayAll();
功能:开始全部通道的预览
返回值:TRUE表示成功,FALSE表示失败。
3.3停止单通道预览
BOOL StopChannelRealPlay(long nChannel)
功能:停止某个通道的预览
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
返回值:TRUE表示成功,FALSE表示失败。
3.4停止所有通道的预览
BOOL StopRealPlayAll()
功能:停止所有已经开启的预览
返回值:TRUE表示成功,FALSE表示失败。
4.声音控制
4.1 打开声音
BOOL OpenChannelSound(long nChannel ,long lSoundMode)
功能:打开声音,需要预览开启
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
返回值:TRUE表示成功,FALSE表示失败。
lSoundMode: 打开声音模式。 1 – 独占模式 , 2 – 共享模式,
目前只支持共享模式(没有考虑这个值)
4.2 关闭声音
BOOL CloseChannelSound(long nChannel, long lSoundMode)
功能:关闭声音,需要预览开启
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
返回值:TRUE表示成功,FALSE表示失败。
lSoundMode: 打开声音模式。 1 – 独占模式 , 2 – 共享模式,
目前只支持共享模式(没有考虑这个值)
5.对讲
5.1开始对讲
BOOL StartTalk()
功能:开始对讲
返回值:TRUE表示成功,FALSE表示失败。
5.2停止对讲
BOOL StopTalk()
功能:停止对讲
返回值:TRUE表示成功,FALSE表示失败。
6.录像
6.1开始某个通道的录像
BOOL StartChannelRecord(long nChannel ,LPCTSTR lpSaveFile,long nType)
功能:对指定通道进行录像,预览打开才有效
参数说明:
nChannel: 通道号,0 – 代表通道1,1- 代表通道2
lpSaveFile:保存录像的路径,(当设值为“”时:路径取配置文件路径,如果没有配置文件将用默认路径“C:\record”)
nType:录像类型:0 – 带私有头h264;1 – 纯h264;2 – AVI;(目前只支持0和2两种情况;)(-1使用配置文件提供的设置类型)
返回值:TRUE表示成功,FALSE表示失败。
6.2开始全录像
BOOL StartRecordAllChannel(LPCTSTR lpSaveFile,long nType)
功能说明:对正在预览的所有通道进行录像,保存录像文件的路径由客户端页面配置
参数说明:
lpSaveFile:保存录像的路径,(当设值为“”时:路径取配置文件路径,如果没有配置文件将用默认路径“C:\record”)
nType:录像类型:0 – 带私有头h264;1 – 纯h264;2 – AVI;(目前只支持0和2两种情况;)(-1时使用配置文件提供的设置类型)
返回值:TRUE表示成功,FALSE表示失败。
6.3开始设备录像
StartRemoteRecord(long nChannel)
功能说明:开启设备端指定通道的录像
参数说明:
nChannel: 通道号,0 – 代表通道1,1- 代表通道2
返回值:TRUE表示成功,FALSE表示失败。
6.4停止设备录像
StopRemoteRecord(long nChannel)
功能说明:停止设备端指定通道录像
参数说明:
nChannel: 通道号,0 – 代表通道1,1- 代表通道2
返回值:TRUE表示成功,FALSE表示失败。
6.5停止指定通道录像
BOOL StopChannelRecord(long nChannel);
功能说明:停止指定通道的录像
参数说明:
nChannel: 通道号,0 – 代表通道1,1- 代表通道2
返回值:TRUE表示成功,FALSE表示失败。
6.6停止所有录像
BOOL StopRecordAllChannel();
功能说明:停止所有通道的录像
返回值:TRUE表示成功,FALSE表示失败。
7.窗口调整
7.1改变窗口数
BOOL ChangeShowWndNum(long nShowNum, BOOL bChange, long nSplit, long nPreview);
功能说明:调整窗口数
参数说明:
nShowNum: 窗口数:例:1,4,9,16,25,36
bChange: 是否改变窗口,目前只有为ture函数才起作用
nSplit:无特殊需要推荐用0;0: 单画面;1: 1/2画面; 2: 1/4画面;
nPreview:无特殊需要推荐用0;特殊设备需求。
返回值:TRUE表示成功,FALSE表示失败。
7.2最大化窗口
void Fullscreen(BOOL bFull)
功能说明:最大话显示窗口
参数说明:
bFull:TRUE全屏,FALSE:退出全屏
8.抓图
BOOL BMPChannelCapturePicture(long nChannel ,LPCTSTR lpSaveFile);
功能:抓BMP图,在预览或者回放时才有效,路径由客户端页面设置
参数说明:
lpSaveFile:保存录像的路径,(当设值为“”时:路径取配置文件路径,如果没有配置文件将用默认路径“C:\BMP”)
返回值:TRUE表示成功,FALSE表示失败。
9.云台控制
9.1 云台控制开始
BOOL PTZCtrlStart(long lChannle, long lCtrlType, long lSpeed)
功能:云台开始控制命令,在预览时才有效
参数说明:
nChannel:通道号,0 – 代表通道1,1 – 代表通道2
lCtrlType:为云台动作:0 -- 云台向上,1 -- 云台向下,2 -- 云台向左,3 -- 云台向右, 4 - 云台左上, 5- 云台左下, 6- 云台右上, 7 - 云台右下, 8 -- 焦距拉远,9-- 焦距缩进, 10 -- 焦点远,11-- 焦点近, 12 -- 光圈大,13 -- 光圈小
lSpeed:云台速度,范围为1 – 8。
返回值:TRUE表示成功,FALSE表示失败。
9.2 云台控制停止
PTZCtrlStop(long nChannel, long lCtrlType, long lSpeed)
功能:云台停止控制命令,在预览时才有效
参数说明:
nChannel:通道号,0 – 代表通道1,1 – 代表通道2
lCtrlType: 为云台动作:0 -- 云台向上,1 -- 云台向下,2 -- 云台向左,3 -- 云台向右, 4 - 云台左上, 5- 云台左下, 6- 云台右上, 7 - 云台右下, 8 -- 焦距拉远,9-- 焦距缩进, 10 -- 焦点远,11-- 焦点近, 12 -- 光圈大,13 -- 光圈小
lSpeed:云台速度,范围为1 –8。
返回值:TRUE表示成功,FALSE表示失败。
9.3 设置预置点
BOOL PTZCtrlSetPreset(long nChannel, long lPresetNumb,BOOL bAdd)
功能:设置云台预置位,需要预览
参数说明:
nChannel:通道号,0 – 代表通道1,1 – 代表通道2
lPresetNumber:云台预置位号,最多支持128个。
bAdd:增或删,TRUE :增加预置点;FALSE:删除预置点
返回值:TRUE表示成功,FALSE表示失败。
9.4 调用预置点
BOOL PTZCtrlGotoPreset(long nChannel, long lPresetNumb)
功能:调用云台预置位,需要预览
参数说明:
nChannel:通道号,0 – 代表通道1,1 – 代表通道2
lPresetNumber:云台预置位号,最多支持128个。
返回值:TRUE表示成功,FALSE表示失败。
9.5调用轮询
BOOL PTZCtrlTour(long nChannel, long lTourNumber, BOOL bStart);
功能:调用云台轮询,需要预览
参数说明:
nChannel:通道号,0 – 代表通道1,1 – 代表通道2
lTourNumber:巡航线路
bStart:TURE:开始巡航,FALSE:停止巡航
返回值:TRUE表示成功,FALSE表示失败。
9.6巡航编辑
BOOL PTZEditTure(long lTureNumber);
功能:弹出巡航线路编辑框,对巡航线路进行增删改
参数说明:
lTureNumber:巡航线路(1-255)
返回值:TRUE表示成功,FALSE表示失败。
10.色彩调节
10.1设置视频参数
BOOL SetColor(long nChannel, long lBrightValue, long lContrastValue, long lSaturationValue, long lHueValue)
功能:设置视频参数,需要预览
参数说明:
nChannel: 通道号,0 – 代表通道1,1- 代表通道2
lBrightValue:亮度 ( 取值为 1 – 128 )
lContrastValue:对比度 ( 取值为 1- 128 )
lSaturationValue:饱和度 ( 取值为 1- 128 )
lHueValue:色调 ( 取值为 1 - 128 )
返回值:TRUE表示成功,FALSE表示失败
10.2获取视频参数
BSTR GetColor(long nChannel)
功能:获取视频参数,需要预览
参数说明:
nChannel: 通道号,0 – 代表通道1,1- 代表通道2
返回值:返回字符串,格式为:“亮度值,对比度值,饱和度值,色度值”(各值间用逗号隔开)
11.功能模块调用
11.1回放
BOOL ShowPlayBack();
功能:显示回放相关对话框,需要先登入
对话框有各类录像的查询,回放,下载操作。
返回值:成功返回true,失败返回false
11.2日志
BOOL ShowLog();
功能:显示日志对话框(报警日志,操作日志)
返回值:成功返回true,失败返回false
11.3设备配置
BOOL ShowDeviceConfig();
功能:设备配置对话框,需要先登入
返回值:成功返回true,失败返回false
11.4客户端配置
BOOL ShowClientConfig();
功能:客户端配置对话框,需要先登入
返回值:成功返回true,失败返回false
12.重启
BOOL RebootServer()
功能:重新启动硬盘录像机
返回值:TRUE表示成功,FALSE表示失败
13.翻译字符串
BSTR Translate(LPCTSTR str)
功能:翻译字符串,翻译文件中要有相应的翻译字符串
参数说明:
str:要翻译的字符串
返回值:翻译后的字符串
14.获取所有通道名
BSTR GetChannelName()
功能:得到所有通道的名称
返回值:所有通道名连成一个字符串返回,ascII码9分隔通道号和通道名,ascII码16分隔通道与通道: Format("%d%c%s%c",通道号,9,通道名,16)
15.通过窗口获取通道号
Long GetCurChannel ()
功能:获取选中窗口对应的通道号
返回值:-1–代表窗口未预览没有对应通道号,0 – 代表通道1,1- 代表通道2
事件:
1.RbuttonDown
右键按下触发事件
2.Click
左键按下触发事件
3.DblClick
双击左键触发事件
4.OpenMainStream (long nChannel)
某个通道主码流被打开触发事件
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
5.OpenSubStream (long nChannel)
某个通道辅码流被打开触发
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
6.CloseStream(long nChannel)
某个通道被关闭触发事件
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
7.RecoverPlay(long lChannel, BOOL bSubStream)
打开上次退出时开着的通道触发事件
参数说明:
lChannel:通道号
bSubStream:码流类型
8.DvrRecord(boolean bRecord)
打开或关闭设备录像触发事件
参数说明:
bRecord:true - 打开;false - 关闭
9.AllChannelPlayCtrl(boolean bPlay, long lStreamType)
全通道播放事件
参数说明:
bPlay:true - 打开;false - 关闭
lStreamType:0 – 主码流;1 – 辅码流(只有打开时才有效)
10.AllChannelRecordCtrl(boolean bRecord)
全通道录像事件
参数说明:
bRecord:true - 打开;false - 关闭
11.SoundCtr(long nChannel ,boolean bOpen)
打开或关闭某个窗口声音时候触发事件
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
bOpen: true - 打开;false - 关闭
12.ReName(long nChannel)
通道重命名时候触发事件
参数说明:
nChannel:通道号,0 – 代表通道1,1- 代表通道2
13.ReBoot()
重启时候触发的事件
2023-09-18 16:15:27
100.93MB
雄迈WEB
1