H3C iVS IP监控系统客户端SDK说明书E1222.docx

1、H3C iVS IP监控系统客户端SDK说明书E1222H3C iVS IP监控系统客户端SDK说明书杭州华三通信技术有限公司声明Copyright 2007-2009 杭州华三通信技术有限公司及其许可者 版权所有，保留一切权利。未经本公司书面许可，任何单位和个人不得擅自摘抄、复制本书内容的部分或全部，并不得以任何形式传播。除非另有约定，本手册仅作为使用指导，本手册中的所有陈述、信息和建议不构成任何明示或暗示的担保。如需要获取最新手册，请登录。变更说明资料版本对应SDK版本主要变更内容1.20E1222(build 0427)新增内容：1.增加ViaMu协议支持。修改内容：1.修改云台控制章节

2、“不支持模拟矩阵摄像机云台控制”的描述。1.19D1220L28(build 0415)新增内容：无 修改内容：无 1.18E1220P25(build 0329)新增内容：1.增加“设置区域抓拍”接口MediaPlayer. SetSnatchZone(int channelNum, String coordinateData)2. 增加“开启/关闭实时监控缓存功能”接口MediaPlayer.SetBufferOn (int lState)3. 增加“结构IcameraInfo 获取DB33地址码”字段。4.增加“模拟矩阵云台摄像机指令发送”接口ivs. Mu_ExecutePtz(lon

3、g cameraId, EnumMuPtzOperateType operateType, int operateValue)5.增加“模拟矩阵摄像机云台操作命名枚举”说明。修改内容：1.修改“IvsSdk.Data.ICameraInfo 本域摄像机信息结构”的说明。1.17E1220P20(build 0107)新增内容：1.增加“SDK常见问题解答”章节2.增加“媒体播放器上报错误码或错误信息的事件”3.增加“媒体播放器上报下载完成事件”修改内容：1.修改部分接口和数据的描述。1.16E1220P18(build 0925)新增内容：1.“云台控制”部分增加对所支持的云台协议的说明。1.

4、15E1220P15(build 0916)修改内容：修改了部分接口和数据结构的说明。1.14E1220P10(build 0703)新增内容：1.增加“播放私有实时流”接口MediaPlayer.OpenRealWatch()2.增加“设置屏幕轮切状态”接口MediaPlayer.SetChannelSwitchInfo()修改内容：1.修改MediaPlayer.GetImage(int channel)接口的说明2.修改MediaPlayer.RGBDataReceiveEvent事件的说明3.修改MediaPlayer.SetDataCallBack()接口的说明1.13E1220(b

5、uild 0608)新增内容：语音广播功能相关数据结构和接口方法的说明。修改内容：“设置回调函数获取内部数据”修改了对回调类型宏定义的说明。1.12E1217P30 (build 0401)修改内容：修改告警上报1.11E1217P25(build 0330)新增内容：1. 增加登录类型枚举LogOnTypeEnum的定义2. 增加扩展的登录接口ivs.ClientLogOn(string ip, int port, string userName, string password, LogOnTypeEnum logOnType)修改内容：ivs.EcCameraList (string e

6、cId)增加对参数的说明1.10E1217P15(build 0220)新增内容：组轮切相关数据结构和接口1.09E1217P10 (build 0107)新增内容：事件MediaPlayer. ErrorcodeEvent获取的媒体播放器内部错误码修改内容：对部分内容的样式进行调整优化，并使用了新模版1.08E1217P05 (build 1204)新增内容：停止/恢复刷屏的接口 MediaPlayer.SetScreenRefresh()1.07E1216P10 (build 1114)新增内容：1、用户设置获取错误码或错误信息的接口ivs.SetErrorcodeOrMessage()2

7、、获取媒体播放器上报错误码的事件MediaPlayer. ErrorcodeEvent()3、设置下载文件名接口MediaPlayer. SetDownloadInfo()4、由用户指定显示窗口接口MediaPlayer.SetPlayWindow()5、设置显示方式(ddraw或者d3d)接口MediaPlayer. SetDisplayMethod()6、设置媒体播放器显示隐藏接口MediaPlayer.SetWindowsShowMode()7、抓拍接口MediaPlayer.SnatchOnce()8、静音控制接口MediaPlayer.Mute()9、音量控制接口MediaPlaye

