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

#WEB3.2控件二次开发接口说明文档编写时间2017/05/031修订记录时间修订内容修订人2017.05.03二次开发接口文档，主要用于提供二次开发使用X目录TOC\o"1-5"\h\zWEB3.2控件接口说明文档11接口方法：71.1插件初始化（晓慧）7SetInitParams错误！未定义书签。AddEventListener错误！未定义书签。SetTranslateString错误！未定义书签。1.1.4SetOEM错误！未定义书签。1.2登陆/登出（晓慧）错误！未定义书签。LoginDeviceEx错误！未定义书签。1.2.2LogoutDevice错误！未定义书签。1.3窗口相关（晓慧）错误！未定义书签。SetWinBindedChannel/SetWinBindedChannelEx错.误！未定义书签。EnableVideoOPFunc错误！未定义书签。1.3.3GetWndState错误！未定义书签。1.3.4SetWndState错误！未定义书签。SwitchToFullScreen/OnFullScreenClk错误！未定义书签。1.3.6SetSelPlayer错误！未定义书签。TOC\o"1-5"\h\z1.4监视预览（振兴）12ConnectRealVideo/ConnectRealVideoEx1.2ConnectAllChannelEx13DisConnectRealVideo13DisConnectAllChannel13ConnectWanMultiRealVideo错误！未定义书签。StartPreviewEx错误！未定义书签。1.4.7StopPreview错误！未定义书签。1.4.8VerticalSyncEnable错误！未定义书签。1.4.9GetColor错误！未定义书签。1.4.10SetColor错误！未定义书签。1.4.11SetPicQuality错误！未定义书签。1.4.12SetAdjustFluency错误！未定义书签。1.5语音对讲（振兴）错误！未定义书签。ControlTalking/ControlTalkingEx错误！未定义书签。TOC\o"1-5"\h\z1.6录像查询（晓晖）14SwitchMonth14SwitchDay15QueryRecordInfoByTime/QueryRecordInfoByTimeEx15QueryGroupRecordInfo16StopQueryRecordInfo16SetSearchBeginTime错误！未定义书签。1.7网络回放（晓晖）17PlayBack（N8未使用）17PlayBackByType17StopPlayBack18CloseAllNetPlayback18StopAllPlayBack（N8未使用）19PlayBackByTime/PlayBackByTimeEx19PlayBackByRecordFile/PlayBackByRecordFileEx19GetPlayTime（N8未使用）20SetRecordType错误！未定义书签。GetCurPlayFileInfo201.8切片回放错误！未定义书签。PlayBackByTimeSec错误！未定义书签。1.9水印校验33StartVerifyWatermark33StopVerifyWatermark331.10同步回放错误！未定义书签。SyncPlayBackByType错误！未定义书签。SyncPlayBackByTime错误！未定义书签。SyncPlayBackByRecordFile错误！未定义书签。TOC\o"1-5"\h\z1.11回放控制23PausePlayBack23SpeedPlayBack24SetPlayDirection/SetPlayBackDirection241.12本地回放（晓晖）25SelectLocalFile25QuickOperation25SpeedLocalPlay25PauseLocalPlay26StopLocalPlay26PlayLocalFileOneByOne27PlayLocalFileBackOne27FastLocalPlay28SlowLocalPlay28SetLocalPlayTime28PlayLocalPlay291.13音频控制（振兴）29PlayOpenSound/PlayOpenSoundEx29PlayStopSound/PlayStopSoundEx30PlaySetVolume30OpenAlarmSound31StopAlarmSound31StartAudioRecord32StopAudioRecord321.14网络下载（程浩）21DownloadRecordByFile/DownloadRecordByFileEx21DownloadRecordByTime/DownloadRecordByTimeEx21StopDownloadByFile/StopDownloadByFileEx22StopDownloadByTime23DownloadRecordByTime/DownloadRecordByTimeEx错误！未定义书签。设备备份错误！未定义书签。QueryBackupDevice错误！未定义书签。StartBackup错误！未定义书签。StopBackup错误！未定义书签。TOC\o"1-5"\h\z文件操作（程浩）34ReadFile34WriteFile34ShowOpen35ShowSave35showFileBrowse36ShowSaveOrOpenDlg36GetConfigPath/SetConfigPath37智能绘制错误！未定义书签。SetCurName错误！未定义书签。ReDrawCurShape错误！未定义书签。DeleteShape错误！未定义书签。SetCurDirection错误！未定义书签。SetCurShape错误！未定义书签。SetMaxPntNum错误！未定义书签。SetIVSConfig错误！未定义书签。SetObjectConfig错误！未定义书签。SetCurPtzID错误！未定义书签。SetCurEnable错误！未定义书签。SetCalibrateAndRules错误！未定义书签。SelectRule错误！未定义书签。GetLength错误！未定义书签。AddShape错误！未定义书签。SetModuleIndex错误！未定义书签。AddExcludeRegion错误！未定义书签。DelExcludeRegion错误！未定义书签。SetCurModule错误！未定义书签。AddDetectionRegion错误！未定义书签。DelDetectRegionShape错误！未定义书签。SetIVSEnable错误！未定义书签。SetRegionNum错误！未定义书签。SetSelRegionByIndex错误！未定义书签。DelSelReg错误！未定义书签。SetRegionAttributeByIndex错误！未定义书签。getROIRegions错误！未定义书签。EnableVideoAnalyseModule错误！未定义书签。DeleteVideoAnalyseShape错误！未定义书签。SelectVideoAnalyseShape错误！未定义书签。SetVideoAnalyseShapeShowName错误！未定义书签。DeleteAllVideoAnalyseShape错误！未定义书签。CreateMainVideoAnalyseShape错误！未定义书签。GetVideoAnalyseShapeConfigData错误！未定义书签。1.17.34SetGridNum错误！未定义书签。1.17.35SetCurrentDrawId错误！未定义书签。1.17.36GetVideoAnalyseShapeConfigData错误！未定义书签。1.18POS信息错误！未定义书签。1.18.1POSStartFind错误！未定义书签。1.18.2POSDoFind错误！未定义书签。1.18.3POSStopFind错误！未定义书签。1.19鱼眼相关错误！未定义书签。SetFisheyeParams错误！未定义书签。ControlPtzFisheye错误！未定义书签。SetFisheyeParamsEx错误！未定义书签。SetFeShowMode错误！未定义书签。SetFeInstallMode错误！未定义书签。1.20其他功能（晓慧）37SetModuleMode37SetModuleMode错误！未定义书签。QueryLocalFileInfo错误！未定义书签。UpLoadRemoteFile错误！未定义书签。GetFileLength错误！未定义书签。SetFuncEnable错误！未定义书签。SetFuntionInfo错误！未定义书签。1接口方法：1.1插件初始化AddEventListener选项说明接口描述注册监听事件回调函数适用平台Windows、Mac、Linux前置条件1.插件加载完成接口定义longAddEventListener(BSTReventName,IDispatch*eventHandler)参数[in]BSTReventName[in]eventHandler返回值成功返回TRUE，失败返回FALSE使用示例注释1.2登陆/登出LoginDeviceEx选项说明接口描述登陆设备接口适用平台Windows、Mac、Linux前置条件1、插件已经加载成功；定义BOOLLoginDeviceEx(constchar*szIP,longlPort,constchar*szName,constchar*szPassWord,intnSnapType选项说明);参数szIP[in]登陆设备的IP对应CLIENT_LoginEx等设备登录接口的返回值lPort[in]TCP接口设备提供的tcp接口szName[in]登陆用户名登陆设备的当前用户名szPassWord[in]登陆密码当前用户对应的登陆密码nSnapType[in]登陆类型，如下表参数值代表含义0TCP方式登入2主动注册登入3组播方式下的登入4UDP方式登入6只建立主连接登陆方式7SSL加密登录8成都佳发登陆9登录远程设备12LDAP方式登录13AD方式登录返回值返回登录错误码，如下表:错误码代表含义1密码不正确2用户名不存在3登录超时4帐号已登录5帐号已被锁定6帐号被列为黑名单7资源不足，系统忙

