海康视频监控平台单路回放组件使用说明书IPlayBackCtrlWord下载.docx

1、1.2.2 软件环境操作系统：Windows XP / Windows 7 / Windows 8（可支持Windows Server 2003/2008）操作系统位数：32位/64位显卡驱动：支持Overlay模式，支持硬件BLTIE版本： IE6 / IE8 / IE9 / IE10 / IE111.3 使用场景视频监控客户端需要用到单路回放播放窗口的应用场景。1.4 技术制约及局限1. 部分接口内部使用线程任务队列异步调用，存在一定延时。2. 组件为Windows 32位版本。1.5 参考资料无2. 接口定义2.1 接口说明2.1.1 导出接口2.1.1.1 初始化接口名称SPB_CTR

2、L_Init接口描述初始化接口原型PB_RET_TYPE SPB_CTRL_Init（void）;输入void返回值PB_RET_TYPE：0成功，其他失败备注示例2.1.1.2 反初始化SPB_CTRL_Uninit反初始化PB_RET_TYPE SPB_CTRL_Uninit（void）;2.1.1.3 创建单路回放对象SPB_CTRL_Create创建单路回放对象ISinglePlaybackControl* SPB_CTRL_Create（HWND hParent, BOOL bHasClose = TRUE, BOOL bHasPbTool = FALSE）;hParent：父窗口句

3、柄bHasClose：小窗口是否有关闭按钮bHasPbTool：是否有回放工具栏ISinglePlaybackControl*：成功返回对象的指针，失败返回NULL2.1.1.4 销毁单路回放对象SPB_CTRL_Destroy销毁单路回放对象PB_RET_TYPE SPB_CTRL_Destroy（ISinglePlaybackControl*& pObject）;pObject：对象的指针的引用2.1.2 基本业务2.1.2.1 设置基本参数SetBasicInfo设置基本参数PB_RET_TYPE SetBasicInfo（const SPB_BASIC_INFO& stBasicInf

4、o,bool bReset = true,bool bClearRcd = true）stBasicInfo：基本参数bReset：是否重置（已废弃）bClearRcd：是否清空录像最先调用的接口之一，每次StopPlay之后都必须重新设置一遍。SPB_BASIC_INFO _basic;_basic.stCuInfo.cuZoneId = 1;_basic.stCuInfo.vmsIp = 10.18.33.103;_basic.stCuInfo.vmsPort = 80;_basic.stCamera.camName = 测试监控点_basic.stCamera.camIdx = 1000

5、0000001310000012_basic.stCamera.rcdSvrType = PB_RCD_SERVER_TYPE_VRM;_basic.stCamera.rcdSvrIP = _basic.stCamera.rcdSvrPort = 6300;std:stringstream ss;ss playback:PB_OPCODE_VOICE ,PB_OPCODE_ONE_SNAP PB_OPCODE_MULTI_SNAP PB_OPCODE_SAVE_CLIP SetBasicInfo（_basic）;2.1.2.2 获取基本参数GetBasicInfo获取基本参数PB_RET_TY

6、PE GetBasicInfo（SPB_BASIC_INFO& stBasicInfo）SPB_BASIC_INFO & stBasicInfo：2.1.2.3 查询录像SearchRecord查询录像PB_RET_TYPE SearchRecord（const SPB_RCD_SEARCH_PARAM& stParam,bool bClean = true）stParam：查询录像的参数1. 支持向VMS获取VMR地址，再进行录像查询。2. 支持直接向VRM查询。3. 支持NCG级联录像查询。4. 支持KMS录像查询。SPB_RCD_SEARCH_PARAM _param;_param.tB

7、egin = TimeStringToNumber（2015-01-13T00:00:00.000Z）;_param.tEnd = TimeStringToNumber（2015-01-13T23:59:59.000Z_param.rcdType = RT_ALL;_param.pRcdFun = CB_SearchResult;_param.pRcdUser = this;SearchRecord（_param）;2.1.2.4 设置录像信息SetRecordInfo设置录像信息PB_RET_TYPE SetRecordInfo（const RECORD_SEARCH_RESULT_MAP&

