二次开发使用 WEB32网页调用接口说明V2.0

WEB3.2控件二次开发接口说明文档

编写时间：2017/05/03

1

1 修订记录

时间 2017.05.03 修订内容 二次开发接口文档，主要用于提供二次开发使用 修订人 X 2

目录

WEB3.2控件接口说明文档 ........................................................................................................... 1 1 接口方法： ............................................................................................................................... 7

1.1 插件初始化(晓慧) ....................................................................................................... 7

1.1.1 SetInitParams .................................................................. 错误！未定义书签。 1.1.2 AddEventListener ........................................................... 错误！未定义书签。 1.1.3 SetTranslateString ........................................................... 错误！未定义书签。 1.1.4 SetOEM ........................................................................... 错误！未定义书签。 1.2 登陆/登出（晓慧） ................................................................... 错误！未定义书签。

1.2.1 LoginDeviceEx ............................................................... 错误！未定义书签。 1.2.2 LogoutDevice .................................................................. 错误！未定义书签。 1.3 窗口相关（晓慧） .................................................................... 错误！未定义书签。

1.3.1 SetWinBindedChannel/ SetWinBindedChannelEx ......... 错误！未定义书签。 1.3.2 EnableVideoOPFunc ....................................................... 错误！未定义书签。 1.3.3 GetWndState ................................................................... 错误！未定义书签。 1.3.4 SetWndState .................................................................... 错误！未定义书签。 1.3.5 SwitchToFullScreen/ OnFullScreenClk .......................... 错误！未定义书签。 1.3.6 SetSelPlayer .................................................................... 错误！未定义书签。 1.4 监视预览（振兴） .................................................................................................... 12

1.4.1 ConnectRealVideo/ ConnectRealVideoEx ...................................................... 12 1.4.2 ConnectAllChannelEx ..................................................................................... 13 1.4.3 DisConnectRealVideo ..................................................................................... 13 1.4.4 DisConnectAllChannel ................................................................................... 13 1.4.5 ConnectWanMultiRealVideo ........................................... 错误！未定义书签。 1.4.6 StartPreviewEx ................................................................ 错误！未定义书签。 1.4.7 StopPreview .................................................................... 错误！未定义书签。 1.4.8 VerticalSyncEnable ......................................................... 错误！未定义书签。 1.4.9 GetColor .......................................................................... 错误！未定义书签。 1.4.10 SetColor .......................................................................... 错误！未定义书签。 1.4.11 SetPicQuality................................................................... 错误！未定义书签。 1.4.12 SetAdjustFluency ............................................................ 错误！未定义书签。 1.5 语音对讲（振兴） .................................................................... 错误！未定义书签。

1.5.1 ControlTalking/ControlTalkingEx ................................... 错误！未定义书签。 1.6 录像查询（晓晖） .................................................................................................... 14

1.6.1 SwitchMonth ................................................................................................... 14 1.6.2 SwitchDay ....................................................................................................... 15 1.6.3 QueryRecordInfoByTime/ QueryRecordInfoByTimeEx ................................ 15 1.6.4 QueryGroupRecordInfo .................................................................................. 16 1.6.5 StopQueryRecordInfo ..................................................................................... 16 1.6.6 SetSearchBeginTime ....................................................... 错误！未定义书签。 1.7 网络回放（晓晖） .................................................................................................... 17

1.7.1 PlayBack（N8未使用） ................................................................................ 17 1.7.2 PlayBackByType ............................................................................................. 17

3

1.7.3 StopPlayBack .................................................................................................. 18 1.7.4 CloseAllNetPlayback ...................................................................................... 18 1.7.5 StopAllPlayBack（N8未使用） ................................................................... 19 1.7.6 PlayBackByTime/ PlayBackByTimeEx .......................................................... 19 1.7.7 PlayBackByRecordFile/PlayBackByRecordFileEx ........................................ 19 1.7.8 GetPlayTime（N8未使用） .......................................................................... 20 1.7.9 SetRecordType ................................................................ 错误！未定义书签。 1.7.10 GetCurPlayFileInfo ......................................................................................... 20 1.8 切片回放 .................................................................................... 错误！未定义书签。

1.8.1 PlayBackByTimeSec ....................................................... 错误！未定义书签。 1.9 水印校验 .................................................................................................................... 33

