Android 取流播放获取资源SDK使用说明书.docx

1、Android 取流播放获取资源SDK使用说明书Android SDK使用说明文档一. 文档阅读说明非常感谢您选购我们公司的产品，申请我们的SDK进行二次开发。温馨的提醒您在开发前请您对整个说明文档进行仔细阅读，以便整体的了解开发流程。二. SDK内容说明该文档主要针对手机客户端iVMS-5060取流播放SDK进行说明，文档介绍区分手机客户端2.0和3.0版本。2个版本的SDK区分如下：功能2.0SDK3.0SDK取流方式支持MAG支持MAG、VTDU(区分主子码流)资源获取方式通过WebView加载平台返回的URL(平台实现，手机客户端只需要实现webview相关内容)通过VmsNetSDK

2、.jar网络库进行获取资源(需要在手机客户端实现)是否支持远程回放否是以上是2.0SDK和3.0SDK的主要区别，开发者可以根据平台目前支持的手机客户端版本进行选择，如果该平台支持手机客户端iVMS-5060 V2.0系列版本，则需要使用2.0版本的SDK，如果该平台支持手机客户端iVMS-5060 V3.0系列版本，则需要使用3.0版本的SDK。具体平台支持哪个版本的手机客户端，需要咨询平台相关开发人员。三. 3.0SDK使用说明系统框架图如图3-1所示：图3-1 3.0手机客户端与平台系统架构图(1)登录流程: 首先要获取线路也就是调用getLineList接口 其次调用登录接口login

3、接口，该接口中会用到getLineList接口中返回的线路(具体参考SDKdemo中相关接口注释) (2)获取资源流程： 获取资源流程，用到的接口有5个 getControlUnitList ：获取控制中心的列表getRegionListFromCtrlUnit： 从控制中心中获取区域列表getRegionListFromRegion： 从区域获取区域列表getCameraListFromCtrlUnit： 从控制中心获取监控点列表getCameraListFromRegion： 从区域获取监控点列表以上各个接口的参数说明参考SDKdemo中相关接口注释。流程如下： 首先获取根目录下的资源信息

4、，根目录也就是控制中心，所以需要调用如下接口控制中心如图3-2所示图3-2 获取根目录下的资源信息1. getControlUnitList2. getRegionListFromCtrlUnit3. getCameraListFromCtrlUnit以上接口调用完成后，展示的数据是根目录下所有的控制中心、区域和监控点。 当需要获取根目录下控制中心下的数据时，同样需要调用以上3个接口。 注：只要是获取控制中心下的数据，都需要调用以上3个接口。 当需要获取区域下数据时，需要调用如下接口，区域展示如图3-3所示：图3-3 获取控制中心下资源1. getRegionListFromRegion2.

5、getCameraListFromRegion以上接口调用完成后，展示出该区域下所有的区域和监控点 注：只要是获取区域下的数据，都需要调用以上接口。 客户可以根据实际情况将资源列表做成树形结构或者是目前我们手机客户端3.0版本展示的方式(如果层次过深，建议采用我们手机客户端的展示方式)。(3) 获取设备信息 3.0SDK可以通过平台获取设备信息： getDeviceInfo 调用该接口需要平台地址，登录成功的会话ID(登录成功接口中获取)、监控点ID(资源获取到的监控点对象的一个属性ID)、设备ID(资源获取到的监控点对象的一个属性ID)，、返回设备信息的对象(该对象是一个类似指针形式的对象)

6、。设备信息包含以下内容设备名称、设备编号、设备IP、设备端口、登录设备的用户名(这个是登录设备的用户名，并不是登录平台的用户名)、登录设备的密码(这个是登录设备的密码，并不是登录平台的密码，和登录设备用户名对应)、设备类型、设备供应商等。(4) 获取播放地址 3.0SDK获取播放地址是通过以下接口实现的 getRealPlayURL 调用该接口需要平台地址、登录成功的会话ID(登录成功接口中获取)、监控点ID(资源获取到的监控点对象的一个属性ID)、码流类型、返回播放地址的对象(该对象是一个类似指针形式的对象)。 对于码流类型，如果传入0，在返回的播放地址对象中url1表示主码流，url2表示

7、MAG；如果传入1，在返回的播放地址对象中url1表示子码流，url2表示MAG。开发者可以根据需要选择对象的码流(清晰度以主码流最为清晰，流畅度以MAG最为流畅)。 (5) 云台接口 云台接口采用的是UDP协议，只负责发送，接口如下sendStartPTZCmd 调用该接口需要的参数有：云台服务器地址(可以从监控点对象中获取，不需要修改)、云台服务器端口(可以从监控点对象中获取，不需要修改)、登录成功后的会话ID、监控点ID、云台命令(int)、速度。 以上参数的具体说明和使用可以参考SDKDemo中接口说明 常用云台命令介绍如下： 1-云台转上 2-云台转下 3-云台转左 4-云台转右11

