使用 API 文档查阅接口详情

更多 SDK 模块函数、参数类型、字段说明及返回值定义等，请您使用随发版包附带的SDK API Reference 离线文档进行查阅。

一、解压

第 1 步：解压压缩包

下载 SDK API文档并解压，解压后文件结构如下：

javadoc/                            ← 所有 HTML 文档在这里
    ├── index.html                      ← 文档首页（入口）
    ├── index-all.html                  ← 全量字母索引页
    ├── allclasses-index.html           ← 所有类索引
    ├── allpackages-index.html          ← 所有包索引
    ├── overview-summary.html           ← 包概览页
    ├── overview-tree.html              ← 类继承树
    ├── deprecated-list.html            ← 已废弃 API 列表
    ├── help-doc.html                   ← 文档帮助说明
    ├── stylesheet.css                  ← 样式文件
    ├── script.js / search.js           ← 搜索脚本
    ├── legal/                          ← 法律声明
    ├── resources/                      ← 静态资源（图标等）
    ├── script-dir/                     ← jQuery 等第三方脚本
    └── com/
        └── dji/
            └── flighthubsdk/
                ├── FlightHubSDK.html           ← SDK 主入口类
                ├── FlightHubCallback.*.html     ← 所有回调接口
                ├── bean/                        ← 数据模型与参数类型
                ├── core/                        ← SDK 核心业务类
                └── value/                       ← 枚举与常量定义

第 2 步：打开文档首页

进入解压后的文件夹。

进入子目录：javadoc

找到 index.html 文件，双击用浏览器打开。

推荐使用浏览器：Chrome、Edge 均可，不需要网络连接。

打开后您会看到如下页面：

Packages
──────────────────────────────────────────────────────
Package                              Description
com.dji.flighthubsdk                主入口包（FlightHubSDK）及所有回调接口
com.dji.flighthubsdk.bean           数据模型与参数类型
com.dji.flighthubsdk.core           SDK 核心运行时（Drone、Dock、Workspace 等）
com.dji.flighthubsdk.value          枚举与常量定义

二、文档整体结构说明

包名	内容	典型用途
`com.dji.flighthubsdk`	SDK 入口类 `FlightHubSDK`，所有回调接口 `FlightHubCallback.*`	SDK 初始化、注册回调
`com.dji.flighthubsdk.core`	核心业务类：`Drone`、`Dock`、`Workspace`、各功能 Module（KOC3 共 56 个类）	调用飞行控制、直播、任务等接口
`com.dji.flighthubsdk.bean`	所有数据 Bean（请求参数、返回结果、状态数据）	查看接口的入参和回调数据结构
`com.dji.flighthubsdk.value`	枚举类（错误码、模式码、相机参数、状态值等）	理解整型字段的含义

`com.dji.flighthubsdk.core` 核心类一览（KOC3）

类名	说明
`FlightHubSdkManager`	SDK 内部管理器（用户代码应通过 `FlightHubSDK` 调用）
`Drone`	无人机实例（KOC3 仅保留子模块 getter）
`Dock`	机场实例（KOC3 仅保留子模块 getter）
`BaseStation`	基站实例
`Relay`	中继器实例
`RemoteController`	遥控器实例
`Workspace`	工作空间（KOC3 仅保留子模块 getter）
`CameraControlModule`	相机控制（拍照/录像/云台/红外）
`FlightControlModule`	飞行控制（返航/急停/摇杆）
`DrcModule`	DRC 链路管理
`ControlAuthModule`	飞行控制权/载荷控制权
`FlightSettingsModule`	飞行参数设置
`TakeoffModule`	一键起飞
`DroneOsdModule`	飞机 OSD 状态数据监听
`DockOsdModule`	机场 OSD 状态数据监听
`DockControlModule`	机场控制（舱盖/充电/空调）
`DeviceStateModule`	在线状态监听
`DeviceHMSModule`	设备 HMS 健康管理监听
`DeviceManageModule`	工作空间设备管理
`FirmwareManageModule`	固件管理
`WaylineManageModule`	航线资产管理
`FlightTaskModule`	航线任务管理
`FlightTaskControlModule`	航线任务控制（暂停/恢复）
`FlightTaskRecordModule`	飞行任务记录
`FlyToPointModule`	指点飞行
`PoiModule`	POI 环绕飞行
`LiveModule`	直播流（拉流/SEI 订阅）
`LiveDeviceModule`	直播设备（可用范围/观众数）
`LiveRecordModule`	直播录制
`LiveSyncModule`	直播同步管理
`MediaServiceModule`	媒体文件管理
`SafetyServiceModule`	安全服务（飞行区域/离线地图）
`TerraBuildModule`	三维重建
`HMSModule`	历史 HMS 数据查询
`LogManagementModule`	日志管理
`DeviceDebugModule`	设备远程调试
`NetworkTestModule`	网络测速
`RtkCalibrationModule`	RTK 标定
`PsdkControlModule`	PSDK 控制（喊话器/探照灯/Widget）
`PsdkResourceModule`	PSDK 资源管理
`AIBoxModule`	AI Box 应用管理
`AiAlertModule`	AI 智能告警
`OnboardAiModule`	机载 AI 控制
`AIInsideManageModule`	机载 AI 算法管理
`ElementModule`	地图元素管理
`FlashLedModule`	频闪灯配置
`RelayControlModule`	中继器控制
`MaintenanceManagementModule`	维保管理
`CustomSEIModule`	自定义 SEI 编解码
`PullStreamModule`	WHEP 自定义拉流
`Stream`	流媒体实例
`JniLibraryLoader`	JNI 库加载器

