Skip to main content
Reagent works with Wwise Authoring on your computer through the Wwise Authoring API (WAAPI), with or without REAPER running. Reagent hands investigations to a helper called the Wwise subagent, which reads your project and reports back. Reagent itself makes any changes.

​
Before You Start

  • Wwise 2021.1 or newer, on Windows or macOS. Older versions get a “not supported” message.
  • Wwise Authoring running on the same computer as Reagent, with your project open.
Some requests need a newer Wwise, because the features behind them only exist there. WAQL, the Wwise Authoring Query Language, is what Reagent uses to search your project.
On macOS, Wwise Authoring is the Windows version of Wwise running inside CrossOver, a Windows compatibility layer installed with it. Reagent connects to it the same way as on Windows.Because of CrossOver, Wwise on your Mac can report file paths with Windows drive letters (for example Z:\Users\...). When Reagent’s audio tools open one of these files, they look for the matching file on your Mac.

​
Connect to Wwise

1

Turn on WAAPI

In Wwise, open Project > User Preferences and turn on Enable Wwise Authoring API.
2

Check the ports

Leave the WAAPI ports at their defaults: 8090 (HTTP), which Reagent uses for all Wwise requests, and 8080 (WAMP), which live mixing uses to follow the profiler capture log. If you changed either one, set it back.
3

Restart Wwise

WAAPI changes take effect after you close and reopen Wwise.
4

Open your project

Open your project in Wwise. Reagent finds the running Wwise on its own when you send a message.
5

Check the connection

Ask “Is Wwise connected?” Reagent can tell you which Wwise version it sees. The app has no Wwise status light, so asking is the quickest check. If you sent a message before Wwise was ready, Reagent can take up to 30 seconds to notice, so wait, then ask again.
For connection errors, timeouts and unsupported versions, see Wwise Connection Problems.

​
Using Your Wwise Selection

With each message, Reagent tells the AI model what’s selected in Wwise (up to 10 objects), so you can say “these objects” or “the selected bus”. What Reagent Sends lists exactly what’s shared. While Wwise is connected to a running game, Reagent ignores your selection for requests about something you heard, so an object you clicked earlier isn’t changed by mistake. To use the selection anyway, say “selected” or “selection”.

​
Explore and Debug Your Project

The Wwise subagent explores your project and reads live profiler data from a connected game, then reports what it found. It’s built to investigate, not to change your project. It shows in the chat as a collapsed step labeled with its task; click it to see what it did.
To investigate, the subagent uses:
  • WAAPI queries and read-only scripts to read your project, so you can debug problems and catch structural mistakes across large projects. If a WAAPI call fails, it reads Wwise’s error message and can retry with corrected arguments.
  • Knowledge articles: hand-written Wwise articles on troubleshooting, best practices and version migration, looked up on reaperagent.com. Describe a tricky problem and it can pull in the relevant article.
  • Reference for your Wwise version: WAAPI function and object reference, plus WAQL documentation for your version, looked up on reaperagent.com so its queries match.

​
Audio Analysis on Wwise Source Files

Reagent can measure the source files your Wwise Sounds use: loudness (RMS), silence (for example, dead air left by trim points), transients, waveform shape and metadata. The Wwise subagent finds the file paths, then Reagent runs the Audio Analysis file tools on your computer. The tools can measure part of a file, so you can ask Reagent to stay within the trim points set in Wwise.

​
Make Changes

Reagent can create objects, set properties and references, import audio, and run a script for batch changes across many objects.
Whether Reagent asks before a Wwise change depends on the permission mode you pick in the chat box. See Permissions. The approval card names the action (Apply Mix, Mutate Waapi or Mutate Script) but not the target object or the new value. Read what Reagent said it’s about to change before you click Allow or Deny.
  • You approve one step at a time, and a single script step can change many objects behind one approval.
  • The Wwise subagent’s own steps and the audio analysis tools never ask, in any mode.
In Default permissions and Auto-review, Reagent may also ask on a Use Wwise subagent card before handing the subagent a task whose wording (written by Reagent) contains a word such as “set”, “create”, “apply”, “change”, “run” or “trim”, even for a question such as checking trim points. Any change the subagent leads to still gets its own approval.

​
Undoing Changes

To reverse a change, use Edit > Undo in Wwise. An undo group is a set of changes that Wwise lists as one step in its undo history, so one Edit > Undo reverses all of it. A task done as several separate changes needs one Undo per change, and if a later change fails, the earlier ones stay in place.
Wwise undoes in order, most recent first. Undo Reagent’s changes before you make other edits you want to keep.

​
Live Mixing

While Wwise is connected to your running game, describe a sound you just heard and how to change it. Reagent finds the object that played in Wwise’s profiler data, not your Wwise selection. It also reads the Switch, State and RTPC values in effect, so it can tell apart variations such as footsteps on different surfaces.
1

Connect and start capture

Connect Wwise to your running game, then start Profiler capture (press F5 in Wwise).
2

Play the sound

Trigger the sound in the game. Reagent looks back over up to the last five minutes of the capture.
3

Describe the change

Say what to change and by how much. A number in dB gives the most predictable result.
4

Answer any question

If more than one object could match, Reagent lists the candidates and asks which one you mean.
5

Approve the change

Click Allow on the approval card, and the change applies right away. In Full access there’s no card. See Make Changes.
Example requests, including questions that change nothing:
Without a game connection, Reagent can’t tell which sound you heard, so name the object instead, as in the last example. Naming it needs no game connection or capture. When capture is on, Reagent also adds a line to the profiler capture log, so you can see where each change came from:
If live mixing doesn’t behave as expected:
Wwise is connected to your game, but Profiler capture is off, and Reagent needs it before it handles requests like “that sound”. Press F5 in Wwise, play the sound again, then repeat your request.
Reagent couldn’t find the sound in the capture. It only looks at what played while capture was running, up to the last five minutes. Trigger the sound again, or name the object instead.
Check that Wwise is connected to the running game and that capture is on. Live mixing also reads the capture log over port 8080 (WAMP), so check that this port hasn’t been changed in Project > User Preferences.
Reagent gets a warning back if Wwise clamps the value, the value is outside the property’s range, or the change is to the make-up gain of an object that uses loudness normalization. It can mention the warning in its reply.

​
What Reagent Sends

Reagent connects to Wwise on this computer (127.0.0.1). To work on your request, it sends Wwise information to the AI model, which is Reagent’s hosted service on individual plans:
  • With each message: whether Wwise is connected and its version, and up to 10 selected objects (name, type, path and ID) plus a count of any others. While a game is connected, it sends the number of selected objects instead, plus the connected game’s name, whether capture is on and, while capturing, how many voices played in the last few seconds.
  • During Wwise tasks: what Reagent reads from and changes in your project, whether the Wwise subagent or Reagent itself does the work. That includes live capture details, the results of changes, and measurements of source audio files.
  • Lookups: the search text the Wwise subagent writes goes to reaperagent.com, which sends it to Voyage AI to find matching articles and reference. Your Wwise version also goes to reaperagent.com to fetch reference for that version, including the WAQL documentation each time the Wwise subagent starts.
On Enterprise accounts, the AI model is your organization’s own endpoint instead.

Permissions

Choose when Reagent asks before it changes your Wwise project.

Audio Analysis

The file analysis tools Reagent uses on Wwise source files.

Example Workflows

Wwise prompts alongside other common tasks.

Privacy & Security

What Reagent sends, and where.