8、 records,bool bClean = false）records：录像信息bool bClean ：清空原有录像实际是追加录像片段，如果片段的起始时间一样，则会被覆盖。2.1.2.5 获取录像信息GetRecordInfo获取录像信息PB_RET_TYPE GetRecordInfo（RECORD_SEARCH_RESULT_MAP& records）获取的是内部所有的录像片段信息2.1.2.6 开始回放StartPlay开始回放PB_RET_TYPE StartPlay（time_t tPlay = playback:INVALID_TIME_VALUE,time_t tEnd =

9、playback:INVALID_TIME_VALUE）tPlay：可指定开始播放的时间, 不指定则使用SetRecordInfo中得到的最早时间内部必须要有录像片段才能回放，支持：1. 调用SetRecordInfo接口设置录像信息，直接播放。2. 外部SearchRecord接口查询录像，等到查询回调返回后，才可以播放。2.1.2.7 停止回放StopPlay停止回放PB_RET_TYPE StopPlay（BOOL bClearRcd = FALSE）是否清空录像片段内部状态会被重置，下次播放必须要重新SetBasicInfo。2.1.2.8 挂起播放PendingPlay挂起播放PB_

10、RET_TYPE PendingPlay（void）仅停止播放，但不重置内部状态，可以直接重新播放。2.1.2.9 筛选录像类型FilterPlayType对录像类型进行筛选PB_RET_TYPE FilterPlayType（unsigned int recType）recType：筛选后允许播放的录像类型播放过程中不匹配的录像片段类型直接跳过。2.1.3 参数设置2.1.3.1 设置窗口序号SetIndex设置窗口序号PB_RET_TYPE SetIndex（WND_INDEX wndIndex）wndIndex：窗口序号序号从0开始，默认为-1。2.1.3.2 获取窗口序号GetWndI

11、ndex获取窗口序号WND_INDEX GetWndIndex（void） constWND_INDEX：2.1.3.3 配置常用参数Configurate配置常用参数PB_RET_TYPE Configurate（const PB_CONFIGURATION& cfg）cfg：常用参数如果不配置使用默认的，则有的可能为非法值，导致操作失效。PB_CONFIGURATION cfg;cfg.toolbarShowMode = TBSM_ALWAYS_SHOW;cfg.statusbarShowMode = TBSM_AUTO;cfg.toolbarBtns.push_back（BTN_ID_I

12、NFO）;cfg.toolbarBtns.push_back（BTN_ID_SOUND）;cfg.toolbarBtns.push_back（BTN_ID_VOLUMN）;cfg.toolbarBtns.push_back（BTN_ID_SNAP_ONE）;cfg.toolbarBtns.push_back（BTN_ID_SNAP_MULTI）;cfg.toolbarBtns.push_back（BTN_ID_SAVE_CLIP）;cfg.toolbarBtns.push_back（BTN_ID_ZOOM）;cfg.clipCfg.packSize = 512;Configurate（cfg）

13、;2.1.3.4 设置性能参数SetPerformance设置性能参数void SetPerformance（const PB_PERFORMACE_PARAM& stPerform）stPerform：播放性能参数下次播放时生效2.1.3.5 设置磁盘状态SetDiskState设置磁盘状态PB_RET_TYPE SetDiskState（int nOperation, int nDiskState）nOperation：磁盘空间对应操作的位置（见PLAYBACK_DISK_OPERATION）nDiskState：磁盘空间的状态（见DISK_FREE_SPACE_STATE）2.1.4 播

14、放控制2.1.4.1 获取播放端口GetPlayPort获取播放端口int GetPlayPort（void） constint：播放端口并不是播放库的播放端口，而是vag_playctrl的句柄。2.1.4.2 暂停/恢复播放Pause暂停/恢复播放PB_RET_TYPE Pause（BOOL bPause = TRUE）bPause：是否暂停2.1.4.3 单帧前进ForwardOneFrame单帧前进PB_RET_TYPE ForwardOneFrame（void）2.1.4.4 单帧后退BackwardOneFrame单帧后退PB_RET_TYPE BackwardOneFrame（v

