H3C iVS IP监控系统客户端SDK说明书E1222.docx
《H3C iVS IP监控系统客户端SDK说明书E1222.docx》由会员分享，可在线阅读，更多相关《H3C iVS IP监控系统客户端SDK说明书E1222.docx（119页珍藏版）》请在冰豆网上搜索。
H3CiVSIP监控系统客户端SDK说明书E1222
H3CiVSIP监控系统客户端SDK
说明书
杭州华三通信技术有限公司
声明
Copyright©2007-2009杭州华三通信技术有限公司及其许可者版权所有，保留一切权利。
未经本公司书面许可，任何单位和个人不得擅自摘抄、复制本书内容的部分或全部，并不得以任何形式传播。
除非另有约定，本手册仅作为使用指导，本手册中的所有陈述、信息和建议不构成任何明示或暗示的担保。
如需要获取最新手册，请登录。
变更说明
资料版本
对应SDK版本
主要变更内容
1.20
E1222
（build0427）
新增内容：
1.增加ViaMu协议支持。
修改内容：
1.修改云台控制章节“不支持模拟矩阵摄像机云台控制”的描述。
1.19
D1220L28
（build0415）
新增内容：
无
修改内容：
无
1.18
E1220P25
（build0329）
新增内容：
1.增加“设置区域抓拍”接口MediaPlayer.SetSnatchZone（intchannelNum,StringcoordinateData）
2.增加“开启/关闭实时监控缓存功能”接口MediaPlayer.SetBufferOn（intlState）
3.增加“结构IcameraInfo获取DB33地址码”字段。
4.增加“模拟矩阵云台摄像机指令发送”接口ivs.Mu_ExecutePtz（longcameraId,EnumMuPtzOperateTypeoperateType,intoperateValue）
5.增加“模拟矩阵摄像机云台操作命名枚举”说明。
修改内容：
1.修改“IvsSdk.Data.ICameraInfo本域摄像机信息结构”的说明。
1.17
E1220P20
（build0107）
新增内容：
1.增加“SDK常见问题解答”章节
2.增加“媒体播放器上报错误码或错误信息的事件”
3.增加“媒体播放器上报下载完成事件”
修改内容：
1.修改部分接口和数据的描述。
1.16
E1220P18
（build0925）
新增内容：
1.“云台控制”部分增加对所支持的云台协议的说明。
1.15
E1220P15
（build0916）
修改内容：
修改了部分接口和数据结构的说明。
1.14
E1220P10
（build0703）
新增内容：
1.增加“播放私有实时流”接口MediaPlayer.OpenRealWatch（）
2.增加“设置屏幕轮切状态”接口MediaPlayer.SetChannelSwitchInfo（）
修改内容：
1.修改MediaPlayer.GetImage（intchannel）接口的说明
2.修改MediaPlayer.RGBDataReceiveEvent事件的说明
3.修改MediaPlayer.SetDataCallBack（）接口的说明
1.13
E1220
（build0608）
新增内容：
语音广播功能相关数据结构和接口方法的说明。
修改内容：
“设置回调函数获取内部数据”修改了对回调类型宏定义的说明。
1.12
E1217P30
（build0401）
修改内容：
修改告警上报
1.11
E1217P25
（build0330）
新增内容：
1.增加登录类型枚举LogOnTypeEnum的定义
2.增加扩展的登录接口ivs.ClientLogOn（stringip,intport,stringuserName,stringpassword,LogOnTypeEnumlogOnType）
修改内容：
ivs.EcCameraList（stringecId）增加对参数的说明
1.10
E1217P15
（build0220）
新增内容：
组轮切相关数据结构和接口
1.09
E1217P10（build0107）
新增内容：
事件MediaPlayer.ErrorcodeEvent获取的媒体播放器内部错误码
修改内容：
对部分内容的样式进行调整优化，并使用了新模版
1.08
E1217P05（build1204）
新增内容：
停止/恢复刷屏的接口MediaPlayer.SetScreenRefresh（）
1.07
E1216P10（build1114）
新增内容：
1、用户设置获取错误码或错误信息的接口ivs.SetErrorcodeOrMessage（）
2、获取媒体播放器上报错误码的事件MediaPlayer.ErrorcodeEvent（）
3、设置下载文件名接口MediaPlayer.SetDownloadInfo（）
4、由用户指定显示窗口接口MediaPlayer.SetPlayWindow（）
5、设置显示方式（ddraw或者d3d）接口MediaPlayer.SetDisplayMethod（）
6、设置媒体播放器显示\隐藏接口MediaPlayer.SetWindowsShowMode（）
7、抓拍接口MediaPlayer.SnatchOnce（）
8、静音控制接口MediaPlayer.Mute（）
9、音量控制接口MediaPlayer.SetVolume（）
10、回放控制接口
MediaPlayer.SetPlaySpeed（），MediaPlayer.PlayOneByOne（），MediaPlayer.GetPlaySpeed（），MediaPlayer.SetPlayStatus（），MediaPlayer.PlaySeek（）
11、获取图片高和宽接口MediaPlayer.GetPlayInfo（）
12、设置获取内部数据回调函数MediaPlayer.SetDataCallBack（）
13、播放本地文件接口MediaPlayer.PlayFile（）
14、播放流数据接口
MediaPlayer.OpenStream（），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_FindVideoRecord（），Ivs.Extend_PlayVideoRecord（），Ivs.Extend_StopPlayRecord（），Ivs.LowerAsChangedEvent（），Ivs.LowerCamRcvEvent（）
16、云台预置位操作接口
ivs.GetPresets（），ivs.GetOnePreset（），ivs.DelPreset（），ivs.AddPreset（）
17.设置录像路径接口MediaPlayer.SetRecordPath（）
修改内容：
对说明书的结构做了调整，增加了函数调用顺序
H3CiVSIP监控系统客户端SDK说明书
关键词：
SDK，API，iVS数字监控系统
摘要：
介绍了iVS系统客户端SDK的数据结构和函数，作为第三方进行业务层开发的参考。
缩略语清单：
缩略语
英文全名
中文解释
API
ApplicationProgrammingInterface
应用程序接口
EC
Encoder
编码器
ECR
RecordableEncode
带存储的编码器
IPSAN
IPStorageAreaNetwork
IP存储区域网络
iVS
IPVideoSurveillanceSystem
IP视频监控系统
MS
MediaServer
媒体交换服务器
SDK
Software Develop Kit
软件开发包
VC
VideoManagementClient
视频管理客户端
VM
VideoManagementServer
视频管理服务器
目录
H3CiVSIP监控系统客户端SDK1
说明书1
杭州华三通信技术有限公司1
H3CiVSIP监控系统客户端SDK说明书1
1iVS系统概述1
1.1基本业务功能1
1.2增值业务功能2
2iVS系统客户端SDK概述3
2.1组成3
2.2注意事项3
2.2.1基本注意事项3
2.2.2系统注意事项4
3SDK编程指南4
3.1编程说明4
3.2函数调用顺序5
3.2.1客户端SDK调用顺序5
3.2.2解码SDK调用顺序8
4SDK数据结构10
4.1基本数据结构10
4.1.1IvsSdk.Data.ICameraInfo本域摄像机信息结构10
4.1.2IvsSdk.Data.ILowerCamInfo外域摄像机信息结构10
4.1.3IvsSdk.Data.IDomainInfo域信息结构10
4.1.4IvsSdk.Data.IScreenInfo显示器信息结构10
4.1.5IvsSdk.Data.IEcInfo编码器信息结构11
4.1.6IvsSdk.Data.IDcInfo解码器信息结构11
4.1.7IvsSdk.Data.IUserInfo用户信息结构11
4.1.8IvsSdk.Data.ISwitchInfo轮切信息结构11
4.1.9IvsSdk.Data.IwatchRelationInfo监控关系信息结构11
4.1.10IvsSdk.Data.IVideoRecord时间段结构12
4.1.11IvsSdk.Data.ILogOnInfo登录成功后参数结构12
4.1.12IvsSdk.Data.IPresetInfo预置位信息参数结构12
4.1.13IvsSdk.Data.ILowerAsInfo下级域信息参数结构12
4.1.14IvsSdk.Data.IbackupRecord备份录像信息参数结构12
4.1.15IvsSdk.Data.IVideoInfo视频信息参数结构13
4.1.16IvsSdk.Control.PICTURE回调图片信息结构13
4.1.17IvsSdk.Control.tagPCMDataParam回调音频信息结构13
4.1.18IvsSdk.Control.tagVideoFrameParam回调视频信息结构14
4.1.19IvsSdk.Data.ICameraTeamInfo摄像机组信息结构14
4.1.20IvsSdk.Data.IScreenTeamInfo监视器组信息结构14
4.1.21IvsSdk.Data.ITeamDeviceItem组内设备信息结构（摄像机、监视器通用）14
4.1.22IvsSdk.Data.IBroadCastGroupInfo语音广播组信息结构14
4.1.23IvsSdk.Data.IEcBroadCastInfo语音广播组内编码器信息结构15
4.2事件参数数据结构15
4.2.1Ivs.SerialDataReceiveEvent接收串口数据的事件15
4.2.2Ivs.AlarmReceiveEvent接收告警信息的事件15
4.2.3Ivs.PlayDvrRecordEvent上报DVR录像回放参数的事件15
4.2.4Ivs.DownloadDvrRecordEvent上报DVR录像下载参数的事件16
4.2.5Ivs.PtzBobbedEvent上报云台被抢占的事件16
4.2.6Ivs.UserKickedEvent上报用户被强制下线的事件16
4.2.7Ivs.LowerAsChangedEvent上报外域状态变更的事件16
4.2.8Ivs.LowerCamRcvEvent上报外域摄像机状态变更的事件17
4.2.9MediaPlayer.RealStopEvent上报实时图像停止的事件17
4.2.10MediaPlayer.MediaDataReceiveEvent上报媒体流数据的事件17
4.2.11MediaPlayer.RGBDataReceiveEvent上报图像数据的事件17
4.2.12MediaPlayer.NotifyBidirectAudioResEvent上报语音对讲状态的事件17
4.2.13MediaPlayer.InterPhoneLocalDataReceiveEvent和InterPhoneRemoteDataReceiveEvent上报语音对讲数据的事件18
4.2.14MediaPlayer.ErrorcodeEvent媒体播放器上报错误码或错误信息的事件18
4.2.15MediaPlayer.DownloadCompleteEvent媒体播放器上报下载完成事件18
4.3枚举类型18
4.3.1EnumOperationType云台操作命名枚举18
4.3.2EnumMuPtzOperateType模拟矩阵摄像机云台操作命名枚举19
4.3.3EnumOsdIdOSD组号的命名枚举19
4.3.4AlarmDeviceType告警设备类型的枚举20
4.3.5AlarmType告警类型的枚举20
4.3.6WatchDeviceType监控设备类型的枚举21
4.3.7OBJECT_TYPE权限结点类型的枚举21
4.3.8IvsAuthorityType权限类型的枚举22
4.3.9PLAYSPEED播放速度的枚举22
4.3.10LogOnTypeEnum登录类型的枚举22
4.3.11媒体播放器上报的错误码枚举22
4.3.12错误码枚举23
5SDK接口说明23
5.1SDK初始化23
5.1.1对象生成：
通信协议对象Ivs23
5.1.2登录服务器23
5.1.3登录服务器（扩展）24
5.1.4退出登录服务器24
5.1.5初始化媒体播放器24
5.1.6初始化媒体播放器（扩展）25
5.1.7设置获取错误码还是错误信息25
5.1.8获取用户信息列表25
5.1.9获取编码器资源列表25
5.1.10获取解码器资源列表26
5.1.11获取编码器下摄像机资源列表26
5.1.12获取解码器下显示器资源列表26
5.1.13获取摄像机资源列表26
5.1.14获取域信息列表27
5.1.15获取显示器资源列表27
5.1.16获取单个摄像机信息27
5.1.17获取摄像机所属的编码器信息27
5.1.18获取单个显示器信息28
5.1.19获取服务器参数信息28
5.1.20获取下级域集中的所有下级域28
5.1.21获取下级域中的共享摄像机列表28
5.1.22设置云台指令是否通过VM转发29
5.2用户管理29
5.2.1增加用户信息29
5.2.2删除用户29
5.2.3增加用户权限信息29
5.2.4删除用户权限信息30
5.2.5修改用户权限信息30
5.2.6查询用户权限信息30
5.2.7查询监控关系信息31
5.3设置播放器界面31
5.3.1设置窗口显示/隐藏模式31
5.3.2设置窗口数目31
5.3.3设置媒体播放器工具栏状态31
5.3.4退出媒体播放器的全屏模式32
5.3.5用户指定显示窗口32
5.4设置显示属性32
5.4.1设置播放显示模式32
5.4.2设置中值处理模式33
5.4.3设置播放显示方式33
5.5设置是否经过MS、是否使用组播33
5.5.1设置点播回放（或下载）是否经过MS33
5.5.2设置实时监控是否经过MS、是否使用组播33
5.6实时监控34
5.6.1开启/关闭实时监控缓存34
5.6.2启动实时监控到显示器34
5.6.3停止实时监控到显示器34
5.6.4启动实时监控到屏幕35
5.6.5停止实时监控到屏幕35
5.6.6启动实时监控到显示器（支持本域或者外域）35
5.6.7停止实时监控到显示器（支持本域或者外域）36
5.6.8启动实时监控到屏幕（支持本域和外域）36
5.6.9停止实时监控到屏幕（支持本域和外域）36
5.6.10停止实时监控成功事件37
5.6.11实时监控调用示例37
5.7云台控制38
5.7.1获取云台控制权38
5.7.2释放云台控制权38
5.7.3云台控制39
5.7.4开启云台控制功能（支持本域和外域）39
5.7.5停止云台控制功能（支持本域和外域）39
5.7.6发送云台控制指令（支持本域和外域）39
5.7.7锁定云台功能（支持本域和外域）40
5.7.8云台控制调用示例40
5.7.9模拟矩阵云台摄像机指令发送41
5.7.10获取指定摄像机的所有预置位信息41
5.7.11获取指定摄像机的指定预置位信息41
5.7.12增加或修改预置位信息42
5.7.13删除预置位信息42
5.7.14预置位调用示例42
5.8回放和下载45
5.8.1查找存储的录像信息45
5.8.2播放存储的录像45
5.8.3设置下载录像的保存路径46
5.8.4设置下载录像的保存信息46
5.8.5下载存储的录像46
5.8.6查找存储的录像信息（支持本域和外域）47
5.8.7开始播放存储的录像（支持本域和外域）47
5.8.8停止播放存储的录像（支持本域和外域）48
5.8.9回放调用示例48
5.8.10DVR录像回放和下载49
5.9播放本地文件51
5.10播放流数据51
5.10.1启动流数据播放业务51
5.10.2用户输入流数据51
5.10.3调用示例52
5.11播放私有实时流52
5.12回放控制53
5.12.1设置播放速度53
5.12.2获取播放速度53
5.12.3单帧前进功能53
5.12.4设置文件播放暂停/恢复状态54
5.12.5获取播放的进度信息54
5.12.6文件跳转播放54
5.13前端录像55
5.13.1开始手动录像55
5.13.2停止手动录像55
5.14前端备份55
5.14.1备份录像55
5.14.2备份录像查询56
5.14.3播放备份录像56
5.14.4下载备份录像56
5.15轮切控制57
5.15.1查询显示器的轮切信息57
5.15.2启动显示器的轮切57
5.15.3停止显示器的轮切57
5.15.4保存显示器的轮切配置58
5.15.5查询屏幕的轮切信息58
5.15.6启动屏幕的轮切58
5.15.7停止屏幕的轮切58
5.15.8设置屏幕的轮切状态59
5.15.9保存屏幕的轮切配置59
5.16组轮切59
5.16.1获取摄像机组列表59
5.16.2获取监视器组列表59
5.16.3增加摄像机组60
5.16.4设置摄像机组中的设备列表60
5.16.5修改摄像机组61
5.16.6删除摄像机组61
5.16.7增加监视器组61
5.16.8设置监视器组中的设备列表62
5.16.9修改监视器组62
5.16.10删除监视器组62
5.16.11启动组轮切63
5.16.12停止组轮切63
5.16.13查询摄像机组组轮切63
5.16.14查询监视器组组切63
5.16.15组轮切调用示例64
5.17视频抓图66
5.17.1设置抓拍图像的保存路径66
5.17.2视频抓图66
5.17.3设置抓拍区域66
5.18本地录像67
5.18.1设置本地录像的保存路径67
5.18.2开始本地录像68
5.18.3停止本地录像68
5.19数据获取68
5.19.1设置回调函数获取内部数据68
5.19.2开始获取视频媒体流70
5.19.3接收视频数据流事件70
5.19.4停止获取视频媒体流71
5.19.5开始获取RGB数据71
5.19.6接收视频解码数据事件71
5.19.7停止获取RGB数据72
5.19.8获取通道BMP位图72
5.19.9获得图片的宽和高72
5.20语音对讲72
5.20.1启动双向语音对讲72
5.20.2停止双向语音对讲73
5.20.3启动双向语音数据上报73
5.20.4关闭双向语音数据上报73
5.20.5启动/停止双向语音对讲事件73
5.20.6接收本地语音对讲数据事件74
5.20.7接收远端语音对讲数据事件74
5.20.8调用示例74
5.21语音广播75
5.21.1获取语音广播组列表75
5.21.2获取某个语音广播组内编码器信息列表75
5.21.3启动语音广播76
5.21.4停止语音广播76
5.21.5设置语音广播组使用状态76
5.22音频控制77
5.22.1静音控制功能77
5.22.2设置音量77
5.23OSD信息设置与删除77
5.23.1设置OSD信息77
5.23.2删除OSD信息78
5.24透明串口78
5.24.1串口透明通道发送78
5.24.2绑定接收串口事件78
5.25获取当前活动通道号79
5.26停止/恢复刷屏79
5.27通用业务关闭接口79
5.28系统退出资源释放79
6SDK使用说明80
6.1文件说明80
6.2使用指南80
6.2.1步骤180
6.2.2步骤280
6.2.3步骤383
7SDK常见问题解答84
7.1C#版SDK可以使用什么语言开发？
84
7.2怎样确定我的机器是否能够正常运行SDK？
84
升级会员 