`com.dji.flighthubsdk.value` 枚举类一览

枚举类	说明
`FlightHubSdkErrorCode`	SDK 错误码
`DroneModeCode`	飞机模式码
`DroneLinkState`	飞机链路状态
`OutOfControlAction`	失控行为
`TakeoffMode`	起飞模式
`Stage`	阶段状态
`CameraMode`	相机模式
`CameraAperture`	相机光圈
`CameraExposureMode`	相机曝光模式
`CameraExposureCompensation`	相机曝光补偿
`CameraFocusMode`	相机对焦模式
`CameraFocusState`	相机对焦状态
`CameraISO`	相机 ISO
`CameraLensType`	相机镜头类型
`CameraLaserMeasureState`	相机激光测距状态
`CameraShutterSpeed`	相机快门速度
`CameraPhotoState`	拍照状态
`RecordState`	录像状态
`PhotoFormat`	照片格式
`AIIdentifyMode`	AI 识别模式
`AIIdentifyScoreMode`	AI 识别评分模式
`SeiDataType`	SEI 数据类型
`IrGainMode`	红外增益模式
`NightSceneMode`	夜景模式
`SearchLightWorkMode`	探照灯工作模式
`MegaphoneWorkMode` / `MegaphonePlayMode`	喊话器工作/播放模式
`MegaphoneTTSLanguageType` / `MegaphoneTTSVoiceType`	TTS 语言/音色
`DockAirConditionerState`	机场空调状态
`DockCameraPosition`	机场摄像头位置
`DockCoverMode`	机场舱盖模式
`POITaskStatus`	POI 任务状态
`PanoramaRunningState`	全景运行状态
`PsdkType` / `PsdkSubType`	PSDK 设备类型
`PSDKMegaphoneSystemState`	PSDK 喊话器系统状态
`InFlightWaylineControlAction`	在飞航线控制动作
`VisualExplorationStage` / `VisualExplorationErrorCode`	视觉探索阶段/错误码

三、如何在 Index 页找到想要的接口

方法一：通过包列表逐级导航（推荐新手）

在首页 index.html 点击对应的包名链接，例如 com.dji.flighthubsdk.core。

进入包摘要页后，页面列出该包下的所有类和接口，点击目标类名。

进入类详情页，可以看到：

Constructor Summary（构造函数列表）

Method Summary（方法摘要列表）

Method Detail（每个方法的详细说明）

示例：查找飞机相机控制接口（KOC3 模块化路径）

首页 index.html
  → 点击 com.dji.flighthubsdk.core
  → 点击 CameraControlModule（Class）
  → 在 Method Summary 中找到 drcTakePhoto
  → 点击方法名跳转到 Method Detail 查看参数说明

方法二：使用全局搜索（推荐快速定位）

在任意页面顶部导航栏，点击 SEARCH 链接，或直接点击搜索框。

输入关键词，例如：

类名：Drone、Dock、CameraControlModule、DrcModule

方法名：drcTakePhoto、connectDrcLink、listenAircraftLocation

枚举值：DroneModeCode、FlightHubSdkErrorCode

搜索结果会按类型分类显示，点击结果直接跳转。

注意：搜索功能依赖 JavaScript，请确认浏览器未禁用 JavaScript。

方法三：使用全量字母索引（Index）

点击顶部导航栏的 Index 链接，进入 index-all.html。