1.9.1 StartVerifyWatermark ...................................................................................... 33 1.9.2 StopVerifyWatermark ...................................................................................... 33 1.10 同步回放 .................................................................................... 错误！未定义书签。

1.10.1 SyncPlayBackByType ..................................................... 错误！未定义书签。 1.10.2 SyncPlayBackByTime..................................................... 错误！未定义书签。 1.10.3 SyncPlayBackByRecordFile ........................................... 错误！未定义书签。 1.11 回放控制 .................................................................................................................... 23

1.11.1 PausePlayBack ................................................................................................ 23 1.11.2 SpeedPlayBack ................................................................................................ 24 1.11.3 SetPlayDirection/SetPlayBackDirection ......................................................... 24 1.12 本地回放（晓晖） .................................................................................................... 25

1.12.1 SelectLocalFile ................................................................................................ 25 1.12.2 QuickOperation ............................................................................................... 25 1.12.3 SpeedLocalPlay ............................................................................................... 25 1.12.4 PauseLocalPlay ............................................................................................... 26 1.12.5 StopLocalPlay ................................................................................................. 26 1.12.6 PlayLocalFileOneByOne ................................................................................ 27 1.12.7 PlayLocalFileBackOne.................................................................................... 27 1.12.8 FastLocalPlay .................................................................................................. 28 1.12.9 SlowLocalPlay ................................................................................................ 28 1.12.10 SetLocalPlayTime ................................................................................... 28 1.12.11 PlayLocalPlay ................................................................................................. 29 1.13 音频控制（振兴） .................................................................................................... 29

1.13.1 PlayOpenSound/PlayOpenSoundEx ............................................................... 29 1.13.2 PlayStopSound/PlayStopSoundEx .................................................................. 30 1.13.3 PlaySetVolume ................................................................................................ 30 1.13.4 OpenAlarmSound ............................................................................................ 31 1.13.5 StopAlarmSound ............................................................................................. 31 1.13.6 StartAudioRecord ............................................................................................ 32 1.13.7 StopAudioRecord ............................................................................................ 32 1.14 网络下载（程浩） .................................................................................................... 21

1.14.1 DownloadRecordByFile/ DownloadRecordByFileEx .................................... 21 1.14.2 DownloadRecordByTime/ DownloadRecordByTimeEx ................................ 21

4

1.14.3 StopDownloadByFile/ StopDownloadByFileEx ............................................. 22 1.14.4 StopDownloadByTime .................................................................................... 23 1.14.5 DownloadRecordByTime/ DownloadRecordByTimeEx 错误！未定义书签。 1.15 设备备份 .................................................................................... 错误！未定义书签。

1.15.1 QueryBackupDevice ....................................................... 错误！未定义书签。 1.15.2 StartBackup ..................................................................... 错误！未定义书签。 1.15.3 StopBackup ..................................................................... 错误！未定义书签。 1.16 文件操作（程浩） .................................................................................................... 34

1.16.1 ReadFile .......................................................................................................... 34 1.16.2 WriteFile.......................................................................................................... 34 1.16.3 ShowOpen ....................................................................................................... 35 1.16.4 ShowSave ........................................................................................................ 35 1.16.5 showFileBrowse .............................................................................................. 36 1.16.6 ShowSaveOrOpenDlg ..................................................................................... 36 1.16.7 GetConfigPath/SetConfigPath ........................................................................ 37 1.17 智能绘制 .................................................................................... 错误！未定义书签。

