1. 基本介绍
上云 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. 基本介绍

功能特性

AI 智能告警(AiAlertModule)⭐新增#

支持 AI 告警的设备维度设置与算法维度设置的查询与下发。
支持查询 AI 告警相关的飞行记录(getAiAlertFlights)和告警记录(getAiAlertRecords)。
获取方式:FlightHubSDK.getWorkspaceInstance().getAIAlertModule()

AI Box 应用管理(AIBoxModule)#

支持 AI Box 应用的安装、卸载、查询与管理,支持安装进度监听。
工作空间维度和无人机维度均可获取该模块,分别用于应用分发管理与单机应用状态查看。
获取方式:workspace.getAIBoxModule() 或 drone.getAIBoxModule()

机载 AI 算法管理(AIInsideManageModule)⭐新增#

支持查询所有机载 AI 模型列表,以及查询模型关联的设备列表和汇总信息。
支持机载 AI 算法的创建、算法文件上传和删除管理。
获取方式:workspace.getAIInsideManageModule()

相机控制(CameraControlModule)⭐新增#

支持拍照、录像、变焦、云台控制、全景拍摄、相机模式切换。
支持红外测温/增益、曝光/光圈/快门/ISO 设置、防抖/去雾/图像去噪、水印设置等。
KOC3 大幅扩展: 新增 77 个相机相关方法;所有通过 DRC 通道下发的控制方法统一以 drc 前缀命名(如 drcTakePhoto),便于与非 DRC 通道方法区分。
获取方式:drone.getCameraControlModule()(KOC2 中这些方法直接挂在 drone 上,KOC3 拆分为独立模块)

控制权管理(ControlAuthModule)⭐新增#

支持飞行控制权与载荷控制权的获取与释放,以及控制权状态监听。
获取方式:drone.getControlAuthModule()

自定义 SEI(CustomSEIModule)#

支持将目标检测框、多边形、文字叠加及自定义数据编码嵌入视频帧,并可解码还原。
获取方式:FlightHubSDK.getStream().getCustomSEIModule()

设备远程调试(DeviceDebugModule)#

支持远程开启/关闭设备调试模式,便于工程师进行远程日志抓取与问题排查。
提供设备重启、格式化、限高/限距/避障参数设置、地理围栏设置等远程运维能力。
支持手动换电、Dongle 电源开关、低功耗模式切换、SIM 卡槽及 eSIM 运营商切换(均支持进度监听)。
KOC3 变化: 获取路径由 Workspace 改为通过 Drone 或 Dock 实例获取(drone.getDeviceDebugModule() / dock.getDeviceDebugModule()),网络测速/RTK 标定/中继器控制已拆分为独立模块,不再属于本模块。

设备健康管理实时监听(DeviceHMSModule)⭐新增#

支持实时监听单台设备(无人机或机场)的 HMS 健康告警。
KOC3 变化: 实时告警监听方法名统一为 listenDeviceHMS(原 listenAircraftHMS/listenDockHMS 合并改名)。
获取方式:drone.getDeviceHMSModule() / dock.getDeviceHMSModule()

工作空间设备管理(DeviceManageModule)#

支持工作空间内设备列表分页查询、设备详情查询、设备改名与解绑操作。
支持监听工作空间设备变更事件。
获取方式:workspace.getDeviceManageModule()

设备在线状态(DeviceStateModule)⭐新增#

支持监听无人机、机场的在线/离线状态变化。
获取方式:drone.getDeviceStateModule() / dock.getDeviceStateModule()

机场控制(DockControlModule)⭐新增#

提供舱盖开关控制、充电状态控制、空调模式设置及补光灯控制等物理设备操控能力。
支持机场直播摄像头位置切换(舱内/舱外/辅助摄像头)。
获取方式:dock.getDockControlModule()

机场状态监听(DockOsdModule)⭐新增#

