To reduce maintenance cost and improve readability, the API documentation is split by core/platform.
| Scope | Document | Description |
|---|---|---|
| Core Concepts + C++ | Core API | Workflow, core data structures, and C++ APIs |
| C / FFI | C API | Pure C interfaces and return buffer format |
| macOS (Swift) | macOS Swift API | Swift Package API and native artifact guide |
| iOS (Swift) | iOS Swift API | Swift Package API and native artifact guide |
| Android (Java/Kotlin) | Android API | JNI-based Java API |
| Flutter / Dart | Flutter API | Dart FFI wrapper API |
| Java 22 (FFM) | Java 22 API | FFM wrapper API and native loading guide |
| .NET / WinForms (C#) | .NET / WinForms API | P/Invoke wrapper API |
| WebAssembly (JS/TS) | WebAssembly API | Emscripten JS/TS API |
| HarmonyOS (ArkTS/NAPI) | HarmonyOS API | ArkTS bindings and usage entry |
| Build & CMake Options | Build Guide | Platform build commands and options |
- Read Core API first.
- Then choose your platform document based on integration target.
- Check Build Guide when preparing local/CI builds.