选项说明8子连接失败9主连接失败10超过最大用户连接数使用示例注释无LogoutDevice选项说明接口描述登出设备适用平台Windows、Mac、Linux前置条件1、已调用SetInitParams初始化接口2、已调用LoginDeviceEx等登录设备接口接口定义BOOLLogoutDevice()；参数无返回值成功返回TRUE，失败返回FALSE使用示例注释窗口相关SetWinBindedChannel/SetWinBindedChannelEx选项说明接口描述绑定窗口号和通道对应适用平台Windows、Mac、Linux前置条件登陆成功接口定义LongSetWinBindedChannel(longnWinNumber,longnWinSel,longnMinChannel,longnMaxChannel)voidSetWinBindedChannelEx(intnWinNumber,intnWinID,constchar*szChannelsJson,

选项说明constchar*szJsonNodeName);参数[in]nWinNumber/*当前显示的窗口数目*/[in]nWinSel/*当前选中的窗口*/[in]nMinChannel/*绑定的最小通道号*/[in]nMaxChannel/*绑定的最大通道号*/*1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1**1*、!*、!>、!>、!>^1**1**1**1**1**1**1**1**1**1**1**1**1**1*rT*rT*^TxrT*[in]nWinNumber/*当前显示的窗口数*/[in]nWinID/*当前选中的窗口*/[in]szChannelsJson/*绑定的通道号*/[in]szJsonNodeName/*固定值，js定义channels*/返回值默认值使用示例注释GetWndState选项说明接口描述获得当前窗口显示的状态值适用平台Windows、Mac、Linux前置条件登陆成功接口定义StringGetWndState()参数无返回值当前窗口状态（json串）：窗口数，窗口模式、窗口索引、是否全屏使用示例注释

