1. SDK版本迁移指南
上云 API 2 说明文档(KOC3)
  • 快速开始
  • 申请许可证
  • 联系我们
  • 软件下载
  • 使用上云 API 2 设备模拟器
  • 鉴权接入指南
  • 部署上云 API 2 应用运行与设备管控底座
    • 部署指南
    • 部署前准备
    • 开始部署
    • 能力扩展
  • 设备上云
    • 设备上云
    • 设备固件版本
  • 集成前端独立组件
    • 集成指南
    • 驾驶舱和设备小窗
    • 驾驶舱模块化配置
    • 设备管理组件
    • 航线组件
    • 直播大屏
    • 飞行记录
    • 集成参考
    • PaasJS 新增特性
  • SDK 文档
    • 基本介绍
      • SDK 简介
      • 功能特性
    • 快速入门
      • 准备工作
      • 使用流程
    • 接口调用
      • 接口调用时序图
    • SDK API 文档
      • 使用 API 文档查阅接口详情
    • SDK版本迁移指南
      • 迁移概述
      • 新增方法详情
      • API 变更详情
      • 迁移操作步骤
    • 功能集合
      • SDK初始化
      • SDK配置
      • DRC链路
      • 飞机状态监听
      • 飞向目标点
      • 飞行参数设置
      • 飞行记录导出
      • POI 环绕飞行
      • 一键起飞
      • 航线任务管理
      • 航线任务控制
      • 航线资产管理
      • 机场状态监听
      • 控制权管理
      • 机场控制
      • 飞行控制
      • AI Box 管理
      • AI 智能告警
      • 机载 AI 控制
      • 机载 AI 算法管理
      • PSDK 控制
      • PSDK 资源管理
      • RTK 标定
      • 安全服务
      • 固件管理
      • 媒体服务
      • 日志管理
      • 三维重建
      • 设备管理
      • 设备保修维护
      • 设备健康管理
      • 设备远程调试
      • 设备在线状态
      • 相机控制
      • 直播录制
      • 直播设备管理
      • 直播视频流
      • 直播同步
      • 中继器控制
      • 自定义 SEI
      • WHEP 自定义拉流
      • 网络测速
      • 地图元素管理
      • 频闪灯配置
  • 使用上云 API 2 AI Plugin
    • 上云 API 2 AI Plugin 使用指南
  • 使用上云 API 2 二次开发 Demo
    • 上云 API 2 二次开发 Demo 部署指南
    • 上云 API 2 二次开发 Demo - 无人机管理平台使用说明
  • 排障指南
    • 前端独立组件排障指南
    • SDK排障指南
  1. SDK版本迁移指南

迁移概述

如何使用本指南#

1.
编译报错后,在 API 变更详解 文档中搜索报错的方法名
2.
对照 KOC3 写法 列改造代码
3.
按模块分组查找,快速定位批量改造规则
4.
迁移完成后,按 迁移操作步骤 文档逐项检查
重要提示:
本指南基于用户层 API(FlightHubSDK.java、Drone.java、Dock.java、Workspace.java 等 core/ 类),不是 SWIG 生成的 I*.java 接口。用户代码中调用的方法是 drone.getCameraControlModule().drcTakePhoto(),而非底层包装方法。
门面与内部实现:FlightHubSDK 是面向用户的门面类(入口),FlightHubSdkManager 是内部实现类。用户代码应通过 FlightHubSDK 获取所有设备实例和管理能力,不要直接调用 FlightHubSdkManager。
覆盖范围:本指南覆盖 core/ 用户层 API 的方法搬迁、改名、废弃和 Bean 字段变化。不覆盖:SWIG 生成层(I*.java)、运行时行为变化、枚举值增删。

变更概览#

维度KOC2KOC3
core/ 类数2456(新增 32 个子模块)
Drone 方法数208(含 5 getter)21(全部 getter)
Dock 方法数89(含 2 getter)11(全部 getter)
Workspace 方法数64(含 10 getter)18(全部 getter)
FlightHubSDK 门面方法数1619
DeviceDebugModule 方法数6855
纯新增方法数—296
搬迁方法数—317

核心架构变化#

KOC2 采用扁平化架构:业务方法直接挂在 Drone、Dock、Workspace 上。
KOC3 采用模块化架构:Drone/Dock/Workspace 仅保留 get*Module() getter,所有业务方法搬迁到子模块。

破坏性变更分类#

分类数量说明
A. 模块化搬迁约 280 个方法名不变,drone.xxx() → drone.getXxxModule().xxx()
B. 模块化 + DRC 前缀约 40 个调用路径变了,且方法名加了 drc/Drc 前缀
C. 模块化 + 改名约 6 个AircraftHMS→DeviceHMS 等
D. 废弃约 40 个Available 监听方法 + 其他移除方法
E. DeviceDebugModule 拆分约 18 个网络测试/RTK标定/中继器控制拆到新模块,去掉 device_sn 参数
F. FlightHubSDK 门面补齐约 15 个FlightHubSdkManager.getStreamInstance() → FlightHubSDK.getStream(),移除 session 机制
G. Bean / 参数类字段变化3 个TakeoffParams 删 mediaFolderName、LiveRecordItem 字段改名、FlightHubSdkConfig 删 token

变更类型图例#

标签说明
模块化方法名不变,调用对象从 drone/dock/workspace 变为 getXxxModule()
模块化+DRC调用路径变化 + 方法名加 drc/Drc 前缀
模块化+改名调用路径变化 + 方法名有其他变化
废弃KOC2 有,KOC3 删除
签名变化参数列表变化(如去掉 device_sn)
门面切换FlightHubSdkManager → FlightHubSDK

未变化的模块#

以下模块在 KOC2 和 KOC3 之间无破坏性变化,旧代码无需修改即可直接使用。
模块说明注意事项
LiveModule直播流(启停/SEI 订阅)无变化,直接使用
LiveRecordModule直播录像启停接口方法无变化,但 LiveRecordItem Bean 字段大面积改名(见 API 变更详解 变更 10b)
PullStreamModuleWHEP 拉流无变化
CustomSEIModule自定义 SEI 编解码无变化
Stream流管理获取方式改名:getStreamInstance() → getStream()
HMSModule历史 HMS 数据查询无变化
DiagnosisManagementModule诊断管理无变化(暂未开放)
MaintenanceManagementModule维保管理(报修工单)无变化
FlightTaskModule航线任务管理新增 listenTaskTopoChanged、startRoaming 等,旧方法不变
TerraBuildModule三维重建新增 15 个方法,旧方法不变
LogManagementModule日志管理新增 listenDeviceFileUploadProgress,旧方法不变
MediaServiceModule媒体服务新增 getMediaFileDetailById、uploadGeoMediaFile,旧方法不变
SafetyServiceModule安全服务新增 listenDroneOfflineMapEnable,旧方法不变
PoiModulePOI 环绕新增 listenFlightPoiProgress,enter/exit/updateSpeed/getTask 不变
FlightTaskControlModule航线任务控制新增 listenWaylineTaskEvent(从 Dock 搬入),pause/resume 不变;删除 listenFlightTaskControlAvailable
上一页
使用 API 文档查阅接口详情
下一页
新增方法详情
Built with