8、-云台左上 12-云台右上 13-云台左下 14-云台右下7-镜头拉近8-镜头拉远9-镜头近焦10-镜头远焦(6)远程回放查询接口 远程回放时需要从存储介质中查询回放路径，接口如下queryCameraRecord 需要的参数有平台地址、登录成功后返回的会话ID、监控点ID、录像类型、录像的存储介质、查询录像的开始时间、查询录像的结束时间、查询录像返回的对象 其中开始时间和结束时间格林威治时间，也就是从1970年 1 月 1 日的 00:00:00.000开始的时间，精确到毫秒。注：在使用该接口时，请先了解下格林威治时间和Calendar的使用方法，确保传入的时间是需要查询的时间。 存储介质类

9、型： 0-IPSAN 1-设备录像 2-PCNVR 3-ENVR 4-CISCO5-DSNVR 7-CVR 目前我们只支持单存储介质查询，开发者可以根据需求进行遍历，实现多项查询。(7)获取的监控点主要作用如下图所示：图3-4 监控点录像查询、实时预览、云台控制操作流程常见错误及排查方式N类错误排除方式N122、N123、N124、N1251.请检查您手机的网络；2.请确认服务器是否在线。N124、N140、N141、N1421.请向平台确认该平台是否与手机客户端完成对接。N1701.请检查流媒体服务器是否开启。N1711.请向平台管理员确认是否具有控制权限。R类错误排除方式R 11.重启客户

10、端；2.更换手机。R 3、R131.重启客户端。R 121.要求平台查询getDeviceInfo接口返回的设备名称密码是否为空。R 141.重启客户端；2.关闭一些别的正在运行的软件。R 171.要求平台查询getRealPlayURL接口返回的Rtsp地址是否正确。R 181.手机所处的网络是否可以连通流媒体 ，检查流媒体的网络是否通；2.请进入“更多”页面，检查通讯线路是否选择正确。R 103、R 104、R 202、R203、R 302、R 303、R 402、R 403、R 502、R 503、R 602、R 603、R 702、R 703、R 802、R 8031.网络不好引起，换

11、个时间请求或者换个网络环境。R 101、R 105、R 106、R 204、R 205、R 304、R 305、R 404、R 405、R 504、R 505、R 604、R 605、R 704、R 705、R 804、R 8051流媒体回复信令错误，需要在服务器抓包判断。R 903、R 1001流媒体取流端口不通1.请检查udp端口是否映射；2.关闭防火墙。R 1103流媒体取流端口1.请检查tcp端口是否映射；2.关闭防火墙。M7Uri解析错误运行常见错误表N类错误码及错误描述，主要与CMS进行交互N100输入参数错误N120创建url对象失败N121创建request对象失败N122ht

12、tp请求超时N123http请求异常N124http请求返回非200N125http请求返回空N140创建data doc对象失败N141获取root节点失败N142解析返回状态码和描述失败N160不存在数据N161URL请求时参数缺少或参数错误N162会话错误N163用户不存在N164密码错误N165设备不存在N166监控点不存在N167线路不存在N168控制中心不存在N169区域不存在N170流媒体没有被启用N171没有权限N172录像不存在N173用户被冻结N174用户已经登录N175没有支持N199未知错误N198平台需要提示的错误描述N200服务器异常R类错误码及错误描述，主要与流媒

13、体服务器相关R1HPR初始化失败R 2消息队列启动失败R 3RtspClient未初始化R 4协议不支持R 5回调参数为空R6创建Rtsp引擎失败R7分配Rtsp引擎数超过最大数（32）R8无效的引擎IDR9引擎不存在R10引擎为空R11开始时间为空R12设备名称或者密码为空R13错误的基础端口号R14内存分配失败R15引擎未初始化R16MAG、VTDU4.0不支持Rtp or TcpR17Rtsp地址错误R18连接流媒体服务器失败R19不在播放状态R101Describe重定向失败R102生成Describe信令失败R103发送Describe信令失败R104接受Describe信令失败R1

14、05Describe回复非200OKR106Describe解析失败R201生成Setup信令失败R202发送Setup信令失败R203接收Setup信令失败R204Setup回复非200OKR205解析Setup失败R301生成Play信令失败R302发送Play信令失败R303接收Play信令失败R304Play回复非200OKR401创建改变速率信令失败R402发送改变速率信令失败R403接收改变速率信令失败R404改变速率回复非200OKR501创建强制I帧信令失败R502发送强制I帧信令失败R503接收强制I帧信令失败R504强制I帧回复非200OKR601创建随机定位信令失败R602发送随机定位信令失败R603接收随机定位信令失败R604随机定位回复非200OKR701创建暂停信令失败R702发送暂停信令失败R703接收暂停信令失败R704暂停回复非200OKR705不在暂停状态R801创建恢复信令失败R802发送恢复信令失败R803接收恢复信令失败R804恢复回复