1.17.1 SetCurName .................................................................... 错误！未定义书签。 1.17.2 ReDrawCurShape ............................................................ 错误！未定义书签。 1.17.3 DeleteShape..................................................................... 错误！未定义书签。 1.17.4 SetCurDirection............................................................... 错误！未定义书签。 1.17.5 SetCurShape .................................................................... 错误！未定义书签。 1.17.6 SetMaxPntNum ............................................................... 错误！未定义书签。 1.17.7 SetIVSConfig .................................................................. 错误！未定义书签。 1.17.8 SetObjectConfig .............................................................. 错误！未定义书签。 1.17.9 SetCurPtzID .................................................................... 错误！未定义书签。 1.17.10 SetCurEnable ........................................................... 错误！未定义书签。 1.17.11 SetCalibrateAndRules ..................................................... 错误！未定义书签。 1.17.12 SelectRule ............................................................... 错误！未定义书签。 1.17.13 GetLength ................................................................ 错误！未定义书签。 1.17.14 AddShape ................................................................ 错误！未定义书签。 1.17.15 SetModuleIndex ...................................................... 错误！未定义书签。 1.17.16 AddExcludeRegion ................................................. 错误！未定义书签。 1.17.17 DelExcludeRegion .................................................. 错误！未定义书签。 1.17.18 SetCurModule ......................................................... 错误！未定义书签。 1.17.19 AddDetectionRegion ............................................... 错误！未定义书签。 1.17.20 DelDetectRegionShape ........................................... 错误！未定义书签。 1.17.21 SetIVSEnable .......................................................... 错误！未定义书签。 1.17.22 SetRegionNum ........................................................ 错误！未定义书签。 1.17.23 SetSelRegionByIndex ............................................. 错误！未定义书签。 1.17.24 DelSelReg ............................................................... 错误！未定义书签。 1.17.25 SetRegionAttributeByIndex .................................... 错误！未定义书签。 1.17.26 getROIRegions ........................................................ 错误！未定义书签。 1.17.27 EnableVideoAnalyseModule ................................... 错误！未定义书签。 1.17.28 DeleteVideoAnalyseShape ...................................... 错误！未定义书签。

5

1.17.29 SelectVideoAnalyseShape ....................................... 错误！未定义书签。 1.17.30 SetVideoAnalyseShapeShowName ......................... 错误！未定义书签。 1.17.31 DeleteAllVideoAnalyseShape ................................. 错误！未定义书签。 1.17.32 CreateMainVideoAnalyseShape .............................. 错误！未定义书签。 1.17.33 GetVideoAnalyseShapeConfigData ........................ 错误！未定义书签。 1.17.34 SetGridNum ............................................................ 错误！未定义书签。 1.17.35 SetCurrentDrawId ................................................... 错误！未定义书签。 1.17.36 GetVideoAnalyseShapeConfigData ........................ 错误！未定义书签。 1.18 POS信息 .................................................................................... 错误！未定义书签。

1.18.1 POSStartFind ................................................................... 错误！未定义书签。 1.18.2 POSDoFind ..................................................................... 错误！未定义书签。 1.18.3 POSStopFind ................................................................... 错误！未定义书签。 1.19 鱼眼相关 .................................................................................... 错误！未定义书签。

1.19.1 SetFisheyeParams ........................................................... 错误！未定义书签。 1.19.2 ControlPtzFisheye ........................................................... 错误！未定义书签。 1.19.3 SetFisheyeParamsEx ....................................................... 错误！未定义书签。 1.19.4 SetFeShowMode ............................................................. 错误！未定义书签。 1.19.5 SetFeInstallMode ............................................................ 错误！未定义书签。 1.20 其他功能（晓慧） .................................................................................................... 37

1.20.1 SetModuleMode .............................................................................................. 37 1.20.2 SetModuleMode .............................................................. 错误！未定义书签。 1.20.3 QueryLocalFileInfo ......................................................... 错误！未定义书签。 1.20.4 UpLoadRemoteFile ......................................................... 错误！未定义书签。 1.20.5 GetFileLength ................................................................. 错误！未定义书签。 1.20.6 SetFuncEnable................................................................. 错误！未定义书签。 1.20.7 SetFuntionInfo................................................................. 错误！未定义书签。

6

1 接口方法：

1.1 插件初始化

1.1.1 AddEventListener

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 注册监听事件回调函数 Windows、Mac、Linux 1. 插件加载完成 long AddEventListener(BSTR eventName, IDispatch *eventHandler) [in]BSTR eventName [in] eventHandler 返回值 使用示例 注释

成功返回TRUE，失败返回FALSE 1.2 登陆/登出

1.2.1 LoginDeviceEx