8、r.SetVolume()10、回放控制接口MediaPlayer.SetPlaySpeed()，MediaPlayer.PlayOneByOne()，MediaPlayer.GetPlaySpeed()，MediaPlayer.SetPlayStatus()，MediaPlayer.PlaySeek()11、获取图片高和宽接口MediaPlayer.GetPlayInfo()12、设置获取内部数据回调函数MediaPlayer.SetDataCallBack()13、播放本地文件接口MediaPlayer.PlayFile()14、播放流数据接口MediaPlayer.OpenStream(

9、)，MediaPlayer.InputData()15、跨域操作接口Ivs.LowerAsList()，Ivs. LowerCamList()，Ivs.Extend_StartVideoToComputer()，Ivs.Extend_StopVideoToComputer()，Ivs.Extend_StartVideoToScreen()，Ivs.Extend_StopVideoToScreen()，Ivs.Extend_StartPtz()，Ivs.Extend_StopPtz()，Ivs.Extend_ExecutePtz()，Ivs.Extend_LockPtz()，Ivs.Extend

10、_FindVideoRecord()，Ivs.Extend_PlayVideoRecord()，Ivs.Extend_StopPlayRecord()，Ivs. LowerAsChangedEvent()，Ivs. LowerCamRcvEvent()16、云台预置位操作接口ivs.GetPresets()，ivs.GetOnePreset()，ivs.DelPreset()，ivs.AddPreset()17.设置录像路径接口MediaPlayer.SetRecordPath ()修改内容：对说明书的结构做了调整，增加了函数调用顺序H3C iVS IP监控系统客户端SDK说明书关键词：SDK

11、，API，iVS数字监控系统摘 要：介绍了iVS系统客户端SDK的数据结构和函数，作为第三方进行业务层开发的参考。缩略语清单：缩略语英文全名中文解释APIApplication Programming Interface应用程序接口ECEncoder编码器ECRRecordable Encode带存储的编码器IP SANIP Storage Area NetworkIP存储区域网络iVSIP Video Surveillance SystemIP视频监控系统MSMedia Server媒体交换服务器SDKSoftware Develop Kit软件开发包VCVideo Management C

12、lient视频管理客户端VMVideo Management Server视频管理服务器目 录H3C iVS IP监控系统客户端SDK 1说明书 1杭州华三通信技术有限公司 1H3C iVS IP监控系统客户端SDK说明书 11 iVS系统概述 11.1 基本业务功能 11.2 增值业务功能 22 iVS系统客户端SDK概述 32.1 组成 32.2 注意事项 32.2.1 基本注意事项 32.2.2 系统注意事项 43 SDK编程指南 43.1 编程说明 43.2 函数调用顺序 53.2.1 客户端SDK调用顺序 53.2.2 解码SDK调用顺序 84 SDK数据结构 104.1 基本数据结

13、构 104.1.1 IvsSdk.Data.ICameraInfo 本域摄像机信息结构 104.1.2 IvsSdk.Data.ILowerCamInfo 外域摄像机信息结构 104.1.3 IvsSdk.Data.IDomainInfo 域信息结构 104.1.4 IvsSdk.Data.IScreenInfo 显示器信息结构 104.1.5 IvsSdk.Data.IEcInfo 编码器信息结构 114.1.6 IvsSdk.Data.IDcInfo 解码器信息结构 114.1.7 IvsSdk.Data.IUserInfo 用户信息结构 114.1.8 IvsSdk.Data.ISwit

14、chInfo 轮切信息结构 114.1.9 IvsSdk.Data.IwatchRelationInfo 监控关系信息结构 114.1.10 IvsSdk.Data.IVideoRecord 时间段结构 124.1.11 IvsSdk.Data.ILogOnInfo 登录成功后参数结构 124.1.12 IvsSdk.Data.IPresetInfo 预置位信息参数结构 124.1.13 IvsSdk.Data. ILowerAsInfo下级域信息参数结构 124.1.14 IvsSdk.Data. IbackupRecord 备份录像信息参数结构 124.1.15 IvsSdk.Data.

15、IVideoInfo 视频信息参数结构 134.1.16 IvsSdk.Control. PICTURE 回调图片信息结构 134.1.17 IvsSdk.Control. tagPCMDataParam 回调音频信息结构 134.1.18 IvsSdk.Control. tagVideoFrameParam 回调视频信息结构 144.1.19 IvsSdk.Data.I CameraTeamInfo 摄像机组信息结构 144.1.20 IvsSdk.Data.I ScreenTeamInfo 监视器组信息结构 144.1.21 IvsSdk.Data.ITeamDeviceItem 组内设备

16、信息结构（摄像机、监视器通用） 144.1.22 IvsSdk.Data.IBroadCastGroupInfo 语音广播组信息结构 144.1.23 IvsSdk.Data.IEcBroadCastInfo 语音广播组内编码器信息结构 154.2 事件参数数据结构 154.2.1 Ivs. SerialDataReceiveEvent 接收串口数据的事件 154.2.2 Ivs. AlarmReceiveEvent 接收告警信息的事件 154.2.3 Ivs. PlayDvrRecordEvent 上报DVR录像回放参数的事件 154.2.4 Ivs.DownloadDvrRecordEve

