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

Android SDK使用说明文档 目录 一. 文档阅读说明 3 二. SDK内容说明 3 三. 3.0SDK使用说明 4 (1)登录流程: 4 (2)获取资源流程： 4 (3) 获取设备信息 6 (4) 获取播放地址 6 (6)远程回放查询接口 7 (7)获取的监控点主要作用如下图所示： 8 四. 2.0 SDK使用说明 11 文档阅读说明 非常感谢您选购我们公司的产品，申请我们的SDK进行二次开发。温馨的提醒您在开发前请您对整个说明文档进行仔细阅读，以便整体的了解开发流程。 SDK内容说明 该文档主要针对手机客户端iVMS-5060取流播放SDK进行说明，文档介绍区分手机客户端2.0和3.0版本。2个版本的SDK区分如下： 功能 2.0SDK 3.0SDK 取流方式 支持MAG 支持MAG、VTDU(区分主子码流) 资源获取方式 通过WebView加载平台返回的URL(平台实现，手机客户端只需要实现webview相关内容) 通过VmsNetSDK.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接口，该接口中会用到getLineList接口中返回的线路(具体参考SDKdemo中相关接口注释) (2)获取资源流程： 获取资源流程，用到的接口有5个 getControlUnitList ：获取控制中心的列表 getRegionListFromCtrlUnit： 从控制中心中获取区域列表 getRegionListFromRegion： 从区域获取区域列表 getCameraListFromCtrlUnit： 从控制中心获取监控点列表 getCameraListFromRegion： 从区域获取监控点列表 以上各个接口的参数说明参考SDKdemo中相关接口注释。 流程如下： 首先获取根目录下的资源信息，根目录也就是控制中心，所以需要调用如下接口 控制中心如图3-2所示 图3-2 获取根目录下的资源信息 getControlUnitList getRegionListFromCtrlUnit getCameraListFromCtrlUnit 以上接口调用完成后，展示的数据是根目录下所有的控制中心、区域和监控点。 当需要获取根目录下控制中心下的数据时，同样需要调用以上3个接口。 注：只要是获取控制中心下的数据，都需要调用以上3个接口。 当需要获取区域下数据时，需要调用如下接口，区域展示如图3-3所示： 图3-3 获取控制中心下资源 getRegionListFromRegion getCameraListFromRegion 以上接口调用完成后，展示出该区域下所有的区域和监控点 注：只要是获取区域下的数据，都需要调用以上接口。 客户可以根据实际情况将资源列表做成树形结构或者是目前我们手机客户端3.0版本展示的方式(如果层次过深，建议采用我们手机客户端的展示方式)。 (3) 获取设备信息 3.0SDK可以通过平台获取设备信息： getDeviceInfo 调用该接口需要平台地址，登录成功的会话ID(登录成功接口中获取)、监控点ID(资源获取到的监控点对象的一个属性ID)、设备ID(资源获取到的监控点对象的一个属性ID)，、返回设备信息的对象(该对象是一个类似指针形式的对象)。 设备信息包含以下内容设备名称、设备编号、设备IP、设备端口、登录设备的用户名(这个是登录设备的用户名，并不是登录平台的用户名)、登录设备的密码(这个是登录设备的密码，并不是登录平台的密码，和登录设备用户名对应)、设备类型、设备供应商等。 (4) 获取播放地址 3.0SDK获取播放地址是通过以下接口实现的 getRealPlayURL 调用该接口需要平台地址、登录成功的会话ID(登录成功接口中获取)、监控点ID(资源获取到的监控点对象的一个属性ID)、码流类型、返回播放地址的对象(该对象是一个类似指针形式的对象)。 对于码流类型，如果传入0，在返回的播放地址对象中url1表示主码流，url2表示MAG；如果传入1，在返回的播放地址对象中url1表示子码流，url