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

Android SDK使用说明文档

目录

一.文档阅读说明 (3)

二.SDK内容说明 (3)

三. 3.0SDK使用说明 (3)

(1)登录流程: (4)

(2)获取资源流程： (4)

(3) 获取设备信息 (5)

(4) 获取播放地址 (6)

(6)远程回放查询接口 (6)

(7)获取的监控点主要作用如下图所示： (7)

四. 2.0 SDK使用说明 (10)

一.文档阅读说明

非常感谢您选购我们公司的产品，申请我们的SDK进行二次开发。温馨的提醒您在开发前请您对整个说明文档进行仔细阅读，以便整体的了解开发流程。

二.S DK内容说明

该文档主要针对手机客户端iVMS-5060取流播放SDK进行说明，文档介绍区分手机客户端2.0和3.0版本。2个版本的SDK区分如下：

以上是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 获取根目录下的资源信息

1.getControlUnitList

2.getRegionListFromCtrlUnit

3.getCameraListFromCtrlUnit

以上接口调用完成后，展示的数据是根目录下所有的控制中心、区域和监控点。

当需要获取根目录下控制中心下的数据时，同样需要调用以上3个接口。

注：只要是获取控制中心下的数据，都需要调用以上3个接口。

当需要获取区域下数据时，需要调用如下接口，区域展示如图3-3所示：

图3-3 获取控制中心下资源

1.getRegionListFromRegion

2.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表示子码流，url2表示MAG。开发者可以根据需要选择对象的码流(清晰度以主码流最为清晰，流畅度以MAG最为流畅)。

(5) 云台接口

云台接口采用的是UDP协议，只负责发送，接口如下

sendStartPTZCmd

调用该接口需要的参数有：云台服务器地址(可以从监控点对象中获取，不需要修改)、云台服务器端口(可以从监控点对象中获取，不需要修改)、登录成功后的会话ID、监控点ID、云台命令(int)、速度。

以上参数的具体说明和使用可以参考SDKDemo中接口说明

常用云台命令介绍如下：

1-云台转上

2-云台转下

3-云台转左

4-云台转右

11-云台左上

12-云台右上

13-云台左下

14-云台右下

7-镜头拉近

8-镜头拉远

9-镜头近焦

10-镜头远焦

(6)远程回放查询接口

远程回放时需要从存储介质中查询回放路径，接口如下

queryCameraRecord

需要的参数有平台地址、登录成功后返回的会话ID、监控点ID、录像类型、录像的存储介质、查询录像的开始时间、查询录像的结束时间、查询录像返回的对象

其中开始时间和结束时间格林威治时间，也就是从1970年1 月1 日的00:00:00.000开始的时间，精确到毫秒。

注：在使用该接口时，请先了解下格林威治时间和Calendar的使用方法，确保传入的时间是需要查询的时间。

存储介质类型：

0-IPSAN

1-设备录像

2-PCNVR

3-ENVR

4-CISCO

5-DSNVR

7-CVR

目前我们只支持单存储介质查询，开发者可以根据需求进行遍历，实现多项查询。(7)获取的监控点主要作用如下图所示：

图3-4 监控点录像查询、实时预览、云台控制操作流程

四. 2.0 SDK使用说明

如果开发人员使用的3.0的SDK，后面的内容可以不用看。

2.0手机客户端系统结构如图4-1所示：

图4-1 2.0手机客户端与平台系统架构图

2.0开发相对比较简单，没有资源获取的过程，资源的展示是通过WebView加载平台返回的URL实现的。

登录流程：

2.0登录过程其实是一个加载URL的过程，这个URL是通过平台地址、用户名、密码进行组合的，具体组合方式见2.0SDKDemo中getHttpUrl方法。开发者可以通过WebView 进行加载，后续工作都会在WebView中进行操作，直到跳入预览界面。

2.0SDK开发中，需要注意的是在什么时候跳入预览界面，开发者可以参考2.0SDKDemo 中WebActivity中verifyRtspUrl方法，通过判断加载的url是否包含"rtsp://"来进行跳转识别。所以基于2.0SDK开发，只需要在Demo中修改下平台地址、用户名、密码即可，如果开发者需要登录页面，只需要在点击登录按钮时，将平台地址、用户名、密码传递过来即可。

2.0的预览流程，相对较为简单，只有MAG取流方式，在进入预览界面时，只要获取到播放地址就可以点击播放按钮进行预览。WebActivity向预览界面跳转时会携带URL，以“rtsp://”开始的url就是预览地址。