17、nt 上报DVR录像下载参数的事件 164.2.5 Ivs.PtzBobbedEvent 上报云台被抢占的事件 164.2.6 Ivs.UserKickedEvent 上报用户被强制下线的事件 164.2.7 Ivs. LowerAsChangedEvent 上报外域状态变更的事件 164.2.8 Ivs. LowerCamRcvEvent 上报外域摄像机状态变更的事件 174.2.9 MediaPlayer. RealStopEvent 上报实时图像停止的事件 174.2.10 MediaPlayer. MediaDataReceiveEvent 上报媒体流数据的事件 174.2.11 Me

18、diaPlayer. RGBDataReceiveEvent 上报图像数据的事件 174.2.12 MediaPlayer. NotifyBidirectAudioResEvent 上报语音对讲状态的事件 174.2.13 MediaPlayer. InterPhoneLocalDataReceiveEvent和InterPhoneRemoteDataReceiveEvent 上报语音对讲数据的事件 184.2.14 MediaPlayer. ErrorcodeEvent 媒体播放器上报错误码或错误信息的事件 184.2.15 MediaPlayer. DownloadCompleteEven

19、t 媒体播放器上报下载完成事件 184.3 枚举类型 184.3.1 EnumOperationType 云台操作命名枚举 184.3.2 EnumMuPtzOperateType 模拟矩阵摄像机云台操作命名枚举 194.3.3 EnumOsdId OSD组号的命名枚举 194.3.4 AlarmDeviceType 告警设备类型的枚举 204.3.5 AlarmType 告警类型的枚举 204.3.6 WatchDeviceType 监控设备类型的枚举 214.3.7 OBJECT_TYPE 权限结点类型的枚举 214.3.8 IvsAuthorityType 权限类型的枚举 224.3.9

20、 PLAYSPEED 播放速度的枚举 224.3.10 LogOnTypeEnum 登录类型的枚举 224.3.11 媒体播放器上报的错误码枚举 224.3.12 错误码枚举 235 SDK 接口说明 235.1 SDK初始化 235.1.1 对象生成：通信协议对象Ivs 235.1.2 登录服务器 235.1.3 登录服务器（扩展） 245.1.4 退出登录服务器 245.1.5 初始化媒体播放器 245.1.6 初始化媒体播放器（扩展） 255.1.7 设置获取错误码还是错误信息 255.1.8 获取用户信息列表 255.1.9 获取编码器资源列表 255.1.10 获取解码器资源列表 2

21、65.1.11 获取编码器下摄像机资源列表 265.1.12 获取解码器下显示器资源列表 265.1.13 获取摄像机资源列表 265.1.14 获取域信息列表 275.1.15 获取显示器资源列表 275.1.16 获取单个摄像机信息 275.1.17 获取摄像机所属的编码器信息 275.1.18 获取单个显示器信息 285.1.19 获取服务器参数信息 285.1.20 获取下级域集中的所有下级域 285.1.21 获取下级域中的共享摄像机列表 285.1.22 设置云台指令是否通过VM转发 295.2 用户管理 295.2.1 增加用户信息 295.2.2 删除用户 295.2.3 增加

22、用户权限信息 295.2.4 删除用户权限信息 305.2.5 修改用户权限信息 305.2.6 查询用户权限信息 305.2.7 查询监控关系信息 315.3 设置播放器界面 315.3.1 设置窗口显示/隐藏模式 315.3.2 设置窗口数目 315.3.3 设置媒体播放器工具栏状态 315.3.4 退出媒体播放器的全屏模式 325.3.5 用户指定显示窗口 325.4 设置显示属性 325.4.1 设置播放显示模式 325.4.2 设置中值处理模式 335.4.3 设置播放显示方式 335.5 设置是否经过MS、是否使用组播 335.5.1 设置点播回放（或下载）是否经过MS 335.5

23、.2 设置实时监控是否经过MS、是否使用组播 335.6 实时监控 345.6.1 开启/关闭实时监控缓存 345.6.2 启动实时监控到显示器 345.6.3 停止实时监控到显示器 345.6.4 启动实时监控到屏幕 355.6.5 停止实时监控到屏幕 355.6.6 启动实时监控到显示器（支持本域或者外域） 355.6.7 停止实时监控到显示器（支持本域或者外域） 365.6.8 启动实时监控到屏幕（支持本域和外域） 365.6.9 停止实时监控到屏幕（支持本域和外域） 365.6.10 停止实时监控成功事件 375.6.11 实时监控调用示例 375.7 云台控制 385.7.1 获取云