选项 接口描述 适用平台 前置条件 定义 说明 登陆设备接口 Windows、Mac、Linux 1、插件已经加载成功； BOOL LoginDeviceEx ( const char *szIP, long lPort, const char *szName, const char *szPassWord, int nSnapType 7

选项 说明 ); 参数 szIP [in] 登陆设备的IP 对应CLIENT_LoginEx等设备登录接口的返回值 lPort [in] TCP接口 设备提供的tcp接口 szName [in] 登陆用户名 登陆设备的当前用户名 szPassWord [in] 登陆密码 当前用户对应的登陆密码 nSnapType [in] 登陆类型，如下表 参数值 0 2 3 4 6 7 8 9 12 13 返回值 代表含义 TCP方式登入 主动注册登入 组播方式下的登入 UDP方式登入 只建立主连接登陆方式 SSL加密登录 成都佳发登陆 登录远程设备 LDAP方式登录 AD方式登录 返回登录错误码，如下表： 错误码 1 2 3 4 5 6 7 代表含义 密码不正确 用户名不存在 登录超时 帐号已登录 帐号已被锁定 帐号被列为黑名单 资源不足，系统忙 8

选项 说明 8 9 10 子连接失败 主连接失败 超过最大用户连接数 使用示例 注释

无 1.2.2 LogoutDevice

选项 接口描述 适用平台 前置条件 说明 登出设备 Windows、Mac、Linux 1、已调用SetInitParams 初始化接口 2、已调用LoginDeviceEx等登录设备接口 接口定义 参数 返回值 使用示例 注释

BOOL LogoutDevice()； 无 成功返回TRUE，失败返回FALSE 1.3 窗口相关

1.3.1 SetWinBindedChannel/ SetWinBindedChannelEx

选项 接口描述 适用平台 前置条件 接口定义 说明 绑定窗口号和通道对应 Windows、Mac、Linux 登陆成功 Long SetWinBindedChannel(long nWinNumber, long nWinSel, long nMinChannel, long nMaxChannel) void SetWinBindedChannelEx(int nWinNumber,int nWinID,const char* szChannelsJson, 9

选项 说明 const char* szJsonNodeName); 参数 [in] nWinNumber /*当前显示的窗口数目*/ [in] nWinSel /*当前选中的窗口*/ [in] nMinChannel /*绑定的最小通道号*/ [in] nMaxChannel /*绑定的最大通道号*/ ********************************************************* [in]nWinNumber /*当前显示的窗口数*/ [in] nWinID /*当前选中的窗口*/ [in] szChannelsJson /* 绑定的通道号*/ [in] szJsonNodeName /*固定值，js定义channels */ 返回值 使用示例 注释

默认值 1.3.2 GetWndState

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 说明 获得当前窗口显示的状态值 Windows、Mac、Linux 登陆成功 String GetWndState() 无 当前窗口状态（json串）：窗口数，窗口模式、窗口索引、是否全屏 使用示例 注释

10

1.3.3 SetWndState

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 设置插件窗口状态 Windows、Mac、Linux 登陆成功 void SetWndState(const char* szState) [in] szState /*窗口状态结构json串，包含窗口数，窗口模式、窗口索引、是否全屏*/ Void 返回值 使用示例 注释

1.3.4 SwitchToFullScreen/ OnFullScreenClk

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 全屏模式切换 Windows、Mac、Linux 已登陆，初始化SetInitParams接口调用完成 Long SwitchToFullScreen()/Long OnFullScreenClk() 无 默认值 1.3.5 SetSelPlayer

选项 接口描述 说明 选中指定的播放器 11

选项 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 Windows、Mac、Linux 初始化SetInitParams接口调用完成 Long SetSelPlayer(long nPlayerID) [in] nPlayerID /*播放器的索引值*/ 默认值 1.4 监视预览

1.4.1 ConnectRealVideo/ ConnectRealVideoEx

选项 接口描述 适用平台 前置条件 接口定义 说明 实时拉流 全平台 STDMETHODIMP ConnectRealVideo(short nChannel, short nStreamType, BOOL *pVal)（建议不使用） STDMETHODIMP ConnectRealVideoEx(long nChannel, long nStreamType, long nWindNo, VARIANT_BOOL *pVal) long nChannel //通道号 long nStreamType //流类型, 1 :主码流， 2：辅码流 long nWindNo //窗口ID 返回值 使用示例 ConnectRealVideoEx(1 , 1) //拉通道1的主码流 ConnectRealVideoEx(1 , 2, 3) //在窗口序号3上拉通道1，辅码流 接口描述

实时拉流 参数 12