支持机场上下线、工作模式、网络状态、存储状态、电源状态、气象信息等多维度状态实时监听。
KOC3 新增: Dongle 信息监听、空调模式监听、备降点/相对备降点、自收敛坐标、静音模式、用户体验改善计划开关、推杆状态等大量新增监听项。
获取方式:dock.getDockOsdModule()

DRC 链路(DrcModule)⭐新增#

支持 DRC 链路的建立与断开、链路状态监听。
KOC3 新增: RTC 质量测试、延迟信息监听、设备心跳监听。
获取方式:drone.getDrcModule()

飞机状态监听(DroneOsdModule)⭐新增#

支持飞机位置、姿态、速度、电池信息、模式码、控制源、链路状态等全量 OSD 数据订阅。
支持负载列表、相机列表、云台姿态、避障状态、搜星状态等负载相关状态订阅。
KOC3 新增: 档位信息、Home 点距离、限制信息、累计飞行信息、激活时间、保养状态、夜航灯状态、存储信息、航迹 ID、合规信息、失控动作等大量新增监听项。
获取方式:drone.getDroneOsdModule()

地图元素管理(ElementModule)⭐新增#

支持地图元素的创建、更新、删除。
支持元素层级列表查询与元素可见性设置。
支持实时监听元素的创建、更新、删除事件。
获取方式:workspace.getElementModule()

固件管理(FirmwareManageModule)⭐新增#

提供固件状态查询、升级指令下发、升级进度跟踪、固件文件上传与发布/取消发布管理等固件全生命周期能力。
支持查询固件兼容性配置及指定机型最新固件发布说明。
KOC3 新增: 支持实时监听 OTA 升级进度。
获取方式:workspace.getFirmwareManageModule()

频闪灯配置(FlashLedModule)⭐新增#

支持频闪灯配置方案的列表查询、创建、更新和删除。
支持查询频闪灯当前状态信息。
获取方式:workspace.getFlashLedModule()

飞行控制(FlightControlModule)⭐新增#

支持返航、急停、摇杆控制。
KOC3 新增: 迫降、强制降落、悬停、开伞、失控动作设置、频闪灯联动等指令。
获取方式:drone.getFlightControlModule()

飞行参数设置(FlightSettingsModule)⭐新增#

支持限高、失控动作、任务高度、返航高度、空中传输模式等飞行参数的设置与查询。
获取方式:drone.getFlightSettingsModule()

航线任务控制(FlightTaskControlModule)#

支持对正在执行的航线任务进行暂停,无人机悬停原地等待。
支持从暂停位置恢复继续执行航线任务,实现任务的灵活中断与续飞。
KOC3 新增: 航线任务事件监听(listenWaylineTaskEvent,从 Dock 搬入)、指令任务事件监听(listenCommandTaskEvent)。
获取方式:drone.getFlightTaskControlModule() / dock.getFlightTaskControlModule()

航线任务管理(FlightTaskModule)#

提供飞行任务的创建、编辑、查询、删除与执行能力,支持批量更新任务状态。
支持按状态、设备、时间等条件分页查询任务列表,并提供智能推荐最优执行设备的能力。
支持任务冲突规避(TCAS)配置的获取与更新。
KOC3 新增: 漫游功能(startRoaming)、在飞任务拓扑查询、任务拓扑变更监听。
获取方式:workspace.getFlightTaskModule()

飞行任务记录(FlightTaskRecordModule)#

支持发起飞行记录导出请求,可指定时间范围与设备筛选条件。
提供导出进度查询接口,导出完成后可获取下载链接,用于飞行数据审计与合规管理。
获取方式:workspace.getFlightTaskRecordModule()

指点飞行(FlyToPointModule)#

支持向无人机下发飞向指定坐标点的指令,可设置目标高度与最大飞行速度。
支持取消任务,并提供飞行状态、路径规划的实时监听能力。
获取方式:drone.getFlyToPointModule()

历史健康管理数据查询(HMSModule)#

