waapi-rs 0.2.0

A Rust client for Wwise Authoring API (WAAPI), supporting async and sync usage
Documentation

waapi-rs

English | 中文

A Rust client for the Wwise Authoring API (WAAPI), based on WAMP over WebSocket, supporting both async and sync usage.

Features

  • Async client WaapiClient: async connect, RPC calls, topic subscriptions; shareable across tasks
  • Sync client WaapiClientSync: internally manages a tokio runtime, blocking calls; ideal for scripts or non-async code
  • RPC calls: call(uri, args, options) to invoke WAAPI methods, returning Result<Option<Value>, Error> where Value is serde_json::Value
  • URI constants: waapi_rs::ak provides nested modules and constants matching WAAPI URI paths (e.g. ak::wwise::core::GET_INFO, ak::wwise::waapi::GET_TOPICS), avoiding hand-written strings
  • Topic subscriptions: subscribe(topic, options, callback) binds a callback |kwargs: Option<Value>| for receiving events; cancel via SubscriptionHandle / SubscriptionHandleSync; auto-cleaned on drop
  • Resource cleanup: connections and subscriptions auto-disconnect/cancel on Drop; explicit disconnect / unsubscribe also available

Prerequisites

  • Wwise: installed and running, with Authoring API enabled in the project (Project > User Preferences > Enable Wwise Authoring API)
  • Rust: 1.70+ recommended, with tokio and async support

Installation

Add the dependency to Cargo.toml:

[dependencies]

waapi-rs = "0.2"

tokio = { version = "1", features = ["full"] }

From a local path:

waapi-rs = { path = "../waapi-rs" }

Quick Example

Import waapi_rs::ak and write paths from ak:: (consistent with C++ WAAPI URI style). call returns Option<Value>:

use waapi_rs::{ak, WaapiClient};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = WaapiClient::connect().await?;
    let result = client.call(ak::wwise::core::GET_INFO, None, None).await?;
    if let Some(info) = result {
        let version = info.get("version").and_then(|v| v.get("displayName")).and_then(|v| v.as_str()).unwrap_or("Unknown");
        println!("Wwise Version: {}", version);
    }
    client.disconnect().await;
    Ok(())
}

URI Constants (uris)

Import with use waapi_rs::ak, then write paths from ak::, matching the WAAPI/C++ URI hierarchy (e.g. ak.wwise.core.getInfo → ak::wwise::core::GET_INFO):

  • ak::soundengine::* — runtime interfaces (e.g. POST_EVENT, SET_STATE)
  • ak::wwise::core::* — core interfaces (e.g. GET_INFO, OBJECT_GET) and topics (e.g. OBJECT_CREATED, PROJECT_LOADED)
  • ak::wwise::debug::*, ak::wwise::ui::*, ak::wwise::waapi::* — debug, UI, WAAPI meta-info

Examples: client.call(ak::wwise::core::GET_INFO, None, None), client.call(ak::wwise::waapi::GET_TOPICS, None, None), subscribe with ak::wwise::ui::SELECTION_CHANGED.

call Return Values

  • call(uri, args, options) returns Result<Option<Value>, Error>: on success, WAAPI kwargs are returned as serde_json::Value; None when there's no result.
  • args and options are Option<serde_json::Value> (e.g. Some(json!({...})) or None).

Examples and Tests

  • Get Wwise version: cargo run --example get_info
  • Subscribe to selection changes (callback): cargo run --example subscribe
  • Run tests: cargo test (some tests require a local WAAPI, otherwise they skip)

Docs and Design

  • Generate and open API docs: cargo doc --open
  • Development design and architecture: DESIGN.md

References