1.4.2 ConnectAllChannelEx

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 断开某种类型的全部码流 Win、Mac、Linux ConnectRealVideo/ ConnectRealVideoEx STDMETHODIMP ConnectAllChannelEx(long VARIANT_BOOL *pVar) long nStreamType //码流类型 成功：true；失败：false nStreamType, 1.4.3 DisConnectRealVideo

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释 说明 停止某个通道的拉流 Win、Mac、Linux ConnectRealVideo/ ConnectRealVideoEx STDMETHODIMP DisConnectRealVideo(long VARIANT_BOOL *pVar) long lChannelNo //通道号 成功：true；失败：false lChannelNo, 1.4.4 DisConnectAllChannel

选项 接口描述 说明 断开所有通道的拉流 13

选项 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 Win、Mac、Linux STDMETHODIMP DisConnectAllChannel(VARIANT_BOOL *pVar) 无 成功：true；失败：false 1.5 录像查询

1.5.1 SwitchMonth

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 切换月份 WIN、MAC 1.插件加载完成；2.存在录像文件可以查询 HRESULT SwitchMonth([in] long nYear, [in] long nMonth, [in] long nDay); nYear [in] 切换的年 nMonth [in] 切换的月份 nDay [in] 切换的日期 返回值 使用示例 注释 成功返回TRUE，失败返回FALSE 14

1.5.2 SwitchDay

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 切换日期 WIN、MAC 1.插件加载完成；2.存在录像文件可以查询 HRESULT SwitchDay([in] long nYear, [in] long nMonth, [in] long nDay); nYear [in] 切换的年 nMonth [in] 切换的月份 nDay [in] 切换的日期 返回值 回调函数 使用示例 注释

成功返回TRUE，失败返回FALSE 1.5.3 QueryRecordInfoByTime/ QueryRecordInfoByTimeEx

选项 接口描述 适用平台 前置条件 接口定义 说明 查询录像文件信息 WIN、MAC 1.插件加载完成；2.存在录像文件可以查询 HRESULT QueryRecordInfoByTime([in] long nChannel, [in] long nRecType, [in] BSTR szStartTime, [in] BSTR szEndTime, [in] long nMaxNumebr, [out, retval] VARIANT_BOOL * pVal);（未使用） HRESULT QueryRecordInfoByTimeEx([in] BSTR szQueryInfo, [out, retval] VARIANT_BOOL * pVal); 15

选项 参数 说明 szQueryInfo [in] 录像查询，格式如下： {\通道号[int],\码流类型[int], \开始时间\结束时间\查询条数[int],\码流类型[int]}; 返回值 使用示例 注释

成功返回TRUE，失败返回FALSE 1.5.4 QueryGroupRecordInfo

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 查询指定组的文件信息 WIN、MAC 1.插件加载完成；2.存在录像文件可以查询 HRESULT QueryGroupRecordInfo([in] long nPageIndex, [out, retval] VARIANT_BOOL * pVal); nPageIndex ：页码 成功返回TRUE，失败返回FALSE 1.5.5 StopQueryRecordInfo

选项 接口描述 适用平台 前置条件 说明 停止查询录像信息 WIN、MAC 1.插件加载完成；2.当前是查询录像文件状态，且未完成查询 16

选项 接口定义 参数 返回值 使用示例 注释

说明 HRESULT StopQueryRecordInfo() 无 成功返回TRUE，失败返回FALSE 1.6 网络回放 1.6.1 PlayBack

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.6.2 PlayBackByType

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 说明 通过 HRESULT PlayBackByType([in] VARIANT_BOOL * pVal); nType：录像类型 long nType, [out, retval] 17

选项 使用示例 注释

说明 1.6.3 StopPlayBack

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释 说明 停止回放 HRESULT StopPlayBack([out, retval] VARIANT_BOOL * pVal) 1.6.4 CloseAllNetPlayback

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 停止全部回放 HRESULT CloseAllNetPlayback([out, retval] VARIANT_BOOL * pVal); 18

1.6.5 StopAllPlayBack

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 HRESULT StopAllPlayBack([out, retval] VARIANT_BOOL * pVal); 1.6.6 PlayBackByTime/ PlayBackByTimeEx

