Skip to main content

Crate ohos_sys

Crate ohos_sys 

Source
Expand description

Ohos-sys

This crate provides Raw FFI bindings to the native API of OpenHarmonyOS (target_env = "ohos"). Each module corresponds to one OpenHarmony API feature, and is gated behind a cargo feature. If you are an application developer, you probably do not want to use this crate directly, and instead want to use a higher-level API built on top of this crate.

Note: There are currently still quite a few missing bindings, which will slowly be added.

§Feature flags

  • abilitykit — Enables bindings to the AbilitKit. Re-exports the ohos-abilitykit-sys library.
  • accesstoken — Enables bindings to the AbilityAccessControl (AccessToken) NDK. Re-exports ohos-accesstoken-sys.
  • arkui — Enables bindings to the native ArkUI module. Re-exports the arkui-sys library.
  • asset-store — Enables bindings to the AssetStoreKit (Asset NDK). Re-exports ohos-asset-store-sys.
  • basic-services-kit — Enables bindings to BasicServicesKit. Re-exports ohos-basic-services-kit-sys. Use the sub-API features (basic-services-kit-commonevent, …) to select individual NDKs within the kit.
  • basic-services-kit-commonevent — Enables the CommonEvent NDK from BasicServicesKit.
  • basic-services-kit-battery-info — Enables the BatteryInfo NDK from BasicServicesKit. Requires API-level 13.
  • basic-services-kit-print — Enables the Print NDK from BasicServicesKit.
  • basic-services-kit-scan — Enables the Scan NDK from BasicServicesKit.
  • basic-services-kit-os-account — Enables the OS Account NDK from BasicServicesKit.
  • basic-services-kit-time-service — Enables the Time Service NDK from BasicServicesKit.
  • crypto — Enables bindings to the CryptoArchitectureKit. Re-exports ohos-crypto-sys.
  • huks — Enables bindings to the Universal Keystore Kit (HUKS). Re-exports ohos-huks-sys.
  • deviceinfo — Enables bindings to deviceinfo.h. Re-exports ohos-deviceinfo-sys
  • drawing — Enables bindings to native_drawing. Re-exports ohos-drawing-sys.
  • hilog — Enables bindings to hilog
  • hitrace — Enables bindings to hitrace
  • inputmethod — Enables bindings to inputmethod from the IME-Kit. Empty if API-level < 12.
  • ipckit — Enables bindings to the IPCKit framework.
  • locationkit — Enables bindings to the LocationKit framework.
  • netmanager — Enables bindings to the NetworkKit netmanager framework.
  • net_ssl — Enables bindings to the NetworkKit net_ssl framework.
  • netstack — Enables bindings to the NetworkKit netstack framework.
  • image-kit — Bindings to the Image Kit
  • media — Bindings to the Media framework (Player / Recorder / Transcoder, AVCodec, demuxer / muxer, screen capture, low-power AV sinks). Re-exports ohos-media-sys.
  • video-processing-engine — Bindings to the VideoProcessingEngine subsystem (GPU-accelerated colour space conversion, HDR metadata, scaling). Re-exports ohos-video-processing-engine-sys. Use video-processing-engine-video-processing / video-processing-engine-image-processing to select individual modules.
  • multimodal-input — Bindings to the Multimodal Input kit.
  • ohaudio — Enables bindings to the OHAudio module.
  • web — Enables bindings to the Web module.
  • napi — Enables bindings to napi
  • native_buffer — Enables bindings to native_buffer
  • native_image — Enables bindings to native_image
  • native_window — Enables bindings to native_window
  • pasteboard — Enables to the ohos pasteboard (clipboard)
  • qos — Enables bindings to the QoS thread scheduling APIs (and at api-20+ the Gewu on-device LLM inference APIs that share libqos.so).
  • rawfile — Enables bindings to rawfile
  • rdb — Enables bindings to the relational database (RDB)
  • sensors — Enables bindings to the sensors module.
  • udmf — Enables bindings to the Unified Data Management Framework (UDMF)
  • vsync — Enables bindings to native_vsync
  • xcomponent — Enables bindings to native_xcomponent
  • window_manager — Enables bindings to window_manager
  • all-components — Enables all components listed above. Orthogonal to api-XX features.

§OpenHarmony API level

This crate by default exposes bindings for API-level 10. Optionally enable one of the api-* features to get access to bindings for newer OpenHarmony versions.

  • api-10 (enabled by default) — No effect. API-10 bindings can’t be deselected. The feature exists for internal purposes.
  • api-11 — Enables bindings for OpenHarmony API-level 11
  • api-12 — Enables bindings for OpenHarmony API-level 12
  • api-13 — Enables bindings for OpenHarmony API-level 13
  • api-14 — Enables bindings for OpenHarmony API-level 14
  • api-15 — Enables bindings for OpenHarmony API-level 15
  • api-16 — Enables bindings for OpenHarmony API-level 16.
  • api-17 — Enables bindings for OpenHarmony API-level 17.
  • api-18 — Enables bindings for OpenHarmony API-level 18 (5.1.0).
  • api-19 — Enables bindings for OpenHarmony API-level 19
  • api-20 — Enables bindings for OpenHarmony API-level 20
  • api-21 — Enables bindings for OpenHarmony API-level 21
  • api-22 — Enables bindings for OpenHarmony API-level 22
  • api-23 — Enables bindings for OpenHarmony API-level 23

§Features of dependencies

Re-exports features of individual component crates of ohos-sys. In general, it is recommended to depend on the individual component crates

§Internal features

  • document-features — Document available features when building the documentation

Re-exports§

pub use arkui_sys as arkui;arkui
pub use ohos_asset_store_sys as asset_store;asset-store
pub use ohos_basic_services_kit_sys as basic_services_kit;basic-services-kit
pub use ohos_crypto_sys as crypto;crypto
pub use ohos_deviceinfo_sys as deviceinfo;deviceinfo
pub use ohos_drawing_sys as drawing;drawing
pub use hilog_sys as hilog;hilog
pub use ohos_huks_sys as huks;huks
pub use hitrace_sys as hitrace;hitrace
pub use ohos_ime_sys as inputmethod;inputmethod
pub use ohaudio_sys as ohaudio;ohaudio
pub use arkweb_sys as web;web
pub use ohos_ipckit_sys as ipckit;ipckit
pub use ohos_locationkit_sys as locationkit;locationkit
pub use ohos_netmanager_sys as netmanager;netmanager
pub use ohos_net_ssl_sys as net_ssl;net_ssl
pub use ohos_netstack_sys as netstack;netstack
pub use ohos_input_sys as multimodal_input;multimodal-input
pub use ohos_abilitykit_sys as abilitykit;abilitykit
pub use ohos_pasteboard_sys as pasteboard;pasteboard
pub use ohos_rawfile_sys as rawfile;rawfile
pub use ohos_rdb_sys as rdb;rdb
pub use ohos_sensors_sys as sensors;sensors
pub use udmf_sys as udmf;udmf
pub use ohos_vsync_sys as vsync;vsync
pub use xcomponent_sys as xcomponent;xcomponent
pub use ohos_window_manager_sys as window_manager;window_manager

Modules§

multimedia
napinapi
native_buffernative_buffer
Native Buffer bindings
native_imagenative_image
Bindings to native_image
native_windownative_window
Native Window bindings
syscap
Bindings to check a devices system capabilites at runtime