24、台控制权 385.7.2 释放云台控制权 385.7.3 云台控制 395.7.4 开启云台控制功能（支持本域和外域） 395.7.5 停止云台控制功能（支持本域和外域） 395.7.6 发送云台控制指令（支持本域和外域） 395.7.7 锁定云台功能（支持本域和外域） 405.7.8 云台控制调用示例 405.7.9 模拟矩阵云台摄像机指令发送 415.7.10 获取指定摄像机的所有预置位信息 415.7.11 获取指定摄像机的指定预置位信息 415.7.12 增加或修改预置位信息 425.7.13 删除预置位信息 425.7.14 预置位调用示例 425.8 回放和下载 455.8.1 查

25、找存储的录像信息 455.8.2 播放存储的录像 455.8.3 设置下载录像的保存路径 465.8.4 设置下载录像的保存信息 465.8.5 下载存储的录像 465.8.6 查找存储的录像信息（支持本域和外域） 475.8.7 开始播放存储的录像（支持本域和外域） 475.8.8 停止播放存储的录像（支持本域和外域） 485.8.9 回放调用示例 485.8.10 DVR录像回放和下载 495.9 播放本地文件 515.10 播放流数据 515.10.1 启动流数据播放业务 515.10.2 用户输入流数据 515.10.3 调用示例 525.11 播放私有实时流 525.12 回放控制

26、535.12.1 设置播放速度 535.12.2 获取播放速度 535.12.3 单帧前进功能 535.12.4 设置文件播放暂停/恢复状态 545.12.5 获取播放的进度信息 545.12.6 文件跳转播放 545.13 前端录像 555.13.1 开始手动录像 555.13.2 停止手动录像 555.14 前端备份 555.14.1 备份录像 555.14.2 备份录像查询 565.14.3 播放备份录像 565.14.4 下载备份录像 565.15 轮切控制 575.15.1 查询显示器的轮切信息 575.15.2 启动显示器的轮切 575.15.3 停止显示器的轮切 575.15.4

27、 保存显示器的轮切配置 585.15.5 查询屏幕的轮切信息 585.15.6 启动屏幕的轮切 585.15.7 停止屏幕的轮切 585.15.8 设置屏幕的轮切状态 595.15.9 保存屏幕的轮切配置 595.16 组轮切 595.16.1 获取摄像机组列表 595.16.2 获取监视器组列表 595.16.3 增加摄像机组 605.16.4 设置摄像机组中的设备列表 605.16.5 修改摄像机组 615.16.6 删除摄像机组 615.16.7 增加监视器组 615.16.8 设置监视器组中的设备列表 625.16.9 修改监视器组 625.16.10 删除监视器组 625.16.11

28、 启动组轮切 635.16.12 停止组轮切 635.16.13 查询摄像机组组轮切 635.16.14 查询监视器组组切 635.16.15 组轮切调用示例 645.17 视频抓图 665.17.1 设置抓拍图像的保存路径 665.17.2 视频抓图 665.17.3 设置抓拍区域 665.18 本地录像 675.18.1 设置本地录像的保存路径 675.18.2 开始本地录像 685.18.3 停止本地录像 685.19 数据获取 685.19.1 设置回调函数获取内部数据 685.19.2 开始获取视频媒体流 705.19.3 接收视频数据流事件 705.19.4 停止获取视频媒体流 7

29、15.19.5 开始获取RGB数据 715.19.6 接收视频解码数据事件 715.19.7 停止获取RGB数据 725.19.8 获取通道BMP位图 725.19.9 获得图片的宽和高 725.20 语音对讲 725.20.1 启动双向语音对讲 725.20.2 停止双向语音对讲 735.20.3 启动双向语音数据上报 735.20.4 关闭双向语音数据上报 735.20.5 启动/停止双向语音对讲事件 735.20.6 接收本地语音对讲数据事件 745.20.7 接收远端语音对讲数据事件 745.20.8 调用示例 745.21 语音广播 755.21.1 获取语音广播组列表 755.21

30、.2 获取某个语音广播组内编码器信息列表 755.21.3 启动语音广播 765.21.4 停止语音广播 765.21.5 设置语音广播组使用状态 765.22 音频控制 775.22.1 静音控制功能 775.22.2 设置音量 775.23 OSD信息设置与删除 775.23.1 设置OSD信息 775.23.2 删除OSD信息 785.24 透明串口 785.24.1 串口透明通道发送 785.24.2 绑定接收串口事件 785.25 获取当前活动通道号 795.26 停止/恢复刷屏 795.27 通用业务关闭接口 795.28 系统退出资源释放 796 SDK使用说明 806.1 文件说明 806.2 使用指南 806.2.1 步骤1 806.2.2 步骤2 806.2.3 步骤3 837 SDK 常见问题解答 847.1 C#版SDK可以使用什么语言开发？ 847.2 怎样确定我的机器是否能够正常运行SDK？ 84