API coverage

Find examples by feature and API. Start with the platform guide to install and initialize the SDK, then choose your API in each feature guide's code tabs.

The examples use InspireFace 1.2.4, InspireCV 1.0.2, Android Java SDK 1.2.0, and HarmonyOS ArkTS SDK 1.2.4. Objective-C and Swift use the Apple frameworks built from the 1.2.4 source revision. The table lists the operations available through each interface.

Feature examples by API

“Example” links to a guide with code for that API. “Source API” needs the newer Java source classes and a matching JNI build. A dash means that the named high-level wrapper does not expose that operation in the version above.

Feature	C API	C++	Android	Python	HarmonyOS (ArkTS)	Objective-C	Swift
Launch / Session / release	Example	Example	Example	Example	Example	Example	Example
Detection / tracking	Example	Example	Example	Example	Example	Example	Example
Dense landmarks	Example	Example	Example	Example	Example	Example	Example
Five-point landmarks	Example	Example	—	Example	Example	Example	Example
Quality / mask / attributes	Example	Example	Example	Example	Example	Example	Example
Pose	Example	Example	Quality path	Example	Example	Example	Example
Expression	Example	Example	—	Example	Example	Example	Example
RGB liveness / actions	Example	Example	Example	Example	Example	Example	Example
Embedding / comparison	Example	Example	Example	Example	Example	Example	Example
FeatureHub	Example	Example	Example	Example	Example	Example	Example
Alignment crop	Example	Example	Example	—	Example	Example	Example
Aligned-image extraction	Example	Example	—	—	Example	Example	Example
Similarity display conversion	Example	Example	Example	Example	Example	Example	Example
Detection snapshots	Example	Value copy	Source API	Example	Example	Example	Example
Face capture	Example	Example	Source API	Example	Example	Example	Example

The Plus passive and flash demos combine mobile capture with service-side verification. Their guide covers Android capture, progress feedback and result handling.

The code tabs share the same API selector, so choosing Python, Android, HarmonyOS (ArkTS), Objective-C or Swift also selects it in other groups that contain the same option. The complete examples include full programs to copy from the page; snippets in feature guides state which session, image or model setup they expect.

Inputs, settings and deployment

Area	Entry points	Guide
SDK downloads and builds	Prebuilt packages, platform builds and Python native-library replacement	Get and build the SDK, Python packaging
Model loading and inspection	Launch, reload, resource-pack validation and metadata	Models and builds
Images and buffers	File/bitmap input, raw RGB/BGR/YUV, stream updates, strides and rotation	Image inputs
Session tuning	Detector level, minimum face size, confidence, preview size, intervals and smoothing	Tracking
Memory and threads	Borrowed buffers, owned results, session reuse and worker teardown	Architecture
C ABI	Handles, status codes and `HFSessionConfigV2`	C API
Android deployment	AAR, assets, Gradle/ABI, CameraX and JNI pairing	Android
Apple APIs	Objective-C errors, Swift types, scoped views and complete detection examples	Objective-C and Swift
iOS deployment	Device / simulator XCFrameworks, Xcode linkage, camera buffers and CoreML	iOS
macOS deployment	Intel / Apple Silicon frameworks, embedding, signing and native libraries	macOS
HarmonyOS	HAR, ArkTS, Node-API and worker ownership	HarmonyOS
ARM CPU	Image preprocessing, memory reuse and camera latency	ARM deployment
NVIDIA	TensorRT SDK, CUDA runtime and device selection	TensorRT
Rockchip	SoC model packs, toolchains, RK runtime and RGA	Rockchip, Python on Rockchip
Diagnostics	Version, error text, runtime diagnostics and resource counters	API recipes, Troubleshooting
Performance	Warm-up, timing boundaries, median/p95 and queue delay	Performance

For parameter types, overloads and additional settings, refer to the headers and wrapper shipped with your SDK version.

Image processing with InspireCV

InspireCV is a standalone C++ library. Its guide covers Image I/O and operations, float images, Task transforms and tensors, error handling, repeated-frame memory reuse and optional CUDA processing. Its PixelFormat, rotation and pipeline types are separate from InspireFace's C API and FrameProcess.

For the full public interface, see InspireFace C declarations, native C++ headers, Objective-C header, Swift overlay, Python wrapper, HarmonyOS ArkTS exports and InspireCV headers. Use the headers bundled with a release as the reference for its binary.

Integration notes

For Android capture and snapshots, update the Java classes and JNI library together to the version used in the guide.
Copying a C++ face-result vector retains its geometry and tokens. Keep the corresponding frame pixels as well if you will extract features later.
In ArkTS, release tracking snapshots with session.releaseFaceResult() and call close() on streams, bitmaps, capture sessions and sessions when finished. Keep each wrapper object on the worker that created it.
The standard HarmonyOS HAR runs MNN on CPU and accepts raw image buffers. Use HarmonyOS APIs to decode files and display images.
Objective-C and Swift wrap the native handles. ARC owns the wrapper object; borrowed face, feature and pixel pointers still have the native lifetime limits.
CoreML, TensorRT, RKNN, RGA and CUDA preprocessing require their matching SDK build and runtime. Follow the target platform's deployment guide.