audionimbus-sys

Rust bindings to the Steam Audio library. This crate is not meant to be used directly; most users should use audionimbus, a safe wrapper built on top of audionimbus-sys.

Overview

audionimbus-sys exposes raw bindings to the Steam Audio C library. It is inherently unsafe, as it interfaces with external C code; for a safe API, refer to audionimbus.

audionimbus-sys can also integrate with FMOD studio and Wwise.

Version compatibility

audionimbus-sys mirrors the version of Steam Audio.

Installation

Before installation, make sure that Clang 9.0 or later is installed on your system.

audionimbus-sys requires linking against the Steam Audio library during compilation.

To do so, download steamaudio_4.6.1.zip from the release page.

Locate the relevant library for your target platform (SDKROOT refers to the directory in which you extracted the zip file):

Ensure the library is placed in a location listed in the dynamic library search paths (e.g., /usr/local/lib).

Finally, add audionimbus-sys to your Cargo.toml:

[dependencies]
audionimbus-sys = "4.6.2-fmodwwise.2"

FMOD Studio Integration

audionimbus-sys can be used to add spatial audio to an FMOD Studio project.

It requires linking against both the Steam Audio library and the FMOD integration library during compilation:

1. Download steamaudio_fmod_4.6.1.zip from the release page.

2. Locate the two relevant libraries for your target platform (SDKROOT refers to the directory in which you extracted the zip file):

3. Ensure the libraries are placed in a location listed in the dynamic library search paths (e.g., /usr/local/lib).

4. Finally, add audionimbus-sys with the fmod feature enabled to your Cargo.toml:

[dependencies]
audionimbus-sys = { version = "4.6.2-fmodwwise.2", features = ["fmod"] }

Wwise Integration

audionimbus-sys can be used to add spatial audio to a Wwise project.

It requires linking against both the Steam Audio library and the Wwise integration library during compilation:

1. Download steamaudio_wwise_4.6.1.zip from the release page.

2. Locate the two relevant libraries for your target platform and place them in a location listed in dynamic library search paths (e.g., /usr/local/lib).

3. Set the WWISESDK environment variable to the path of the Wwise SDK installed on your system (e.g. export WWISESDK="/path/to/Audiokinetic/Wwise2024.1.3.8749/SDK").

4. Finally, add audionimbus-sys with the wwise feature enabled to your Cargo.toml:

[dependencies]
audionimbus-sys = { version = "4.6.2-fmodwwise.2", features = ["wwise"] }

Documentation

Documentation is available at docs.rs.

Since this crate strictly follows Steam Audio’s C API, you can also refer to the Steam Audio C API reference for additional details.

Note that because the Wwise integration depends on files that are local to your system, documentation for the wwise module is not available on docs.rs. However, it can be generated locally using cargo doc --open --features wwise.

License

audionimbus-sys is dual-licensed under the MIT License and the Apache-2.0 License. You may choose either license when using the software.