页面按字母 A–Z 列出所有类、方法、字段、枚举值。

点击字母跳转到对应区域，找到目标后点击链接。

四、接口详情页面说明

进入某个类（如 CameraControlModule）后，页面结构如下：

Class CameraControlModule
├── 类说明（Class Description）          ← 类的功能简介
├── Constructor Summary                  ← 构造函数摘要
├── Method Summary（方法摘要列表）
│   ├── Modifier and Type  Method        Description
│   ├── void  drcTakePhoto(String, ResultCallbackWithError)  DRC 通道拍照
│   ├── void  drcStartRecord(String, ResultCallbackWithError)  DRC 通道开始录像
│   └── ...
└── Method Detail（方法详情）
    ├── drcTakePhoto
    │   ├── 描述：通过 DRC 链路控制相机拍照
    │   ├── Parameters:
    │   │   ├── payloadIndex - 负载索引（如 "99-0-0"）
    │   │   └── callback - 操作结果回调（ResultCallbackWithError）
    │   └── Returns: void
    └── ...

如何查看回调数据结构

许多方法的参数是回调接口，点击回调类名可以跳转到 com.dji.flighthubsdk 包下的对应接口页面，再点击其中引用的 Bean 类名跳转到 com.dji.flighthubsdk.bean 包查看数据字段说明。

示例链路（KOC3 模块化路径）：

DroneOsdModule.listenAircraftLocation(callback)
  → 点击 FlightHubCallback.AircraftLocationCallback
  → 查看 onResult(AircraftLocation aircraftLocation) 方法
  → 点击 AircraftLocation（Bean）
  → 查看 getLongitude()、getLatitude()、getHeight() 等字段含义

CameraControlModule.drcTakePhoto(payloadIndex, callback)
  → 点击 FlightHubCallback.ResultCallbackWithError
  → 查看 onResult(FlightHubError error) 方法
  → 点击 FlightHubError（Bean）
  → 查看 getErrorCode()、getMessage() 等字段

如何查看枚举值含义

方法返回或参数中出现整型字段时，可前往 com.dji.flighthubsdk.value 包查找对应枚举类。

示例：

AircraftModeCode.getModeCode() 返回整型
  → 去 com.dji.flighthubsdk.value → DroneModeCode
  → 找到 ROUTE_FLIGHT → 含义：航线飞行

五、常用接口快速导航表（KOC3）

