Table of Contents

Wwise SDK 2019.1.7
Wwise Authoring API Reference - Functions

Refer to Using the Wwise Authoring API (WAAPI) for more information about WAAPI.

Execute an action on all nodes that are referenced in the specified event in an action of type play. See AK::SoundEngine::ExecuteActionOnEvent.

Asynchronously post an Event to the sound engine (by event ID). See AK::SoundEngine::PostEvent.

Display a message in the profiler's Capture Log view.

Post the specified Trigger. See AK::SoundEngine::PostTrigger.

Register a game object. Registering a game object twice does nothing. Unregistering it once unregisters it no matter how many times it has been registered. See AK::SoundEngine::RegisterGameObj.

Reset the value of a real-time parameter control to its default value, as specified in the Wwise project. See AK::SoundEngine::ResetRTPCValue.

Seek inside all playing objects that are referenced in Play Actions of the specified Event. See AK::SoundEngine::SeekOnEvent.

Set a the default active listeners for all subsequent game objects that are registered. See AK::SoundEngine::SetDefaultListeners.

Set the Auxiliary Busses to route the specified game object. See AK::SoundEngine::SetGameObjectAuxSendValues.

Set the output bus volume (direct) to be used for the specified game object. See AK::SoundEngine::SetGameObjectOutputBusVolume.

Set a single game object's active listeners. By default, all new game objects have no listeners active, but this behavior can be overridden with SetDefaultListeners(). Inactive listeners are not computed. See AK::SoundEngine::SetListeners.

Set a listener's spatialization parameters. This lets you define listener-specific volume offsets for each audio channel. See AK::SoundEngine::SetListenerSpatialization.

Set multiple positions for a single game object. Setting multiple positions for a single game object is a way to simulate multiple emission sources while using the resources of only one voice. This can be used to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area. See AK::SoundEngine::SetMultiplePositions.

Set a game object's obstruction and occlusion levels. This function is used to affect how an object should be heard by a specific listener. See AK::SoundEngine::SetObjectObstructionAndOcclusion.

Set the position of a game object. See AK::SoundEngine::SetPosition.

Set the value of a real-time parameter control. See AK::SoundEngine::SetRTPCValue.

Set the scaling factor of a game object. Modify the attenuation computations on this game object to simulate sounds with a larger or smaller area of effect. See AK::SoundEngine::SetScalingFactor.

Set the State of a Switch Group. See AK::SoundEngine::SetSwitch.

Stop playing the current content associated to the specified game object ID. If no game object is specified, all sounds will be stopped. See AK::SoundEngine::StopAll.

Stop the current content, associated to the specified playing ID, from playing. See AK::SoundEngine::StopPlayingID.

Unregister a game object. Registering a game object twice does nothing. Unregistering it once unregisters it no matter how many times it has been registered. Unregistering a game object while it is in use is allowed, but the control over the parameters of this game object is lost. For example, say a sound associated with this game object is a 3D moving sound. It will stop moving when the game object is unregistered, and there will be no way to regain control over the game object. See AK::SoundEngine::UnregisterGameObj.
Create Wwise objects and import audio files. This function is using the same importation processor available through the Tab Delimited import in the Audio File Importer. The function returns an array of all objects created, replaced or re-used. Use the options to specify how the objects are returned. For more information, refer to Importing Audio Files and Creating Structures.
Scripted object creation and audio file import from a tab-delimited file.

Get the min/max peak pairs, in a given region of an audio source, as a collection of binary strings (one per channel). The strings are base-64 encoded 16-bit signed int arrays, with min and max values being interleaved. If getCrossChannelPeaks is true, there will be only one binary string representing peaks across all channels globally.

Get the min/max peak pairs in the entire trimmed region of an audio source, for each channel, as an array of binary strings (one per channel). The strings are base-64 encoded 16-bit signed int arrays, with min and max values being interleaved. If getCrossChannelPeaks is true, there will be only one binary string representing peaks across all channels globally.

Retrieve global Wwise information.

Retrieve the latest log for a specific channel. Refer to ak.wwise.core.log.itemAdded to be notified when a item is added to the log.

Copies an object to the given parent.

Creates an object of type 'type', as a child of 'parent'. Refer to Importing Audio Files and Creating Structures for more information about creating objects. Also refer to to import audio files to Wwise.

Deletes the specified object.

