Wwise Authoring API (Waapi) Client for Python

Decoupled autobahn WAMP client with support for plain options and bindable subscription callbacks.

Requirements

• Python 3.6+
• Wwise instance with the Wwise Authoring API enabled (Project > User Preferences... > Enable Wwise Authoring API)

For general usage

Setup

For compatibility with Python 2 on Windows, it is recommended to use the Python Launcher for Windows which is installed with Python 3 from python.org.

• Windows: py -3 -m pip install waapi-client
• Other platforms: python3 -m pip install waapi-client

Usage

from waapi import WaapiClient

# Connect (default URL)
client = WaapiClient()

# RPC
result = client.call("ak.wwise.core.getInfo")

# Subscribe
handler = client.subscribe(
    "ak.wwise.core.object.created",
    lambda object: print("Object created: " + str(object))
)

# Bind a different callback at any time
def my_callback(object):
    print("Different callback: " + str(object))

handler.bind(my_callback)

# Unsubscribe
handler.unsubscribe()

# Disconnect
client.disconnect()

For contributors

Setup

You may install the package locally using either pip or pipenv.

Clone this repository, then from the repository root run:

• Windows: py -3 -m pip install -e .
• Other platforms: python3 -m pip install -e .

or

pipenv install --three

Running the tests

Open a blank project in Wwise, then you may execute the test on terminal from the root of the repository by running:

• Windows: py -3 setup.py test
• Other platforms: python3 setup.py test