15、oid）仅海康播放库支持，切换到文件播放模式，在播放缓冲中单帧后退，到了文件头则无法再操作。2.1.4.5 打开/关闭声音OpenSound打开/关闭声音PB_RET_TYPE OpenSound（BOOL bOpen = TRUE）bOpen：是否打开声音在1倍速播放时才可以操作声音。2.1.4.6 设置音量大小SetSoundVolumn设置音量大小PB_RET_TYPE SetSoundVolumn（int nVolumn）nVolumn：音量大小，010002.1.4.7 获取音量大小GetSoundVolumn获取音量大小int GetSoundVolumn（void）2.1.4.8

16、 切换到倒放/正放Reverse切换到倒放/正放PB_RET_TYPE Reverse（BOOL bBackward = TRUE）bBackward：是否倒放2.1.4.9 自适应/拉伸显示Adaptive自适应/拉伸显示PB_RET_TYPE Adaptive（BOOL bAdaptive = TRUE）bAdaptive：是否自适应显示2.1.4.10 设置回放速度SetSpeed设置回放速度PB_RET_TYPE SetSpeed（int nSpeed）nSpeed：回放速度回放速度，取值范围参见PB_STREAM_SPEED。2.1.4.11 定位到指定时间点SeekToTime定位

17、到指定时间点PB_RET_TYPE SeekToTime（time_t tSeek）tSeek：定位时间点2.1.4.12 抓图SnapShot抓图PB_RET_TYPE SnapShot（long lId, BOOL bContinous）lId：操作ID，一次操作需要有一个ID，用于在回调中反馈bContinous：TRUE表示连续抓图，FALSE表示单张抓图通过抓图回调返回。2.1.4.13 进入/退出电子放大DigitalZoom进入/退出电子放大PB_RET_TYPE DigitalZoom（void）只能在UI线程中调用。2.1.5 注册回调2.1.5.1 注册状态通知回调RegS

18、tateChgCB注册状态通知回调PB_RET_TYPE RegStateChgCB（PB_STATECHG_CB pfun, void* pUser）pfun：回调函数pUser：用户数据2.1.5.2 注册操作回调RegActionCB注册操作回调void RegActionCB（PB_ACTION_CB pFun, void* pUser）pFun：主要用于记录操作日志2.1.5.3 注册播放窗口画图回调RegPlayWndDrawCB注册播放窗口画图回调void RegPlayWndDrawCB（PB_PLAYWND_DRAW_CB pFun, void* pUser）2.1.5.4

19、注册窗口消息回调RegWindowMsg注册窗口消息回调PB_RET_TYPE RegWindowMsg（PB_WNDMSG_CB pfun, long lUser）2.1.5.5 注册窗口消息回调RegWindowMsgExPB_RET_TYPE RegWindowMsgEx（PB_WNDMSG_CB_EX pfun, long lUser）回调函数带有窗口序号。 2.1.6 获取状态2.1.6.1 获取播放时间GetPlayerTime获取播放时间time_t GetPlayerTime（void）time_t：播放时间，无效时为-1并不总是有效，原因如下：1、 此接口不是直接向播放库获取

20、时间，而是通过塞数据线程更新播放时间。2、 有些码流获取的播放时间无效，例如大华设备码流、ehome设备码流。2.1.6.2 获取播放速度GetPlaySpeed获取播放速度int GetPlaySpeed（void）播放速度值，参见PLAYBACK_SPEED2.1.6.3 是否处于空闲状态IsIdle播放窗口是否处于空闲状态BOOL IsIdle（void） constBOOL：TRUE是，FALSE否StopPlay之后会处于空闲状态2.1.6.4 是否处于挂起状态IsPending是否处于挂起状态BOOL IsPending（void） constPendingPlay之后会处于挂起状态2.1.6.5 是否有录像信息HasRecords是否有录像信息BOOL HasRecords（void）TRUE有，FALSE没有2.1.6.6 指定时间范围内是否有录像信息指定时间范围内是否有录像信息BOOL HasRecords（time_t tSta, time_t tEnd）tSta：起始时