SetWndState选项说明接口描述设置插件窗口状态适用平台Windows、Mac、Linux前置条件登陆成功接口定义voidSetWndState(constchar*szState)参数[in]szState/*窗口状态结构json串，包含窗口数，窗口模式、窗口索引、是否全屏*/返回值Void使用示例注释SwitchToFullScreen/OnFullScreenClk选项说明接口描述全屏模式切换适用平台Windows、Mac、Linux前置条件已登陆，初始化SetlnitParams接口调用完成接口定义LongSwitchToFullScreen()/LongOnFullScreenClk()参数无返回值默认值使用示例注释SetSelPlayer选项说明接口描述选中指定的播放器

选项说明适用平台Windows、Mac、Linux前置条件初始化SetlnitParams接口调用完成接口定义LongSetSelPlayer(longnPlayerlD)参数[in]nPlayerlD/*播放器的索引值*/返回值默认值使用示例注释监视预览ConnectRealVideo/ConnectRealVideoEx选项说明接口描述实时拉流适用平台全平台前置条件接口定义STDMETHODIMPConnectRealVideo(shortnChannel,shortnStreamType,BOOL*pVal)(建议不使用)STDMETHODIMPConnectRealVideoEx(longnChannel,longnStreamType,longnWindNo,V\RIANTBOOL*pVal)参数longnChannel〃通道号longnStreamType〃流类型，1:主码流，2：辅码流longnWindNo〃窗口ID返回值使用示例ConnectRealVideoEx(1,1)〃拉通道1的主码流ConnectRealVideoEx(1,2,3)〃在窗口序号3上拉通道1，辅码流接口描述实时拉流

ConnectAllChannelEx选项说明接口描述断开某种类型的全部码流适用平台Win、Mac、Linux前置条件ConnectRealVideo/ConnectRealVideoEx接口定义STDMETHODIMPConnectAllChannelEx(longnStreamType,VARIANTBOOL*pVar)参数longnStreamType//码流类型返回值成功：true；失败：false使用示例注释DisConnectRealVideo选项说明接口描述停止某个通道的拉流适用平台Win、Mac、Linux前置条件ConnectRealVideo/ConnectRealVideoEx接口定义STDMETHODIMPDisConnectRealVideo(longlChannelNo,VARIANTBOOL*pVar)参数longlChannelNo〃通道号返回值成功：true；失败：false使用示例注释DisConnectAllChannel选项说明接口描述断开所有通道的拉流

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

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