waapi-uri 0.2.0

Typed string constants for all Wwise Authoring API (WAAPI) function URIs

waapi-uri

Typed string constants for all Wwise Authoring API (WAAPI) function URIs and subscription topics.

Eliminates hard-coded strings in your WAAPI automation scripts and enables IDE auto-completion and static type checking.

Wwise version: Constants are generated from Wwise 2025.1.7.

Installation

pip install waapi-uri

Usage

Function URIs

from waapi_uri import uri
from waapi import WaapiClient

with WaapiClient() as client:
    # Use typed constants instead of raw strings
    result = client.call(uri.ak_wwise_core_object_get, {
        "from": {"path": ["\\Actor-Mixer Hierarchy"]},
        "options": {"return": ["name", "type"]},
    })

All WAAPI function URIs are available as module-level string constants on waapi_uri.uri, named by replacing . with _:

Constant	Value
uri.ak_wwise_core_object_get	"ak.wwise.core.object.get"
uri.ak_wwise_core_object_set	"ak.wwise.core.object.set"
uri.ak_soundengine_postEvent	"ak.soundengine.postEvent"
…	…

Subscription Topics

from waapi_uri import topic
from waapi import WaapiClient

with WaapiClient() as client:
    # Subscribe to object name changes using a typed topic constant
    def on_name_changed(object, **kwargs):
        print(f"Renamed: {object['name']}")

    handler = client.subscribe(topic.ak_wwise_core_object_nameChanged, on_name_changed)

All WAAPI subscription topics are available as module-level string constants on waapi_uri.topic, using the same naming convention:

Constant	Value
topic.ak_wwise_core_object_nameChanged	"ak.wwise.core.object.nameChanged"
topic.ak_wwise_core_object_created	"ak.wwise.core.object.created"
topic.ak_wwise_core_project_saved	"ak.wwise.core.project.saved"
…	…

Regenerating Constants

The constants are auto-generated from a running Wwise instance. To regenerate them against a different Wwise version:

1. Open Wwise with WAAPI enabled.
2. Run the generation scripts:

python scripts/gen_uri.py
python scripts/gen_topics.py

These will overwrite src/waapi_uri/uri.py and src/waapi_uri/topic.py with all URIs and topics reported by the connected Wwise instance.

Requirements

• Python >= 3.10

License

MIT