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.

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


Download files

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

Source Distribution

waapi_client-0.8.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

waapi_client-0.8-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file waapi_client-0.8.tar.gz.

File metadata

  • Download URL: waapi_client-0.8.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for waapi_client-0.8.tar.gz
Algorithm Hash digest
SHA256 a620e5b37aceb7b18066e324b4949c65c698d4b7b27c8f26d6b615dc442d2910
MD5 0cb1dddb7f580fdd6466fc038f68084b
BLAKE2b-256 0dbe9d17b3515b50fecd43858a62ea08524f6b9cef32e9969c896f8230c5643b

See more details on using hashes here.

File details

Details for the file waapi_client-0.8-py3-none-any.whl.

File metadata

  • Download URL: waapi_client-0.8-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for waapi_client-0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e63554f464d560845f54f57e60effb785ff4675e8054d87f7c4f7b1128386ef2
MD5 d1adfcdbecb102ed5eefda147b5de3ea
BLAKE2b-256 420f417210aea9cdef63e87edae325eb7da1565990111eb9dd4509b2fb890d8d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page