支持批量查询多台设备的历史健康告警记录,可按时间范围分页获取,涵盖无人机与机场的传感器异常、通信故障、电量告警等多类健康事件。
获取方式:workspace.getHMSModule()

直播设备管理(LiveDeviceModule)⭐新增#

支持批量查询指定设备的当前在线观众数量,可按流分组筛选。
支持直播可用范围(清晰度范围)监听。
KOC3 新增: 直播状态监听、直播容量监听。
获取方式:drone.getLiveDeviceModule() / dock.getLiveDeviceModule() / baseStation.getLiveDeviceModule()

直播视频流(LiveModule)#

支持无人机与机场实时视频直播,可切换不同镜头,动态调节直播画质。
支持订阅本地视频帧数据及 AI、AR、FOV、EIS 等多类附加 SEI 信息,满足本地分析需求。
获取方式:drone.getLiveStream(LiveInfo) / dock.getLiveStream(LiveInfo)(需传入直播信息参数)

直播录制(LiveRecordModule)#

支持对当前直播流进行服务端录制,可指定时区开始录制并随时停止。
支持查询历史录制记录,并实时监听录制状态(录制中/成功/失败/初始化中)。
KOC3 变化: 录制记录返回字段已更新(如 recordId→bid),详见《SDK 版本迁移指南》。
获取方式:drone.getLiveRecord(LiveInfo) / dock.getLiveRecord(LiveInfo)

直播同步(LiveSyncModule)⭐新增#

支持直播同步配置的创建、更新、删除与列表查询。
支持查询同步设备列表和同步汇总信息。
获取方式:workspace.getLiveSyncModule()

日志管理(LogManagementModule)#

支持按设备序列号和模块类型远程查询设备本地日志文件列表。
支持创建日志报告、上传日志附件,并提供日志报告列表查询、报告操作(取消/删除)管理能力。
KOC3 新增: 设备日志文件上传进度监听。
获取方式:workspace.getLogManagementModule()

设备保修维护(MaintenanceManagementModule)#

支持查询指定设备型号的保修配置信息,判断当前设备是否支持线上保修服务。
提供保修订单创建、订单详情查询及订单列表查询能力。
获取方式:workspace.getMaintenanceManagementModule()

媒体服务(MediaServiceModule)#

支持分页查询工作空间内设备媒体文件列表,可按设备、时间、文件类型等条件筛选。
支持批量删除媒体文件,提供签名下载地址获取及媒体文件回传通知监听能力。
支持获取对象存储 STS 临时凭证,客户端直接上传媒体文件(含地理媒体文件上传),避免通过服务器中转。
上传完成后需调用回调接口通知服务端注册文件,使文件在工作空间内可见。
KOC3 新增: 按 ID 查询媒体文件详情、上传地理媒体文件(uploadGeoMediaFile)。
获取方式:workspace.getMediaServiceModule()

网络测速(NetworkTestModule)⭐新增#

支持机场/基站的网络测速启动、停止、进度查询与进度监听。
KOC3 变化: 原属 KOC2 设备调试范畴,KOC3 独立成模块。
获取方式:dock.getNetworkTestModule() / baseStation.getNetworkTestModule()

机载 AI 控制(OnboardAiModule)⭐新增#

支持机载 AI 数据订阅、AI 识别开关/过滤条件/评分模式设置。
支持 AI 追焦控制、AI 告警启停及状态监听。
获取方式:drone.getOnboardAiModule()

POI 环绕飞行(PoiModule)#

支持控制无人机以指定半径、高度和速度绕兴趣点做圆周飞行,支持动态调整速度。
支持随时退出环绕模式,并提供任务执行状态的实时监听能力。
KOC3 新增: 实时监听 POI 飞行进度(listenFlightPoiProgress)。
获取方式:drone.getPoiModule()

PSDK 控制(PsdkControlModule)⭐新增#

支持探照灯亮度/工作模式调节,喊话器音频播放与 TTS 播报控制,Widget 控件值设置。
KOC3 大幅扩展: 新增喊话器播放进度监听、PSDK UI 资源监听等能力。
获取方式:drone.getPsdkControlModule()

