Skip to main content

Wwise Authoring API client.

Project description

Wwise Authoring API (Waapi) Client for Python

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


  • Python 3.7, 3.8 or 3.9
  • Wwise instance with the Wwise Authoring API enabled (Project > User Preferences... > Enable Wwise Authoring API)


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

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


from waapi import WaapiClient

with client as WaapiClient()
    result ="ak.wwise.core.getInfo")

The with statement automatically closes the connection and unregisters subcribers. To keep the connection alive, instantiate WaapiClient and call disconnect when you are done.

from waapi import WaapiClient

# Connect (default URL)
client = WaapiClient()

result ="ak.wwise.core.getInfo")

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

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


# Unsubscribe

# Disconnect

Be aware that failing to call disconnect will result in the program to appear unresponsive, as the background thread running the connection will remain active.


This repository accepts pull requests. You may open an issue for any bugs or improvement requests.

Local Install

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 .


pipenv install --three

Running the Tests

Install the tox package:

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

Open a blank project in Wwise, then you may execute tox in the terminal from the root of the repository

The test suite will run for all supported versions of Python. Use -e pyXX to run for a single version, e.g., tox -e py37 for Python 3.7).

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for waapi-client, version 0.5
Filename, size File type Python version Upload date Hashes
Filename, size waapi_client-0.5-py3-none-any.whl (17.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size waapi-client-0.5.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page