Performs a query, returns specified data for each object in query result. Refer to Querying the Wwise Project for more information.

Gets the specified attenuation curve for a given attenuation object.

Retrieves the list of property and reference names for an object.

Retrieves information about an object property.

Retrieves the list of all object types registered in Wwise's object model. This function returns the equivalent of Wwise Objects Reference .

Return true if a property is enabled based on the values of the properties it depends on.

Moves an object to the given parent. Returns the moved object.

Sets the specified attenuation curve for a given attenuation object.

Renames an object.

Sets the object's notes.

Sets a property value of an object for a specific platform. Refer to Wwise Objects Reference for more information on the properties available on each object type. Refer to ak.wwise.core.object.setReference to set a reference to an object.

Sets the randomizer values of a property of an object for a specific platform. Refer to Wwise Objects Reference for more information on the properties available on each object type.

Sets an object's reference value. Refer to Wwise Objects Reference for more information on the references available on each object type.

Retrieves the busses at a specific profiler capture time.

Returns the current time of the specified profiler cursor in milliseconds.

Retrieves all parameters affecting voice volume, highpass and lowpass for a voice path, resolved from pipeline IDs.

Retrieves the voices at a specific profiler capture time.

Start the profiler capture and return the time at the beginning of the capture in milliseconds.

Stop the profiler capture and return the time at the end of the capture in milliseconds.
Saves the current project.

Connects the Wwise Authoring application to a Wwise Sound Engine running executable. The host must be running code with communication enabled. If only "host" is provided, Wwise will connect to the first Sound Engine instance found. To distinguish between different instances, you can also provide the name of the application to connect to.

Disconnects the Wwise Authoring application from a connected Wwise Sound Engine running executable.

Retrieves all consoles available for connecting Wwise Authoring to a Sound Engine instance.

Retrieves the connection status.

Retrieves a SoundBank's inclusion list.

Modifies a SoundBank's inclusion list. The 'operation' argument determines how the 'inclusions' argument modifies the SoundBank's inclusion list; 'inclusions' may be added to / removed from / replace the SoundBank's inclusion list.

Assign a Switch Container's child to a Switch. This is the equivalent of doing a drag&drop of the child to a state in the Assigned Objects view. The child is always added at the end for each state.

Returns the list of assignments between a Switch Container's children and states.

Remove an assignment between a Switch Container's child and a State.

Creates a transport object for the given Wwise object. The return transport object can be used to play, stop, pause and resume the Wwise object via the other transport functions.

Destroys the given transport object.

Executes an action on the given transport object, or all transports if no transport is specified.

Returns the list of transport objects.

Gets the state of the given transport object.

Begins an undo group. Make sure to call ak.wwise.core.undo.endGroup exactly once for every ak.wwise.core.beginUndoGroup call you make. Calls to ak.wwise.core.undo.beginGroup can be nested.

Cancels the last undo group. Please note that this does not revert the operations made since the last ak.wwise.core.undo.beginGroup call.

Ends the last undo group.

Enables debug assertions. Every call to enableAsserts with false increments the ref count. Calling with true will decrement the ref count. This is only available with Debug builds.

Enable or disable the automation mode for Wwise. This reduces the potential interruptions caused by message boxes and dialogs. For instance, enabling the automation mode silently accepts: project migration, project load log, EULA acceptance, project licence display and generic message boxes.

Private use only.

Bring Wwise main window to foreground. Refer to SetForegroundWindow and AllowSetForegroundWindow on MSDN for more information on the restrictions. Refer to ak.wwise.core.getInfo to obtain the Wwise process ID for AllowSetForegroundWindow.

Executes a command. Some commands can take a list of objects as parameter. Refer to Wwise Authoring Command Identifiers for the available commands.

Get the list of commands.

Register an array of add-on commands. Registered commands remain until the Wwise process is terminated. Refer to Defining Command Add-ons for more information about registering commands. Also refer to ak.wwise.ui.commands.executed.

Unregister an array of add-on UI commands.

Retrieves the list of objects currently selected by the user in the active view.

Closes the current project.
Opens a project, specified by path. Please refer to ak.wwise.core.project.loaded for further explanations on how to be notified when the operation has completed.

Retrieve the list of functions.

Retrieve the JSON schema of a Waapi URI.

Retrieve the list of topics to which a client can subscribe.