PSDK 资源管理(PsdkResourceModule)⭐新增#

支持喊话器音频资源的增删改查与文件上传。
支持查询 PSDK Widget 资源列表。
KOC3 变化: 独立成工作空间级模块,与设备维度的 PsdkControlModule(喊话器/探照灯播放控制)区分职责。
获取方式:workspace.getPsdkResourceModule()

WHEP 自定义拉流(PullStreamModule)#

支持从指定地址(WHEP)拉取视频流,提供开始/停止拉流、视频帧数据订阅与取消订阅、拉流状态与错误回调、拉流信息查询能力。
获取方式:FlightHubSDK.getStream().getPullStreamModule(streamId)(注意:需传入 streamId 参数,不是无参调用)

中继器控制(RelayControlModule)⭐新增#

支持中继器 SSID、密码、搜索模式设置。
支持中继器广播隐藏开关、占用状态设置、断开连接、重启操作。
获取方式:relay.getRelayControlModule()

RTK 标定(RtkCalibrationModule)⭐新增#

支持设备端与中继站的 RTK 手动/网络模式标定,支持标定进度监听。
KOC3 变化: 原属 KOC2 设备调试范畴,KOC3 独立成模块,机场、基站、中继器均可获取。
获取方式:dock.getRtkCalibrationModule() / baseStation.getRtkCalibrationModule() / relay.getRtkCalibrationModule()

安全服务(SafetyServiceModule)#

提供自定义飞行区域管理能力,支持禁飞区、限飞区及允许飞行区的增删改查与设备同步,并可查询同步状态。
支持信号覆盖地图查询及离线地图生成与同步,保障弱网环境下的飞行安全。
支持解锁证书的查询、上传、切换、清除。
KOC3 新增: 无人机离线地图开关状态监听(listenDroneOfflineMapEnable)。
获取方式:workspace.getSafetyServiceModule()

一键起飞(TakeoffModule)⭐新增#

支持下发一键起飞指令,并监听起飞进度及任务事件。
KOC3 新增: 飞行模式变更监听。
获取方式:drone.getTakeoffModule()

三维重建(TerraBuildModule)#

支持 2D 正射、3D 实景、3DGS、激光雷达等多种类型的重建任务创建、重试、停止与删除。
支持配置重建质量等级、坐标系、输出格式及空三参数等选项,提供模型文件查询与下载能力。
支持全景拼接任务创建,可查询 SFM 结果及质量报告。
KOC3 新增: 模型状态变更监听、解压进度监听、模型重命名、模型在地图显示/隐藏、模型详情查询、LAS 坐标系设置等约 15 个新增方法。
获取方式:workspace.getTerraBuildModule()

航线资产管理(WaylineManageModule)⭐新增#

支持航线文件的查询、编辑、删除、复制、拼接、KMZ 导入、批量删除与批量下载。
KOC3 新增: 独立成模块,新增复制航线、拼接航线、批量导入 KMZ、获取航线编辑器临时凭证等方法,并支持监听航线导入事件。
获取方式:workspace.getWaylineManageModule()

附:非 *Module 后缀的核心入口类(补充说明)#

以下类不带 Module 后缀,属于设备/流实例入口,不在上方 javadoc 的 module 搜索结果里,但同样是 com.dji.flighthubsdk.core 包下的重要类,仅作补充说明:
类名说明
Drone无人机实例入口,仅保留 get*Module() getter
Dock机场实例入口,仅保留 get*Module() getter
Workspace工作空间实例入口,仅保留 get*Module() getter
BaseStation ⭐新增基站实例入口
Relay ⭐新增中继器实例入口
RemoteController ⭐新增遥控器实例入口
Stream流处理实例入口(getCustomSEIModule() / getPullStreamModule(streamId))
上一页
SDK 简介
下一页
准备工作
Built with