选项 接口描述 适用平台 前置条件 接口定义 说明 按时间回放录像 HRESULT PlayBackByTime([in] long nIndex, BSTR szLocateTime, [out, retval] VARIANT_BOOL * pVar); HRESULT PlayBackByTimeEx([in] long nIndex, [in] BSTR szLocateTime, [out, retval] VARIANT_BOOL * pVal);（N8未使用） 参数 返回值 使用示例 注释

1.6.7 PlayBackByRecordFile/PlayBackByRecordFileEx

19

选项 接口描述 适用平台 前置条件 接口定义 说明 通过录像信息进行回放 HRESULT PlayBackByRecordFile([in] BSTR szFileInfo, [out, retval] VARIANT_BOOL * pVal); HRESULT PlayBackByRecordFileEx([in] BSTR sFileInfo, [in] BSTR sLocateTime, [out, retval] long * pVal); 参数 返回值 使用示例 注释

1.6.8 GetPlayTime

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释 说明 HRESULT GetPlayTime([out, retval] BSTR * pVal);（N8未使用） 1.6.9 GetCurPlayFileInfo

选项 接口描述 适用平台 前置条件 说明 获取当前录像文件信息 20

选项 接口定义 参数 返回值 使用示例 注释

说明 HRESULT GetCurPlayFileInfo([out, retval] BSTR * pVal); 1.7 网络下载

1.7.1 DownloadRecordByFile/ DownloadRecordByFileEx

选项 接口描述 适用平台 前置条件 接口定义 说明 DownloadRecordByFile 按文件下载录像文件 DownloadRecordByFileEx 按文件下载跨天录像文件 Windows、Mac、Linux 1.插件加载完成；2.存在录像文件可以查询 1.bool DownloadRecordByFile(const char* szFileList, const char* szSavePathName, const char* szExt = NULL); 2.int DownloadRecordByFileEx(const char* szDownloadInfo, const char* szSavePathName, const char* szExt); const char *szFileList 录像文件信息列表 (const char *szDownloadInfo 下载信息) const char *szSavePathName 保存文件的路径 const char *szExt 返回值 使用示例 注释

保存文件的扩展名 参数 true 成功 false失败 1.7.2 DownloadRecordByTime/ DownloadRecordByTimeEx

选项

说明 21

选项 接口描述 适用平台 前置条件 接口定义 说明 按时间下载录像文件 Windows、Mac、Linux 1.插件加载完成；2.存在录像文件可以查询 1. int DownloadRecordByTime(int nChannel, const char* szStartTime, const char* szEndTime, const char* szSavePathName, const char* szExt = NULL); 2. int DownloadRecordByTimeEx(int nChannel, int nStreamType, const char* szStartTime, const char* szEndTime, const char* szSavePathName, const char* szExt = NULL); int nChannel int nStreamType 通道号 码流类型 参数 const char *szStartTime 开始时间 const char *szEndTime 结束时间 const char *szSavePathName 保存文件的路径 const char *szExt 返回值 使用示例 注释

保存文件的扩展名 true 成功 false失败 1.7.3 StopDownloadByFile/ StopDownloadByFileEx

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值

说明 停止下载录像文件 Windows、Mac、Linux 1.插件加载完成；2.录像按文件下载 1. bool StopDownloadByFile(); 2. bool StopDownloadByFileEx(); 无 true 成功 false失败 22

选项 使用示例 注释

说明 StopDownloadByFileEx 配合DownloadRecordByFileEx使用 1.7.4 StopDownloadByTime

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 停止按时间下载录像文件 Windows、Mac、Linux 1.插件加载完成；2.录像按时间下载 bool StopDownloadByTime(); 无 true 成功 false失败 1.8 回放控制

1.8.1 PausePlayBack

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 说明 暂停回放 HRESULT PausePlayBack([out, retval] VARIANT_BOOL * pVal); 23

选项 注释

说明 1.8.2 SpeedPlayBack

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 回放速率 HRESULT SpeedPlayBack([in] VARIANT_BOOL * pVar); long nSpeed, [out, retval] 1.8.3 SetPlayDirection/SetPlayBackDirection

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 24

1.9 本地回放

1.9.1 SelectLocalFile

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.2 QuickOperation

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.3 SpeedLocalPlay

选项 说明 25

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.4 PauseLocalPlay

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.5 StopLocalPlay

选项 接口描述 适用平台 前置条件 接口定义 说明 26