业务场景	入口类/模块	所在包
SDK 初始化	`FlightHubSDK`	`com.dji.flighthubsdk`
所有回调接口	`FlightHubCallback.*`	`com.dji.flighthubsdk`
获取设备列表	`DeviceManageModule`	`com.dji.flighthubsdk.core`
无人机实例（模块入口）	`Drone`	`com.dji.flighthubsdk.core`
机场实例（模块入口）	`Dock`	`com.dji.flighthubsdk.core`
基站实例	`BaseStation`	`com.dji.flighthubsdk.core`
中继器实例	`Relay`	`com.dji.flighthubsdk.core`
相机控制（拍照/录像/云台）	`CameraControlModule`	`com.dji.flighthubsdk.core`
飞行控制（返航/急停）	`FlightControlModule`	`com.dji.flighthubsdk.core`
DRC 链路	`DrcModule`	`com.dji.flighthubsdk.core`
控制权管理	`ControlAuthModule`	`com.dji.flighthubsdk.core`
一键起飞	`TakeoffModule`	`com.dji.flighthubsdk.core`
飞机 OSD 数据	`DroneOsdModule`	`com.dji.flighthubsdk.core`
机场 OSD 数据	`DockOsdModule`	`com.dji.flighthubsdk.core`
机场控制操作	`DockControlModule`	`com.dji.flighthubsdk.core`
固件管理	`FirmwareManageModule`	`com.dji.flighthubsdk.core`
航线资产管理	`WaylineManageModule`	`com.dji.flighthubsdk.core`
航线任务管理	`FlightTaskModule`	`com.dji.flighthubsdk.core`
航线任务控制	`FlightTaskControlModule`	`com.dji.flighthubsdk.core`
飞行任务记录	`FlightTaskRecordModule`	`com.dji.flighthubsdk.core`
指点飞行	`FlyToPointModule`	`com.dji.flighthubsdk.core`
POI 环绕	`PoiModule`	`com.dji.flighthubsdk.core`
直播流	`LiveModule`	`com.dji.flighthubsdk.core`
直播设备	`LiveDeviceModule`	`com.dji.flighthubsdk.core`
直播录制	`LiveRecordModule`	`com.dji.flighthubsdk.core`
直播同步	`LiveSyncModule`	`com.dji.flighthubsdk.core`
媒体文件管理	`MediaServiceModule`	`com.dji.flighthubsdk.core`
安全服务（围栏）	`SafetyServiceModule`	`com.dji.flighthubsdk.core`
三维重建	`TerraBuildModule`	`com.dji.flighthubsdk.core`
HMS 历史查询	`HMSModule`	`com.dji.flighthubsdk.core`
设备 HMS 监听	`DeviceHMSModule`	`com.dji.flighthubsdk.core`
日志管理	`LogManagementModule`	`com.dji.flighthubsdk.core`
设备调试	`DeviceDebugModule`	`com.dji.flighthubsdk.core`
网络测速	`NetworkTestModule`	`com.dji.flighthubsdk.core`
RTK 标定	`RtkCalibrationModule`	`com.dji.flighthubsdk.core`
PSDK 控制	`PsdkControlModule`	`com.dji.flighthubsdk.core`
PSDK 资源	`PsdkResourceModule`	`com.dji.flighthubsdk.core`
AI Box	`AIBoxModule`	`com.dji.flighthubsdk.core`
AI 智能告警	`AiAlertModule`	`com.dji.flighthubsdk.core`
机载 AI 控制	`OnboardAiModule`	`com.dji.flighthubsdk.core`
机载 AI 管理	`AIInsideManageModule`	`com.dji.flighthubsdk.core`
地图元素	`ElementModule`	`com.dji.flighthubsdk.core`
频闪灯	`FlashLedModule`	`com.dji.flighthubsdk.core`
中继器控制	`RelayControlModule`	`com.dji.flighthubsdk.core`
维保管理	`MaintenanceManagementModule`	`com.dji.flighthubsdk.core`
自定义 SEI	`CustomSEIModule`	`com.dji.flighthubsdk.core`
WHEP 拉流	`PullStreamModule`	`com.dji.flighthubsdk.core`
错误码含义	`FlightHubSdkErrorCode`	`com.dji.flighthubsdk.value`
飞机模式码	`DroneModeCode`	`com.dji.flighthubsdk.value`

六、常见问题

Q：打开页面后搜索框不可用？
A：搜索功能需要 JavaScript，请检查浏览器是否启用了 JavaScript。部分浏览器在打开本地 HTML 文件时会限制脚本执行，可尝试使用 Chrome 或 Edge，或将文件夹放到本地服务器（如 VS Code Live Server）上查看。

Q：点击链接跳转后页面显示空白？
A：请确认 javadoc 是完整解压的，所有文件夹和 HTML 文件都在同一目录结构下，不要只单独拷贝部分文件。

Q：文档中看到字段描述为空？
A：这是文档待完善的位置，可联系 SDK 维护方补充说明。

Q：如何知道某个 int 字段对应哪个枚举？
A：可以在 index-all.html 页面或搜索栏中搜索字段名（如 modeCode 或 DroneModeCode），找到对应的 Bean 类，再根据字段类型在 com.dji.flighthubsdk.value 包中查找对应枚举类。

Q：Stream.getPullStreamModule() 为什么调用报编译错误？
A：该方法需要传入 String streamId 参数，正确调用方式为 FlightHubSDK.getStream().getPullStreamModule(streamId)，无参调用会导致编译不通过。

Q：KOC3 中找不到 KOC2 的方法（如 drone.takePhoto）？
A：KOC3 采用全模块化架构，原来直接挂在 Drone/Dock/Workspace 上的方法已全部迁移到子模块。例如：

drone.takePhoto(...) → CameraControlModule.drcTakePhoto(...)

drone.connectDrcLink(...) → DrcModule.connectDrcLink(...)

workspace.getDeviceList(...) → DeviceManageModule.getDeviceList(...)

详细映射关系请参考《SDK 版本迁移指南》。

一、解压#

第 1 步：解压压缩包#

第 2 步：打开文档首页#

二、文档整体结构说明#

com.dji.flighthubsdk.core 核心类一览（KOC3）#

com.dji.flighthubsdk.value 枚举类一览#

三、如何在 Index 页找到想要的接口#

方法一：通过包列表逐级导航（推荐新手）#

方法二：使用全局搜索（推荐快速定位）#

方法三：使用全量字母索引（Index）#

四、接口详情页面说明#

如何查看回调数据结构#

如何查看枚举值含义#

五、常用接口快速导航表（KOC3）#

六、常见问题#