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.
Requirements
- Non-EOL Python 3.x version (see
tox.ini
for versions tested). Refer to the official Status of Python versions - Wwise instance with the Wwise Authoring API enabled (
Project > User Preferences... > Enable Wwise Authoring API
)
Setup
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
with WaapiClient() as client:
result = client.call("ak.wwise.core.getInfo")
The with
statement automatically closes the connection and unregisters subscribers.
To keep the connection alive, instantiate WaapiClient
and call disconnect
when you are done.
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()
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.
Contribute
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 .
or
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 py312
for Python 3.12).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for waapi_client-0.7.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 556858614e4a4cf8ea103b8ab07ceb5d131ad37d3bdbd4cd2a24104556dd0af6 |
|
MD5 | 86282124552e8e280129cab21970f602 |
|
BLAKE2b-256 | 37879942a33cb714e8271d23878a4c12199b6dcb1d36bcf7d94785a391a5e675 |