选项 参数 返回值 使用示例 注释

说明 1.9.6 PlayLocalFileOneByOne

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.7 PlayLocalFileBackOne

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

27

说明 1.9.8 FastLocalPlay

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.9 SlowLocalPlay

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.10 SetLocalPlayTime

选项 接口描述 适用平台 说明 28

选项 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.9.11 PlayLocalPlay

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 1.10 音频控制

1.10.1 PlayOpenSound/PlayOpenSoundEx

选项 接口描述 适用平台 前置条件 说明 29

选项 接口定义 说明 STDMETHODIMP CPlugin::PlayOpenSound(VARIANT_BOOL *pVal) STDMETHODIMP CPlugin::PlayOpenSoundEx(long nAudioChannel, VARIANT_BOOL *pVal) 参数 返回值 使用示例 注释

1.10.2 PlayStopSound/PlayStopSoundEx

选项 接口描述 适用平台 前置条件 接口定义 说明 STDMETHODIMP CPlugin::PlayStopSound(VARIANT_BOOL *pVal) STDMETHODIMP CPlugin::PlayStopSoundEx(long nAudioChannel, VARIANT_BOOL *pVal) 参数 返回值 使用示例 注释

1.10.3 PlaySetVolume

选项 接口描述 适用平台 前置条件 接口定义

说明 STDMETHODIMP 30

CPlugin::PlaySetVolume(long nVolume,

选项 说明 VARIANT_BOOL *pVal) 参数 返回值 使用示例 注释

1.10.4 OpenAlarmSound

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 STDMETHODIMP OpenAlarmSound(BSTR VARIANT_BOOL *pVal) pszSoundPath, 1.10.5 StopAlarmSound

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值

说明 STDMETHODIMP StopAlarmSound(VARIANT_BOOL *pVal) 31

选项 使用示例 注释

说明 1.10.6 StartAudioRecord

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 STDMETHODIMP StartAudioRecord(BSTR filePath, long *pVal) 1.10.7 StopAudioRecord

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 STDMETHODIMP StopAudioRecord(long *pVal) 32

1.11 水印校验

1.11.1 StartVerifyWatermark

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 开始水印校验 HRESULT StartVerifyWatermark([in] BSTR filePath, [out, retval] VARIANT_BOOL * pVal ); [in] BSTR filePath：所校验的录像文件路径 1.11.2 StopVerifyWatermark

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 停止水印校验 HRESULT StopVerifyWatermark([out, retval] VARIANT_BOOL * pVal); 33

1.12 文件操作

1.12.1 ReadFile

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 读取文件 Windows、Mac bool ReadFile(const char *szPath,std::string &strResult, const bool bReadFromUTF8 = true) const char *szPath 文件的路径 std::string &strResult const bool bReadFromUTF8按照UTF8读文件 返回值 使用示例 注释

true 成功 false失败 1.12.2 WriteFile

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 写文件 Windows、Mac long WriteFile(const char *szFileName,const char *szBuf, const char *lpMode, const bool bWriteToUTF8 = true) const char *szFileName 文件的路径 const char *lpBuf 待写缓冲区 const char *lpMode 文件打开方式 const bool bWriteToUTF8 按照UTF8写文件 34

选项 返回值 使用示例 注释

说明 0 失败 非0 成功 1.12.3 ShowOpen

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 打开文件选择对话框 Windows、Mac ShowOpen() 无 true 成功 false失败 1.12.4 ShowSave

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 保存文件选择对话框 Windows、Mac ShowSave() 无 true 成功 false失败 35

1.12.5 showFileBrowse

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释

说明 打开目录选择对话框 Windows、Mac Bool showFileBrowse() 无 true 成功 false失败 1.12.6 ShowSaveOrOpenDlg

选项 接口描述 适用平台 前置条件 接口定义 说明 获得选中的对话框文件名和扩展名 Windows、Mac Bool ShowSaveOrOpenDlg (bool &strDefaultPath,const std::string &strFileNaem,std::string &strExt) bool bOpen 是否打开 const std::string &strDefaultPath, 默认路径 const std::string &strDefaultExt 默认格式 std::string &strFileNaem, 文件名称 std::string &strExt 文件格式 返回值 使用示例 注释

true 成功 false失败 bOpen,const std::string &strDefaultExt,std::string 参数 36

