《Android取流播放获取资源SDK使用说明书》由会员分享，可在线阅读，更多相关《Android取流播放获取资源SDK使用说明书（11页珍藏版）》请在金锄头文库上搜索。
1、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 进行二次开发。温馨的提醒您在开 发前请您对整个说明文档进行仔细阅读，以便整体的了解开发流程。 二.SDK 内容说明 该文档主要针对手机客户端iVMS-5060 取流播放SDK 进行说
2、明， 文档介绍区分手机客 户端 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.
3、0 版本 的 SDK， 如果该平台支持手机客户端iVMS-5060 V3.0 系列版本，则需要使用3.0版本的 SDK 。 具体平台支持哪个版本的手机客户端，需要咨询平台相关开发人员。 三. 3.0SDK使用说明 系统框架图如图3-1 所示： 中心管理服务 流媒体服务 云台控制服务 海康平台 手机客户端 V3.0 A B C 图 3-1 3.0 手机客户端与平台系统架构图 (1)登录流程 : 首先要获取线路也就是调用getLineList 接口 其次调用登录接口login 接口，该接口中会用到getLineList 接口中返回的线路(具体参考 SDKdemo 中相关接口注释) (2)获取资源流
4、程： 获取资源流程，用到的接口有5 个 getControlUnitList ：获取控制中心的列表 getRegionListFromCtrlUnit ： 从控制中心中获取区域列表 getRegionListFromRegion ：从区域获取区域列表 getCameraListFromCtrlUnit ： 从控制中心获取监控点列表 getCameraListFromRegion ：从区域获取监控点列表 以上各个接口的参数说明参考SDKdemo 中相关接口注释。 流程如下： 首先获取根目录下的资源信息，根目录也就是控制中心，所以需要调用如下接口 控制中心如图3-2 所示 图 3-2 获取根目录下
5、的资源信息 1.getControlUnitList 2.getRegionListFromCtrlUnit 3.getCameraListFromCtrlUnit 以上接口调用完成后，展示的数据是根目录下所有的控制中心、区域和监控点。 当需要获取根目录下控制中心下的数据时，同样需要调用以上3 个接口。 注：只要是获取控制中心下的数据，都需要调用以上3 个接口。 当需要获取区域下数据时，需要调用如下接口，区域展示如图3-3 所示： 图 3-3 获取控制中心下资源 1.getRegionListFromRegion 2.getCameraListFromRegion 以上接口调用完成后，展示出该
6、区域下所有的区域和监控点 注：只要是获取区域下的数据，都需要调用以上接口。 客户可以根据实际情况将资源列表做成树形结构或者是目前我们手机客户端3.0版本展 示的方式 (如果层次过深，建议采用我们手机客户端的展示方式)。 (3) 获取设备信息 3.0SDK 可以通过平台获取设备信息： getDeviceInfo 调用该接口需要平台地址，登录成功的会话ID( 登录成功接口中获取)、监控点 ID( 资源 获取到的监控点对象的一个属性ID) 、设备 ID( 资源获取到的监控点对象的一个属性ID) ， 、 返回设备信息的对象(该对象是一个类似指针形式的对象)。 设备信息包含以下内容设备名称、设备编号、
7、设备 IP、设备端口、 登录设备的用户名(这 个是登录设备的用户名，并不是登录平台的用户名)、登录设备的密码(这个是登录设备的密 码，并不是登录平台的密码，和登录设备用户名对应)、设备类型、设备供应商等。 (4) 获取播放地址 3.0SDK 获取播放地址是通过以下接口实现的 getRealPlayURL 调用该接口需要平台地址、登录成功的会话ID( 登录成功接口中获取)、监控点 ID( 资源 获取到的监控点对象的一个属性ID) 、码流类型、 返回播放地址的对象(该对象是一个类似指 针形式的对象 )。 对于码流类型， 如果传入0， 在返回的播放地址对象中url1 表示主码流， url2 表示 M
8、AG ； 如果传入1，在返回的播放地址对象中url1 表示子码流，url2 表示 MAG 。开发者可以根据 需要选择对象的码流(清晰度以主码流最为清晰，流畅度以MAG 最为流畅 )。 (5) 云台接口 云台接口采用的是UDP 协议，只负责发送，接口如下 sendStartPTZCmd 调用该接口需要的参数有：云台服务器地址(可以从监控点对象中获取，不需要修改)、 云台服务器端口(可以从监控点对象中获取，不需要修改)、登录成功后的会话ID、监控点 ID、云台命令 (int) 、速度。 以上参数的具体说明和使用可以参考SDKDemo 中接口说明 常用云台命令介绍如下： 1-云台转上 2-云台转下
9、3-云台转左 4-云台转右 11-云台左上 12-云台右上 13-云台左下 14-云台右下 7-镜头拉近 8-镜头拉远 9-镜头近焦 10-镜头远焦 (6)远程回放查询接口 远程回放时需要从存储介质中查询回放路径，接口如下 queryCameraRecord 需要的参数有平台地址、登录成功后返回的会话ID、监控点ID、录像类型、录像的存 储介质、查询录像的开始时间、查询录像的结束时间、查询录像返回的对象 其中开始时间和结束时间格林威治时间，也就是从1970 年 1 月 1 日的00:00:00.000 开始的时间，精确到毫秒。 注：在使用该接口时，请先了解下格林威治时间和Calendar 的使
10、用方法，确保传入的时间是需要查询 的时间。 存储介质类型： 0-IPSAN 1-设备录像 2-PCNVR 3-ENVR 4-CISCO 5-DSNVR 7-CVR 目前我们只支持单存储介质查询，开发者可以根据需求进行遍历，实现多项查询。 (7)获取的监控点主要作用如下图所示： 图 3-4 监控点录像查询、实时预览、云台控制操作流程 常见错误及排查方式 N 类错误排除方式 N122、 N123、N124、 N125 1.请检查您手机的网络； 2.请确认服务器是否在线。 N124、 N140、N141、 N142 1.请向平台确认该平台是否与手机客户端完成对接。 N170 1.请检查流媒体服务器是
11、否开启。 N171 1.请向平台管理员确认是否具有控制权限。 R 类错误排除方式 R 1 1.重启客户端； 2.更换手机。 R 3、R13 1.重启客户端。 R 12 1.要求平台查询getDeviceInfo 接口返回的设备名称密码是否为空。 R 14 1.重启客户端； 2.关闭一些别的正在运行的软件。 R 17 1.要求平台查询getRealPlayURL 接口返回的Rtsp 地址是否正确。 R 18 1.手机所处的网络是否可以连通流媒体，检查流媒体的网络是否通； 2.请进入“更多”页面，检查通讯线路是否选择正确。 R 103、 R 104、 R 202、R203、R 302、 R 303
12、、 R 402、 R 403、R 502、R 503、 R 602、 R 603、 R 702、R 703、R 802、 R 803 1.网络不好引起，换个时间请求或者换个网络环境。 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 805 1 流媒体回复信令错误，需要在服务器抓包判断。 R 903、R 1001 流媒体取流端口不通 1.请检查 udp 端口是否映射； 2.关闭防火墙。 R 1103 流媒体取流端口 1.请检查 tc
13、p 端口是否映射； 2.关闭防火墙。 M7 Uri 解析错误 运行常见错误表 N 类错误码及错误描述，主要与CMS 进行交互 N100 输入参数错误 N120 创建 url 对象失败 N121 创建 request 对象失败 N122 http 请求超时 N123 http 请求异常 N124 http 请求返回非200 N125 http 请求返回空 N140 创建 data doc 对象失败 N141 获取 root 节点失败 N142 解析返回状态码和描述失败 N160 不存在数据 N161 URL 请求时参数缺少或参数错误 N162 会话错误 N163 用户不存在 N164 密码错误
14、N165 设备不存在 N166 监控点不存在 N167 线路不存在 N168 控制中心不存在 N169 区域不存在 N170 流媒体没有被启用 N171 没有权限 N172 录像不存在 N173 用户被冻结 N174 用户已经登录 N175 没有支持 N199 未知错误 N198 平台需要提示的错误描述 N200 服务器异常 R 类错误码及错误描述，主要与流媒体服务器相关 R 1 HPR 初始化失败 R 2 消息队列启动失败 R 3 RtspClient 未初始化 R 4 协议不支持 R 5 回调参数为空 R6 创建 Rtsp 引擎失败 R7 分配 Rtsp 引擎数超过最大数（32） R8 无
15、效的引擎ID R9 引擎不存在 R10 引擎为空 R11 开始时间为空 R12 设备名称或者密码为空 R13 错误的基础端口号 R14 内存分配失败 R15 引擎未初始化 R16 MAG 、VTDU4.0 不支持 Rtp or Tcp R17 Rtsp 地址错误 R18 连接流媒体服务器失败 R19 不在播放状态 R101 Describe 重定向失败 R102 生成 Describe 信令失败 R103 发送 Describe 信令失败 R104 接受 Describe 信令失败 R105 Describe 回复非 200OK R106 Describe 解析失败 R201 生成 Setup
16、信令失败 R202 发送 Setup信令失败 R203 接收 Setup信令失败 R204 Setup 回复非 200OK R205 解析 Setup失败 R301 生成 Play 信令失败 R302 发送 Play 信令失败 R303 接收 Play 信令失败 R304 Play 回复非 200OK R401 创建改变速率信令失败 R402 发送改变速率信令失败 R403 接收改变速率信令失败 R404 改变速率回复非200OK R501 创建强制 I 帧信令失败 R502 发送强制 I 帧信令失败 R503 接收强制 I 帧信令失败 R504 强制 I 帧回复非 200OK R601 创建随机定位信令失败 R602 发送随机定位信令失败 R603 接收随机定位信令失败 R604 随机定位回复非200OK R701 创建暂停信令失败 R702 发送暂停信令失败 R703 接收暂停信令失败 R704 暂停回复非200OK R705 不在暂停状态 R801 创建恢复信令失败 R802 发送恢复信令失败 R803 接收恢复信令失败 R804 恢复回复非200OK R901 创建 RtpU
