/*******************************************************************************
The content of this file includes portions of the proprietary AUDIOKINETIC Wwise
Technology released in source code form as part of the game integration package.
The content of this file may not be used without valid licenses to the
AUDIOKINETIC Wwise Technology.
Note that the use of the game engine is subject to the Unity(R) Terms of
Service at https://unity3d.com/legal/terms-of-service
License Usage
Licensees holding valid licenses to the AUDIOKINETIC Wwise Technology may use
this file in accordance with the end user license agreement provided with the
software or, alternatively, in accordance with the terms contained
in a written agreement between you and Audiokinetic Inc.
Copyright (c) 2025 Audiokinetic Inc.
*******************************************************************************/
/// URI strings to use in WAAPI calls. For a complete description, refer to the official Wwise SDK documentation.
public class ak
{
public class soundengine
{
/// 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.
public const string setMultiplePositions = "ak.soundengine.setMultiplePositions";
/// 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.
public const string setScalingFactor = "ak.soundengine.setScalingFactor";
/// Asynchronously post an Event to the sound engine (by event ID). See AK::SoundEngine::PostEvent.
public const string postEvent = "ak.soundengine.postEvent";
/// Set the value of a real-time parameter control. See AK::SoundEngine::SetRTPCValue.
public const string setRTPCValue = "ak.soundengine.setRTPCValue";
/// 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.
public const string setObjectObstructionAndOcclusion = "ak.soundengine.setObjectObstructionAndOcclusion";
/// 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.
public const string setListeners = "ak.soundengine.setListeners";
/// Execute an action on all nodes that are referenced in the specified event in an action of type play. See AK::SoundEngine::ExecuteActionOnEvent.
public const string executeActionOnEvent = "ak.soundengine.executeActionOnEvent";
/// Set a listener's spatialization parameters. This lets you define listener-specific volume offsets for each audio channel. See AK::SoundEngine::SetListenerSpatialization.
public const string setListenerSpatialization = "ak.soundengine.setListenerSpatialization";
/// Reset the value of a real-time parameter control to its default value, as specified in the Wwise project. See AK::SoundEngine::ResetRTPCValue.
public const string resetRTPCValue = "ak.soundengine.resetRTPCValue";
/// 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.
public const string unregisterGameObj = "ak.soundengine.unregisterGameObj";
/// Stop the current content, associated to the specified playing ID, from playing. See AK::SoundEngine::StopPlayingID.
public const string stopPlayingID = "ak.soundengine.stopPlayingID";
/// Set the Auxiliary Busses to route the specified game object. See AK::SoundEngine::SetGameObjectAuxSendValues.
public const string setGameObjectAuxSendValues = "ak.soundengine.setGameObjectAuxSendValues";
/// Seek inside all playing objects that are referenced in Play Actions of the specified Event. See AK::SoundEngine::SeekOnEvent.
public const string seekOnEvent = "ak.soundengine.seekOnEvent";
/// 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.
public const string registerGameObj = "ak.soundengine.registerGameObj";
/// Set a the default active listeners for all subsequent game objects that are registered. See AK::SoundEngine::SetDefaultListeners.
public const string setDefaultListeners = "ak.soundengine.setDefaultListeners";
/// Set the position of a game object. See AK::SoundEngine::SetPosition.
public const string setPosition = "ak.soundengine.setPosition";
/// Display a message in the profiler's Capture Log view.
public const string postMsgMonitor = "ak.soundengine.postMsgMonitor";
/// Set the output bus volume (direct) to be used for the specified game object. See AK::SoundEngine::SetGameObjectOutputBusVolume.
public const string setGameObjectOutputBusVolume = "ak.soundengine.setGameObjectOutputBusVolume";
/// Set the State of a Switch Group. See AK::SoundEngine::SetSwitch.
public const string setSwitch = "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.
public const string stopAll = "ak.soundengine.stopAll";
/// Post the specified Trigger. See AK::SoundEngine::PostTrigger.
public const string postTrigger = "ak.soundengine.postTrigger";
public class error
{
public const string invalid_playing_id = "ak.soundengine.invalid_playing_id";
public const string wrong_volumeOffsets_length = "ak.soundengine.wrong_volumeOffsets_length";
}
}
public class wwise
{
public class error
{
public const string invalid_arguments = "ak.wwise.invalid_arguments";
public const string invalid_options = "ak.wwise.invalid_options";
public const string invalid_json = "ak.wwise.invalid_json";
public const string invalid_object = "ak.wwise.invalid_object";
public const string invalid_property = "ak.wwise.invalid_property";
public const string invalid_reference = "ak.wwise.invalid_reference";
public const string invalid_query = "ak.wwise.query.invalid_query";
public const string file_error = "ak.wwise.file_error";
public const string unavailable = "ak.wwise.unavailable";
public const string unexpected_error = "ak.wwise.unexpected_error";
public const string locked = "ak.wwise.locked";
public const string connection_failed = "ak.wwise.connection_failed";
public const string already_connected = "ak.wwise.already_connected";
public const string wwise_console = "ak.wwise.wwise_console";
}
public class debug
{
/// Private use only.
public const string testAssert = "ak.wwise.debug.testAssert";
/// Sent when an assert has failed. This is only available with Debug builds.
public const string assertFailed = "ak.wwise.debug.assertFailed";
/// 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.
public const string enableAutomationMode = "ak.wwise.debug.enableAutomationMode";
/// 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.
public const string enableAsserts = "ak.wwise.debug.enableAsserts";
}
public class core
{
public class audioSourcePeaks
{
/// 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.
public const string getMinMaxPeaksInRegion = "ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInRegion";
/// 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.
public const string getMinMaxPeaksInTrimmedRegion = "ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInTrimmedRegion";
}
public class remote
{
/// Retrieves the connection status.
public const string getConnectionStatus = "ak.wwise.core.remote.getConnectionStatus";
/// Retrieves all consoles available for connecting Wwise Authoring to a Sound Engine instance.
public const string getAvailableConsoles = "ak.wwise.core.remote.getAvailableConsoles";
/// Disconnects the Wwise Authoring application from a connected Wwise Sound Engine running executable.
public const string disconnect = "ak.wwise.core.remote.disconnect";
/// Connects the Wwise Authoring application to a Wwise Sound Engine running executable. The host must be running code with communication enabled.
public const string connect = "ak.wwise.core.remote.connect";
}
public class log
{
/// Sent when an item is added to the log. This could be used to retrieve items added to the SoundBank generation log. To retrieve the complete log, refer to ak.wwise.core.log.get.
public const string itemAdded = "ak.wwise.core.log.itemAdded";
/// Retrieve the latest log for a specific channel. Refer to ak.wwise.core.log.itemadded to be notified when an item is added to the log.
public const string get = "ak.wwise.core.log.get";
}
/// Retrieve global Wwise information.
public const string getInfo = "ak.wwise.core.getInfo";
public class @object
{
/// Sent when an object reference is changed.
public const string referenceChanged = "ak.wwise.core.object.referenceChanged";
/// Moves an object to the given parent. Returns the moved object.
public const string move = "ak.wwise.core.object.move";
/// Sent when an attenuation curve's link/unlink is changed.
public const string attenuationCurveLinkChanged = "ak.wwise.core.object.attenuationCurveLinkChanged";
/// Sent when an object is added as a child to another object.
public const string childAdded = "ak.wwise.core.object.childAdded";
/// Retrieves the list of all object types registered in Wwise's object model.
public const string getTypes = "ak.wwise.core.object.getTypes";
/// Sent when the watched property of an object changes.
public const string propertyChanged = "ak.wwise.core.object.propertyChanged";
/// Creates an object of type 'type', as a child of 'parent'. Refer to ak.wwise.core.audio.import to import audio files to Wwise.
public const string create = "ak.wwise.core.object.create";
/// Performs a query, returns specified data for each object in query result.
public const string get = "ak.wwise.core.object.get";
/// Sent prior to an object's deletion.
public const string preDeleted = "ak.wwise.core.object.preDeleted";
/// Sent when an object is renamed. Publishes the object which the name was changed.
public const string nameChanged = "ak.wwise.core.object.nameChanged";
/// Sent following an object's deletion.
public const string postDeleted = "ak.wwise.core.object.postDeleted";
/// Sent when the object's notes are changed.
public const string notesChanged = "ak.wwise.core.object.notesChanged";
/// Retrieves information about an object property.
public const string getPropertyInfo = "ak.wwise.core.object.getPropertyInfo";
/// Renames an object.
public const string setName = "ak.wwise.core.object.setName";
/// Sets the object's notes.
public const string setNotes = "ak.wwise.core.object.setNotes";
/// Sets the specified attenuation curve for a given attenuation object.
public const string setAttenuationCurve = "ak.wwise.core.object.setAttenuationCurve";
/// Sets a property value of an object for a specific platform. Refer to ak.wwise.core.object.setreference to set a reference to an object.
public const string setProperty = "ak.wwise.core.object.setProperty";
/// Copies an object to the given parent.
public const string copy = "ak.wwise.core.object.copy";
/// Return true if a property is enabled based on the values of the properties it depends on.
public const string isPropertyEnabled = "ak.wwise.core.object.isPropertyEnabled";
/// Sets the randomizer values of a property of an object for a specific platform.
public const string setRandomizer = "ak.wwise.core.object.setRandomizer";
/// Sets an object's reference value.
public const string setReference = "ak.wwise.core.object.setReference";
/// Sent when an attenuation curve is changed.
public const string attenuationCurveChanged = "ak.wwise.core.object.attenuationCurveChanged";
/// Sent when an object is created.
public const string created = "ak.wwise.core.object.created";
/// Sent when an object is removed from the children of another object.
public const string childRemoved = "ak.wwise.core.object.childRemoved";
/// Retrieves the list of property and reference names for an object.
public const string getPropertyNames = "ak.wwise.core.object.getPropertyNames";
/// Gets the specified attenuation curve for a given attenuation object.
public const string getAttenuationCurve = "ak.wwise.core.object.getAttenuationCurve";
/// Sent when one or many curves are changed.
public const string curveChanged = "ak.wwise.core.object.curveChanged";
/// Deletes the specified object.
public const string delete = "ak.wwise.core.object.delete";
/// Retrieves the list of property and reference names for an object.
public const string getPropertyAndReferenceNames = "ak.wwise.core.object.getPropertyAndReferenceNames";
}
public class undo
{
/// Ends the last undo group.
public const string endGroup = "ak.wwise.core.undo.endGroup";
/// Cancels the last undo group. Please note that this does not revert the operations made since the last ak.wwise.core.undo.begingroup call.
public const string cancelGroup = "ak.wwise.core.undo.cancelGroup";
/// 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.
public const string beginGroup = "ak.wwise.core.undo.beginGroup";
}
public class profiler
{
/// Returns the current time of the specified profiler cursor in milliseconds.
public const string getCursorTime = "ak.wwise.core.profiler.getCursorTime";
/// Start the profiler capture and return the time at the beginning of the capture in milliseconds.
public const string startCapture = "ak.wwise.core.profiler.startCapture";
/// Retrieves all parameters affecting voice volume, highpass and lowpass for a voice path, resolved from pipeline IDs.
public const string getVoiceContributions = "ak.wwise.core.profiler.getVoiceContributions";
/// Retrieves the voices at a specific profiler capture time.
public const string getVoices = "ak.wwise.core.profiler.getVoices";
/// Retrieves the busses at a specific profiler capture time.
public const string getBusses = "ak.wwise.core.profiler.getBusses";
/// Stop the profiler capture and return the time at the end of the capture in milliseconds.
public const string stopCapture = "ak.wwise.core.profiler.stopCapture";
}
public class project
{
/// Sent when the after the project is completely closed.
public const string postClosed = "ak.wwise.core.project.postClosed";
/// Sent when the project has been successfully loaded.
public const string loaded = "ak.wwise.core.project.loaded";
/// Sent when the project begins closing.
public const string preClosed = "ak.wwise.core.project.preClosed";
/// Saves the current project.
public const string save = "ak.wwise.core.project.save";
/// Sent when the project has been saved.
public const string saved = "ak.wwise.core.project.saved";
}
public class transport
{
/// Gets the state of the given transport object.
public const string getState = "ak.wwise.core.transport.getState";
/// Sent when the transport's state has changed.
public const string stateChanged = "ak.wwise.core.transport.stateChanged";
/// 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.
public const string create = "ak.wwise.core.transport.create";
/// Returns the list of transport objects.
public const string getList = "ak.wwise.core.transport.getList";
/// Destroys the given transport object.
public const string destroy = "ak.wwise.core.transport.destroy";
/// Executes an action on the given transport object, or all transports if no transport is specified.
public const string executeAction = "ak.wwise.core.transport.executeAction";
}
public class soundbank
{
/// Retrieves a SoundBank's inclusion list.
public const string getInclusions = "ak.wwise.core.soundbank.getInclusions";
/// Sent when a single SoundBank is generated. This could be sent multiple times during SoundBank generation, for every SoundBank generated and for every platform. To generate SoundBanks, refer to ak.wwise.ui.commands.execute with one of the SoundBank generation commands.
public const string generated = "ak.wwise.core.soundbank.generated";
/// 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.
public const string setInclusions = "ak.wwise.core.soundbank.setInclusions";
}
public class audio
{
/// 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.
public const string import = "ak.wwise.core.audio.import";
/// Scripted object creation and audio file import from a tab-delimited file.
public const string importTabDelimited = "ak.wwise.core.audio.importTabDelimited";
/// Sent at the end of an import operation.
public const string imported = "ak.wwise.core.audio.imported";
}
public class switchContainer
{
/// Remove an assignment between a Switch Container's child and a State.
public const string removeAssignment = "ak.wwise.core.switchContainer.removeAssignment";
/// Returns the list of assignments between a Switch Container's children and states.
public const string getAssignments = "ak.wwise.core.switchContainer.getAssignments";
/// Sent when an assignment is removed from a Switch Container.
public const string assignmentRemoved = "ak.wwise.core.switchContainer.assignmentRemoved";
/// 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.
public const string addAssignment = "ak.wwise.core.switchContainer.addAssignment";
/// Sent when an assignment is added to a Switch Container.
public const string assignmentAdded = "ak.wwise.core.switchContainer.assignmentAdded";
}
public class plugin
{
/// Retrieves the list of all object types registered in Wwise's object model.
public const string getList = "ak.wwise.core.plugin.getList";
/// Retrieves information about an object property.
public const string getProperty = "ak.wwise.core.plugin.getProperty";
/// Retrieves the list of property and reference names for an object.
public const string getProperties = "ak.wwise.core.plugin.getProperties";
}
}
public class ui
{
public class project
{
/// Closes the current project.
public const string close = "ak.wwise.ui.project.close";
/// 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.
public const string open = "ak.wwise.ui.project.open";
}
/// 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.
public const string bringToForeground = "ak.wwise.ui.bringToForeground";
public class commands
{
/// Unregister an array of add-on UI commands.
public const string unregister = "ak.wwise.ui.commands.unregister";
/// Sent when a command is executed. The objects for which the command is executed are sent in the publication.
public const string executed = "ak.wwise.ui.commands.executed";
/// Executes a command. Some commands can take a list of objects as parameter.
public const string execute = "ak.wwise.ui.commands.execute";
/// Register an array of add-on commands. Registered commands remain until the Wwise process is terminated. Refer to to ak.wwise.ui.commands.executed.
public const string register = "ak.wwise.ui.commands.register";
/// Get the list of commands.
public const string getCommands = "ak.wwise.ui.commands.getCommands";
}
/// Retrieves the list of objects currently selected by the user in the active view.
public const string getSelectedObjects = "ak.wwise.ui.getSelectedObjects";
/// Sent when the selection changes in the project.
public const string selectionChanged = "ak.wwise.ui.selectionChanged";
}
public class waapi
{
/// Retrieve the list of topics to which a client can subscribe.
public const string getTopics = "ak.wwise.waapi.getTopics";
/// Retrieve the list of functions.
public const string getFunctions = "ak.wwise.waapi.getFunctions";
/// Retrieve the JSON schema of a Waapi URI.
public const string getSchema = "ak.wwise.waapi.getSchema";
}
}
}