1.12.7 GetConfigPath/SetConfigPath

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 获得保存信息的路径 /设置保存信息的路径 Windows、Mac 1 .bool GetConfigPath(int nPathType, std::string& strFileName) 2. bool SetConfigPath(int nPathType, const char* lpConfigPath); int nPathType 信息类型 std::string &strFileName(const char* lpConfigPath) 存储路径 返回值 使用示例 注释

ture 设置成功 false 设置失败 1.13 其他功能

1.13.1 SetModuleMode

选项 接口描述 适用平台 前置条件 接口定义 参数 说明 切换视频的模式 Windows、Mac void SetModuleMode(short nMode) 1,预览监视 2, 摄像头属性 3, IVS监视 4,网络回放 5,本地回放 6, ITC播放视频时订阅告警图片信息模式 7,仅播放告警图片模式 8,下载 9,视频属性 37

选项 说明 10,公网实时监视 返回值 使用示例 注释 1.13.2 ProtocolPluginWithWebCall

选项 接口描述 适用平台 前置条件 接口定义 参数 返回值 使用示例 注释 说明 附加特殊的功能 string ProtocolPluginWithWebCall(string protocol); Json字符串 返回结果 详见示例 2 事件(AddEventListener注册的事件回调)

2.1 返回预览窗口状态

事件10 事件名称 功能描述 参数1 参数2 参数3 参数4 返回值类型 返回值说明 定义 StateChanged 返回预览窗口状态； 参数名称 nChannelID nState nWinID nStreamType Void Void _com_dispatch_method(dispatch, 0x0, DISPATCH_METHOD, VT_EMPTY, NULL, 38

内部类型 short short short short 通道号 说明 1-打开预览，0-未打开预览 窗口ID 码流类型，1-主码流，其它-辅码流

L\nWinIndex, nStreamType); 2.2 网络录像信息

事件10 事件名称 功能描述 参数1 返回值类型 返回值说明 定义

InsertNetRecordFileInfo 网络录像信息 参数名称 strValue Void Void _com_dispatch_method(dispatch, 0x0, DISPATCH_METHOD, VT_EMPTY, NULL, L\内部类型 BSTR 说明 2.3 返回本地回放状态

事件1 事件名称 功能描述 参数1 返回值类型 返回值说明 定义

TransEvent 返回本地回放状态，开始本地回放后每隔一秒触发该事件； 参数名称 szValue {\\\\\\Void Void void FireTransEvent(LPCTSTR szValue) 内部类型 LPCTSTR 事件类型 回放是否打开，1-打开，0-关闭 本地回放的播放时间，单位秒 本地文件的总的播放时间，单位秒 说明 2.4 返回某月录像状态

事件7 事件名称 功能描述 SetNetPlayRecordStatus 返回某月录像状态，调用SwitchMonth接口后返回当月每天是否有录像的掩码； 参数名称 内部类型 说明 39

参数1 返回值类型 返回值说明 定义 strStatus Void Void LPCTSTR 掩码示例：0011101111100000000000011000000 void FireSetNetPlayRecordStatus(LPCTSTR strStatus); 2.5 返回某通道录像信息

事件8 事件名称 功能描述 参数1 SetNetPlayFileInfo 返回某通道录像信息； 参数名称 nChannel 内部类型 short 通道号 通道对应的录像信息，示例： 2013041109102020130411100000-00-20551: 2013041110000020130411105514-00-22272:…… 20130411091020:开始时间 20130411100000：结束时间 00：录像类型 20551：大小 说明 参数2 strRecorfInfo LPCTSTR 返回值类型 返回值说明 定义

Void Void void FireSetNetPlayFileInfo(short nChannel, LPCTSTR strRecorfInfo) 2.6 返回网络播放时间信息

事件9 事件名称 功能描述 参数1 返回值类型 返回值说明 定义

40

NetPlayTimeInform 返回网络播放时间信息，网络播放定时激发该事件； 参数名称 strTime Void Void void FireNetPlayTimeInform(LPCTSTR strTime) 内部类型 LPCTSTR 说明 示例：01091030|02101030…； 1窗口正在播放09:10:30的录像 2窗口正在播放10:10:30的录像

41

本文来源：https://www.bwwdw.com/article/qllr.html