123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478 |
- /*
- The content of this file includes portions of the AUDIOKINETIC Wwise Technology
- released in source code form as part of the SDK installer package.
- Commercial License Usage
- Licensees holding valid commercial 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.
- Apache License Usage
- Alternatively, this file may be used under the Apache License, Version 2.0 (the
- "Apache License"); you may not use this file except in compliance with the
- Apache License. You may obtain a copy of the Apache License at
- http://www.apache.org/licenses/LICENSE-2.0.
- Unless required by applicable law or agreed to in writing, software distributed
- under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
- OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
- the specific language governing permissions and limitations under the License.
- Copyright (c) 2023 Audiokinetic Inc.
- */
- public class ak
- {
- public class soundengine
- {
- /// <summary>Executes an action on all nodes that are referenced in the specified event in a Play action. See <tt>AK::SoundEngine::ExecuteActionOnEvent</tt>.</summary>
- public const string executeActionOnEvent = "ak.soundengine.executeActionOnEvent";
- /// <summary>Gets the current state of a State Group. When using setState just prior to getState, allow a brief delay (no more than 10ms) for the information to update in the sound engine.</summary>
- public const string getState = "ak.soundengine.getState";
- /// <summary>Gets the current state of a Switch Group for a given Game Object.</summary>
- public const string getSwitch = "ak.soundengine.getSwitch";
- /// <summary>Load a SoundBank. See <tt>AK::SoundEngine::LoadBank</tt>.</summary>
- public const string loadBank = "ak.soundengine.loadBank";
- /// <summary>Asynchronously post an Event to the sound engine (by event ID). See <tt>AK::SoundEngine::PostEvent</tt>.</summary>
- public const string postEvent = "ak.soundengine.postEvent";
- /// <summary>Display a message in the Profiler's Capture Log view.</summary>
- public const string postMsgMonitor = "ak.soundengine.postMsgMonitor";
- /// <summary>Posts the specified Trigger. See <tt>AK::SoundEngine::PostTrigger</tt>.</summary>
- public const string postTrigger = "ak.soundengine.postTrigger";
- /// <summary>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 <tt>AK::SoundEngine::RegisterGameObj</tt>.</summary>
- public const string registerGameObj = "ak.soundengine.registerGameObj";
- /// <summary>Resets the value of a real-time parameter control to its default value, as specified in the Wwise project. See <tt>AK::SoundEngine::ResetRTPCValue</tt>.</summary>
- public const string resetRTPCValue = "ak.soundengine.resetRTPCValue";
- /// <summary>Seeks inside all playing objects that are referenced in Play Actions of the specified Event. See <tt>AK::SoundEngine::SeekOnEvent</tt>.</summary>
- public const string seekOnEvent = "ak.soundengine.seekOnEvent";
- /// <summary>Sets the default active listeners for all subsequent game objects that are registered. See <tt>AK::SoundEngine::SetDefaultListeners</tt>.</summary>
- public const string setDefaultListeners = "ak.soundengine.setDefaultListeners";
- /// <summary>Sets the Auxiliary Busses to route the specified game object. See <tt>AK::SoundEngine::SetGameObjectAuxSendValues</tt>.</summary>
- public const string setGameObjectAuxSendValues = "ak.soundengine.setGameObjectAuxSendValues";
- /// <summary>Set the output bus volume (direct) to be used for the specified game object. See <tt>AK::SoundEngine::SetGameObjectOutputBusVolume</tt>.</summary>
- public const string setGameObjectOutputBusVolume = "ak.soundengine.setGameObjectOutputBusVolume";
- /// <summary>Sets a listener's spatialization parameters. This lets you define listener-specific volume offsets for each audio channel. See <tt>AK::SoundEngine::SetListenerSpatialization</tt>.</summary>
- public const string setListenerSpatialization = "ak.soundengine.setListenerSpatialization";
- /// <summary>Sets a single game object's active listeners. By default, all new game objects have no listeners active, but this behavior can be overridden with <tt>SetDefaultListeners()</tt>. Inactive listeners are not computed. See <tt>AK::SoundEngine::SetListeners</tt>.</summary>
- public const string setListeners = "ak.soundengine.setListeners";
- /// <summary>Sets 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 <tt>AK::SoundEngine::SetMultiplePositions</tt>.</summary>
- public const string setMultiplePositions = "ak.soundengine.setMultiplePositions";
- /// <summary>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 <tt>AK::SoundEngine::SetObjectObstructionAndOcclusion</tt>.</summary>
- public const string setObjectObstructionAndOcclusion = "ak.soundengine.setObjectObstructionAndOcclusion";
- /// <summary>Sets the position of a game object. See <tt>AK::SoundEngine::SetPosition</tt>.</summary>
- public const string setPosition = "ak.soundengine.setPosition";
- /// <summary>Sets the value of a real-time parameter control. See <tt>AK::SoundEngine::SetRTPCValue</tt>.</summary>
- public const string setRTPCValue = "ak.soundengine.setRTPCValue";
- /// <summary>Sets the scaling factor of a game object. You can modify the attenuation computations on this game object to simulate sounds with a larger or smaller affected areas. See <tt>AK::SoundEngine::SetScalingFactor</tt>.</summary>
- public const string setScalingFactor = "ak.soundengine.setScalingFactor";
- /// <summary>Sets the State of a State Group. See <tt>AK::SoundEngine::SetState</tt>.</summary>
- public const string setState = "ak.soundengine.setState";
- /// <summary>Sets the State of a Switch Group. See <tt>AK::SoundEngine::SetSwitch</tt>.</summary>
- public const string setSwitch = "ak.soundengine.setSwitch";
- /// <summary>Stop playing the current content associated to the specified game object ID. If no game object is specified, all sounds are stopped. See <tt>AK::SoundEngine::StopAll</tt>.</summary>
- public const string stopAll = "ak.soundengine.stopAll";
- /// <summary>Stops the current content, associated to the specified playing ID, from playing. See <tt>AK::SoundEngine::StopPlayingID</tt>.</summary>
- public const string stopPlayingID = "ak.soundengine.stopPlayingID";
- /// <summary>Unload a SoundBank. See <tt>AK::SoundEngine::UnloadBank</tt>.</summary>
- public const string unloadBank = "ak.soundengine.unloadBank";
- /// <summary>Unregisters 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 stops moving when the game object is unregistered, and there is no way to regain control over the game object. See <tt>AK::SoundEngine::UnregisterGameObj</tt>.</summary>
- public const string unregisterGameObj = "ak.soundengine.unregisterGameObj";
- }
- public class wwise
- {
- public class cli
- {
- /// <summary>Adds a new platform to a project. The platform must not already exist.</summary>
- public const string addNewPlatform = "ak.wwise.cli.addNewPlatform";
- /// <summary>External sources conversion. Converts the external sources files for the specified project. Optionally, additional WSOURCES can be specified. External Sources are a special type of source that you can put in a sound object in Wwise. It indicates that the real sound data will be provided at runtime. While external source conversion can be triggered by SoundBank generation, this operation can be used to process sources not contained in the Wwise Project. Refer to \ref integrating_external_sources.</summary>
- public const string convertExternalSource = "ak.wwise.cli.convertExternalSource";
- /// <summary>Creates a blank new project. The project must not already exist. If the directory does not exist, it is created.</summary>
- public const string createNewProject = "ak.wwise.cli.createNewProject";
- /// <summary>Dump the objects model of a project as a JSON file.</summary>
- public const string dumpObjects = "ak.wwise.cli.dumpObjects";
- /// <summary>Execute a Lua script. Optionally, specify additional Lua search paths, additional modules, and additional Lua scripts to load prior to the main script. The script can return a value. All arguments will be passed to the Lua script in the "wa_args" global variable.</summary>
- public const string executeLuaScript = "ak.wwise.cli.executeLuaScript";
- /// <summary>SoundBank generation. SoundBank generation is performed according to the settings stored in the project. User SoundBanks Settings are normally ignored when SoundBank generation is launched from the command line. However, when using the Source Control for generated SoundBanks, the User Project Settings are loaded for the Source Control settings. Also, some of these settings can be overridden from the command line.</summary>
- public const string generateSoundbank = "ak.wwise.cli.generateSoundbank";
- /// <summary>Migrates and saves the project.</summary>
- public const string migrate = "ak.wwise.cli.migrate";
- /// <summary>Moves the project's media IDs from its work units (.wwu) to a single file, <project-name>.mediaid. This command forces a save of all the project's work units.</summary>
- public const string moveMediaIdsToSingleFile = "ak.wwise.cli.moveMediaIdsToSingleFile";
- /// <summary>Moves the project's media IDs from a single xml file <project-name>.mediaid to its work units (.wwu). This command forces a save of all the project's work units.</summary>
- public const string moveMediaIdsToWorkUnits = "ak.wwise.cli.moveMediaIdsToWorkUnits";
- /// <summary>Imports a tab-delimited file to create and modify different object hierarchies. The project is automatically migrated (if required). It is also automatically saved following the import.</summary>
- public const string tabDelimitedImport = "ak.wwise.cli.tabDelimitedImport";
- /// <summary>Loads the project and updates the contents of <project-name>.mediaid, if it exists.</summary>
- public const string updateMediaIdsInSingleFile = "ak.wwise.cli.updateMediaIdsInSingleFile";
- /// <summary>Loads the project and does nothing else. This is useful to see the log for verification purposes without actually migrating and saving.</summary>
- public const string verify = "ak.wwise.cli.verify";
- /// <summary>Starts a command-line Wwise Authoring API server, to which client applications, using the Wwise Authoring API, can connect.</summary>
- public const string waapiServer = "ak.wwise.cli.waapiServer";
- }
- public class console
- {
- public class project
- {
- /// <summary>Closes the current project. This operation is synchronous.</summary>
- public const string close = "ak.wwise.console.project.close";
- /// <summary>Creates, saves and opens new empty project, specified by path and platform. The project has no factory setting WorkUnit. This operation is synchronous.</summary>
- public const string create = "ak.wwise.console.project.create";
- /// <summary>Opens a project, specified by path. This operation is synchronous.</summary>
- public const string open = "ak.wwise.console.project.open";
- }
- }
- public class core
- {
- public class audio
- {
- /// <summary>Creates Wwise objects and imports audio files. This function does not return an error when something fails during the import process, please refer to the log for the result of each import command. This function uses 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 \ref waapi_import.</summary>
- public const string import = "ak.wwise.core.audio.import";
- /// <summary>Scripted object creation and audio file import from a tab-delimited file.</summary>
- public const string importTabDelimited = "ak.wwise.core.audio.importTabDelimited";
- /// <summary>Sent at the end of an import operation.</summary>
- public const string imported = "ak.wwise.core.audio.imported";
- /// <summary>Mutes an object.</summary>
- public const string mute = "ak.wwise.core.audio.mute";
- /// <summary>Unmute all muted objects.</summary>
- public const string resetMute = "ak.wwise.core.audio.resetMute";
- /// <summary>Unsolo all soloed objects.</summary>
- public const string resetSolo = "ak.wwise.core.audio.resetSolo";
- /// <summary>Solos an object.</summary>
- public const string solo = "ak.wwise.core.audio.solo";
- }
- public class audioSourcePeaks
- {
- /// <summary>Gets the min/max peak pairs, in the 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, only one binary string represents the peaks across all channels globally.</summary>
- public const string getMinMaxPeaksInRegion = "ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInRegion";
- /// <summary>Gets 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 is only one binary string representing peaks across all channels globally.</summary>
- public const string getMinMaxPeaksInTrimmedRegion = "ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInTrimmedRegion";
- }
- /// <summary>Execute a Lua script. Optionally, specify additional Lua search paths, additional modules, and additional Lua scripts to load prior to the main script. The script can return a value. All arguments will be passed to the Lua script in the "wa_args" global variable.</summary>
- public const string executeLuaScript = "ak.wwise.core.executeLuaScript";
- /// <summary>Retrieve global Wwise information.</summary>
- public const string getInfo = "ak.wwise.core.getInfo";
- /// <summary>Retrieve information about the current project opened, including platforms, languages and project directories.</summary>
- public const string getProjectInfo = "ak.wwise.core.getProjectInfo";
- public class log
- {
- /// <summary>Adds a new item to the logs on the specified channel.</summary>
- public const string addItem = "ak.wwise.core.log.addItem";
- /// <summary>Clears the logs on the specified channel.</summary>
- public const string clear = "ak.wwise.core.log.clear";
- /// <summary>Retrieves the latest log for a specific channel. Refer to \ref ak_wwise_core_log_itemadded to be notified when an item is added to the log. The log is empty when used in WwiseConsole.</summary>
- public const string get = "ak.wwise.core.log.get";
- /// <summary>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 \ref ak_wwise_core_log_get.</summary>
- public const string itemAdded = "ak.wwise.core.log.itemAdded";
- }
- public class @object
- {
- /// <summary>Sent when an attenuation curve is changed.</summary>
- public const string attenuationCurveChanged = "ak.wwise.core.object.attenuationCurveChanged";
- /// <summary>Sent when an attenuation curve's link/unlink is changed.</summary>
- public const string attenuationCurveLinkChanged = "ak.wwise.core.object.attenuationCurveLinkChanged";
- /// <summary>Sent when an object is added as a child to another object.</summary>
- public const string childAdded = "ak.wwise.core.object.childAdded";
- /// <summary>Sent when an object is removed from the children of another object.</summary>
- public const string childRemoved = "ak.wwise.core.object.childRemoved";
- /// <summary>Copies an object to the given parent. Note that if a Work Unit is copied, the operation cannot be undone and the project will be saved.</summary>
- public const string copy = "ak.wwise.core.object.copy";
- /// <summary>Creates an object of type 'type', as a child of 'parent'. Refer to \ref waapi_import for more information about creating objects. Also refer to \ref ak_wwise_core_audio_import to import audio files to Wwise. To create Effect or Source plug-ins, use \ref ak_wwise_core_object_set, and refer to \ref wobjects_index for the classId.</summary>
- public const string create = "ak.wwise.core.object.create";
- /// <summary>Sent when an object is created.</summary>
- public const string created = "ak.wwise.core.object.created";
- /// <summary>Sent when one or many curves are changed.</summary>
- public const string curveChanged = "ak.wwise.core.object.curveChanged";
- /// <summary>Deletes the specified object. Note that if a Work Unit is deleted, the operation cannot be undone and the project will be saved.</summary>
- public const string delete = "ak.wwise.core.object.delete";
- /// <summary>Compares properties and lists of the source object with those in the target object.</summary>
- public const string diff = "ak.wwise.core.object.diff";
- /// <summary>Performs a query and returns the data, as specified in the options, for each object in the query result. The query can specify either a 'waql' argument or a 'from' argument with an optional 'transform' argument. Refer to \ref waql_introduction or \ref waapi_query for more information. Refer to \ref waapi_query_return to learn about options.</summary>
- public const string get = "ak.wwise.core.object.get";
- /// <summary>Gets the specified attenuation curve for a given attenuation object.</summary>
- public const string getAttenuationCurve = "ak.wwise.core.object.getAttenuationCurve";
- /// <summary>Retrieves the list of property and reference names for an object.</summary>
- public const string getPropertyAndReferenceNames = "ak.wwise.core.object.getPropertyAndReferenceNames";
- /// <summary>Retrieves information about an object property. Note that this function does not return the value of a property. To retrieve the value of a property, refer to \ref ak_wwise_core_object_get and \ref waapi_query_return.</summary>
- public const string getPropertyInfo = "ak.wwise.core.object.getPropertyInfo";
- /// <summary>Retrieves the list of property and reference names for an object.</summary>
- public const string getPropertyNames = "ak.wwise.core.object.getPropertyNames";
- /// <summary>Retrieves the list of all object types registered in Wwise's object model. This function returns the equivalent of \ref wobjects_index .</summary>
- public const string getTypes = "ak.wwise.core.object.getTypes";
- /// <summary>Indicates whether a property, reference, or object list is bound to a particular platform or to all platforms.</summary>
- public const string isLinked = "ak.wwise.core.object.isLinked";
- /// <summary>Returns true if a property is enabled based on the values of the properties it depends on.</summary>
- public const string isPropertyEnabled = "ak.wwise.core.object.isPropertyEnabled";
- /// <summary>Moves an object to the given parent. Returns the moved object.</summary>
- public const string move = "ak.wwise.core.object.move";
- /// <summary>Sent when an object is renamed. Publishes the renamed object.</summary>
- public const string nameChanged = "ak.wwise.core.object.nameChanged";
- /// <summary>Sent when the object's notes are changed.</summary>
- public const string notesChanged = "ak.wwise.core.object.notesChanged";
- /// <summary>Pastes properties, references and lists from one object to any number of target objects. Only those properties, references and lists which differ between source and target are pasted. Refer to \ref wobjects_index for more information on the properties, references and lists available on each object type.</summary>
- public const string pasteProperties = "ak.wwise.core.object.pasteProperties";
- /// <summary>Sent following an object's deletion.</summary>
- public const string postDeleted = "ak.wwise.core.object.postDeleted";
- /// <summary>Sent prior to an object's deletion.</summary>
- public const string preDeleted = "ak.wwise.core.object.preDeleted";
- /// <summary>Sent when the watched property of an object changes.</summary>
- public const string propertyChanged = "ak.wwise.core.object.propertyChanged";
- /// <summary>Sent when an object reference is changed.</summary>
- public const string referenceChanged = "ak.wwise.core.object.referenceChanged";
- /// <summary>Allows for batch processing of the following operations: Object creation in a child hierarchy, Object creation in a list, Setting name, notes, properties and references. Refer to \ref waapi_import for more information about creating objects. Also refer to \ref ak_wwise_core_audio_import to import audio files to Wwise.</summary>
- public const string set = "ak.wwise.core.object.set";
- /// <summary>Sets the specified attenuation curve for a given attenuation object.</summary>
- public const string setAttenuationCurve = "ak.wwise.core.object.setAttenuationCurve";
- /// <summary>Link or unlink a property/reference or object list to a particular platform.</summary>
- public const string setLinked = "ak.wwise.core.object.setLinked";
- /// <summary>Renames an object.</summary>
- public const string setName = "ak.wwise.core.object.setName";
- /// <summary>Sets the object's notes.</summary>
- public const string setNotes = "ak.wwise.core.object.setNotes";
- /// <summary>Sets a property value of an object for a specific platform. Refer to \ref wobjects_index for more information on the properties available on each object type. Refer to \ref ak_wwise_core_object_setreference to set a reference to an object. Refer to \ref ak_wwise_core_object_get to obtain the value of a property for an object.</summary>
- public const string setProperty = "ak.wwise.core.object.setProperty";
- /// <summary>Sets the randomizer values of a property of an object for a specific platform. Refer to \ref wobjects_index for more information on the properties available on each object type.</summary>
- public const string setRandomizer = "ak.wwise.core.object.setRandomizer";
- /// <summary>Sets an object's reference value. Refer to \ref wobjects_index for more information on the references available on each object type.</summary>
- public const string setReference = "ak.wwise.core.object.setReference";
- /// <summary>Sets the State Group objects associated with an object. Note, this will remove any previously associated State Group.</summary>
- public const string setStateGroups = "ak.wwise.core.object.setStateGroups";
- /// <summary>Set the state properties of an object. Note, this will remove any previous state property, including the default ones.</summary>
- public const string setStateProperties = "ak.wwise.core.object.setStateProperties";
- }
- public class plugin
- {
- /// <summary>Retrieves the list of all object types registered in Wwise's object model. This function returns the equivalent of \ref wobjects_index .</summary>
- public const string getList = "ak.wwise.core.plugin.getList";
- /// <summary>Retrieves the list of property and reference names for an object.</summary>
- public const string getProperties = "ak.wwise.core.plugin.getProperties";
- /// <summary>Retrieves information about an object property. Note that this function does not return the value of a property. To retrieve the value of a property, refer to \ref ak_wwise_core_object_get and \ref waapi_query_return.</summary>
- public const string getProperty = "ak.wwise.core.plugin.getProperty";
- }
- public class profiler
- {
- public class captureLog
- {
- /// <summary>Sent when a new entry is added to the capture log. Note that all entries are being sent. No filtering is applied as opposed to the Capture Log view.</summary>
- public const string itemAdded = "ak.wwise.core.profiler.captureLog.itemAdded";
- }
- /// <summary>Specifies the type of data you want to capture. Overrides the user's profiler settings.</summary>
- public const string enableProfilerData = "ak.wwise.core.profiler.enableProfilerData";
- /// <summary>Sent when a game object has been registered.</summary>
- public const string gameObjectRegistered = "ak.wwise.core.profiler.gameObjectRegistered";
- /// <summary>Sent when the game objects have been reset, such as closing a connection to a game while profiling.</summary>
- public const string gameObjectReset = "ak.wwise.core.profiler.gameObjectReset";
- /// <summary>Sent when a game object has been unregistered.</summary>
- public const string gameObjectUnregistered = "ak.wwise.core.profiler.gameObjectUnregistered";
- /// <summary>Retrieves the Audio Objects at a specific profiler capture time.</summary>
- public const string getAudioObjects = "ak.wwise.core.profiler.getAudioObjects";
- /// <summary>Retrieves the busses at a specific profiler capture time.</summary>
- public const string getBusses = "ak.wwise.core.profiler.getBusses";
- /// <summary>Retrieves CPU usage statistics at a specific profiler capture time. This data can also be found in the Advanced Profiler, under the CPU tab. To ensure the CPU data is received, refer to \ref ak_wwise_core_profiler_enableprofilerdata. The returned data includes "Inclusive" and "Exclusive" values, where "Inclusive" refers to the time spent in the element plus the time spent in any called elements, and "Exclusive" values pertain to execution only within the element itself.</summary>
- public const string getCpuUsage = "ak.wwise.core.profiler.getCpuUsage";
- /// <summary>Returns the current time of the specified profiler cursor, in milliseconds.</summary>
- public const string getCursorTime = "ak.wwise.core.profiler.getCursorTime";
- /// <summary>Retrieves the game objects at a specific profiler capture time.</summary>
- public const string getGameObjects = "ak.wwise.core.profiler.getGameObjects";
- /// <summary>Retrieves the loaded media at a specific profiler capture time. This data can also be found in the Advanced Profiler, under the Loaded Media tab. To ensure the Loaded Media data is received, refer to \ref ak_wwise_core_profiler_enableprofilerdata.</summary>
- public const string getLoadedMedia = "ak.wwise.core.profiler.getLoadedMedia";
- /// <summary>Retrieves the Performance Monitor statistics at a specific profiler capture time. Refer to \ref globalcountersids for the available counters.</summary>
- public const string getPerformanceMonitor = "ak.wwise.core.profiler.getPerformanceMonitor";
- /// <summary>Retrieves active RTPCs at a specific profiler capture time.</summary>
- public const string getRTPCs = "ak.wwise.core.profiler.getRTPCs";
- /// <summary>Retrieves the streaming media at a specific profiler capture time. This data can also be found in the Advanced Profiler, under the Streams tab. To ensure the Streams data is received, refer to \ref ak_wwise_core_profiler_enableprofilerdata.</summary>
- public const string getStreamedMedia = "ak.wwise.core.profiler.getStreamedMedia";
- /// <summary>Retrieves all parameters affecting voice volume, highpass and lowpass for a voice path, resolved from pipeline IDs.</summary>
- public const string getVoiceContributions = "ak.wwise.core.profiler.getVoiceContributions";
- /// <summary>Retrieves the voices at a specific profiler capture time.</summary>
- public const string getVoices = "ak.wwise.core.profiler.getVoices";
- /// <summary>Saves profiler as a .prof file according to the given file path.</summary>
- public const string saveCapture = "ak.wwise.core.profiler.saveCapture";
- /// <summary>Starts the profiler capture and returns the time at the beginning of the capture, in milliseconds.</summary>
- public const string startCapture = "ak.wwise.core.profiler.startCapture";
- /// <summary>Sent when a state group state has been changed. This subscription does not require the profiler capture log to be started.</summary>
- public const string stateChanged = "ak.wwise.core.profiler.stateChanged";
- /// <summary>Stops the profiler capture and returns the time at the end of the capture, in milliseconds.</summary>
- public const string stopCapture = "ak.wwise.core.profiler.stopCapture";
- /// <summary>Sent when a switch group state has been changed. This function does not require the profiler capture log to be started.</summary>
- public const string switchChanged = "ak.wwise.core.profiler.switchChanged";
- }
- public class project
- {
- /// <summary>Sent when the project has been successfully loaded.</summary>
- public const string loaded = "ak.wwise.core.project.loaded";
- /// <summary>Sent when the after the project is completely closed.</summary>
- public const string postClosed = "ak.wwise.core.project.postClosed";
- /// <summary>Sent when the project begins closing.</summary>
- public const string preClosed = "ak.wwise.core.project.preClosed";
- /// <summary>Saves the current project.</summary>
- public const string save = "ak.wwise.core.project.save";
- /// <summary>Sent when the project has been saved.</summary>
- public const string saved = "ak.wwise.core.project.saved";
- }
- public class remote
- {
- /// <summary>Connects the Wwise Authoring application to a Wwise Sound Engine running executable or to a saved profile file. The host must be running code with communication enabled. If only "host" is provided, Wwise connects to the first Sound Engine instance found. To distinguish between different instances, you can also provide the name of the application to connect to.</summary>
- public const string connect = "ak.wwise.core.remote.connect";
- /// <summary>Disconnects the Wwise Authoring application from a connected Wwise Sound Engine running executable.</summary>
- public const string disconnect = "ak.wwise.core.remote.disconnect";
- /// <summary>Retrieves all consoles available for connecting Wwise Authoring to a Sound Engine instance.</summary>
- public const string getAvailableConsoles = "ak.wwise.core.remote.getAvailableConsoles";
- /// <summary>Retrieves the connection status.</summary>
- public const string getConnectionStatus = "ak.wwise.core.remote.getConnectionStatus";
- }
- public class sound
- {
- /// <summary>Sets which version of the source is being used for the specified sound. Use \ref ak_wwise_core_object_get with the 'activeSource' return option to get the active source of a sound.</summary>
- public const string setActiveSource = "ak.wwise.core.sound.setActiveSource";
- }
- public class soundbank
- {
- /// <summary>Converts the external sources files for the project as detailed in the wsources file, and places them into either the default folder, or the folder specified by the output argument. External Sources are a special type of source that you can put in a Sound object in Wwise. It indicates that the real sound data will be provided at run time. While External Source conversion is also triggered by SoundBank generation, this operation can be used to process sources not contained in the Wwise Project. Please refer to Wwise SDK help page "Integrating External Sources".</summary>
- public const string convertExternalSources = "ak.wwise.core.soundbank.convertExternalSources";
- /// <summary>Generate a list of SoundBanks with the import definition specified in the WAAPI request. If you do not write the SoundBanks to disk, subscribe to \ref ak_wwise_core_soundbank_generated to receive SoundBank structure info and the bank data as base64. Note: This is a synchronous operation.</summary>
- public const string generate = "ak.wwise.core.soundbank.generate";
- /// <summary>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 \ref ak_wwise_core_soundbank_generate or \ref ak_wwise_ui_commands_execute with one of the SoundBank generation commands. Refer to \ref globalcommandsids for the list of commands.</summary>
- public const string generated = "ak.wwise.core.soundbank.generated";
- /// <summary>Sent when all SoundBanks are generated. Note: This notification is only sent when SoundBanks have been generated, it is not a reliable way to determine when \ref ak_wwise_core_soundbank_generate has completed.</summary>
- public const string generationDone = "ak.wwise.core.soundbank.generationDone";
- /// <summary>Retrieves a SoundBank's inclusion list.</summary>
- public const string getInclusions = "ak.wwise.core.soundbank.getInclusions";
- /// <summary>Imports SoundBank definitions from the specified file. Multiple files can be specified. See the WAAPI log for status messages.</summary>
- public const string processDefinitionFiles = "ak.wwise.core.soundbank.processDefinitionFiles";
- /// <summary>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.</summary>
- public const string setInclusions = "ak.wwise.core.soundbank.setInclusions";
- }
- public class sourceControl
- {
- /// <summary>Add files to source control. Equivalent to Mark for Add for Perforce.</summary>
- public const string add = "ak.wwise.core.sourceControl.add";
- /// <summary>Check out files from source control. Equivalent to Check Out for Perforce.</summary>
- public const string checkOut = "ak.wwise.core.sourceControl.checkOut";
- /// <summary>Commit files to source control. Equivalent to Submit Changes for Perforce.</summary>
- public const string commit = "ak.wwise.core.sourceControl.commit";
- /// <summary>Delete files from source control. Equivalent to Mark for Delete for Perforce.</summary>
- public const string delete = "ak.wwise.core.sourceControl.delete";
- /// <summary>Retrieve all original files.</summary>
- public const string getSourceFiles = "ak.wwise.core.sourceControl.getSourceFiles";
- /// <summary>Get the source control status of the specified files.</summary>
- public const string getStatus = "ak.wwise.core.sourceControl.getStatus";
- /// <summary>Move or rename files in source control. Always pass the same number of elements in files and newFiles. Equivalent to Move for Perforce.</summary>
- public const string move = "ak.wwise.core.sourceControl.move";
- /// <summary>Revert changes to files in source control.</summary>
- public const string revert = "ak.wwise.core.sourceControl.revert";
- /// <summary>Change the source control provider and credentials. This is the same setting as the Source Control option in the Project Settings dialog in Wwise.</summary>
- public const string setProvider = "ak.wwise.core.sourceControl.setProvider";
- }
- public class switchContainer
- {
- /// <summary>Assigns 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.</summary>
- public const string addAssignment = "ak.wwise.core.switchContainer.addAssignment";
- /// <summary>Sent when an assignment is added to a Switch Container.</summary>
- public const string assignmentAdded = "ak.wwise.core.switchContainer.assignmentAdded";
- /// <summary>Sent when an assignment is removed from a Switch Container.</summary>
- public const string assignmentRemoved = "ak.wwise.core.switchContainer.assignmentRemoved";
- /// <summary>Returns the list of assignments between a Switch Container's children and states.</summary>
- public const string getAssignments = "ak.wwise.core.switchContainer.getAssignments";
- /// <summary>Removes an assignment between a Switch Container's child and a State.</summary>
- public const string removeAssignment = "ak.wwise.core.switchContainer.removeAssignment";
- }
- public class transport
- {
- /// <summary>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.</summary>
- public const string create = "ak.wwise.core.transport.create";
- /// <summary>Destroys the given transport object.</summary>
- public const string destroy = "ak.wwise.core.transport.destroy";
- /// <summary>Executes an action on the given transport object, or all transport objects if none is specified.</summary>
- public const string executeAction = "ak.wwise.core.transport.executeAction";
- /// <summary>Returns the list of transport objects.</summary>
- public const string getList = "ak.wwise.core.transport.getList";
- /// <summary>Gets the state of the given transport object.</summary>
- public const string getState = "ak.wwise.core.transport.getState";
- /// <summary>Prepare the object and its dependencies for playback. Use this function before calling PostEventSync or PostMIDIOnEventSync from IAkGlobalPluginContext.</summary>
- public const string prepare = "ak.wwise.core.transport.prepare";
- /// <summary>Sent when the transport's state has changed.</summary>
- public const string stateChanged = "ak.wwise.core.transport.stateChanged";
- /// <summary>Sets the Original/Converted transport toggle globally. This allows playing the original or the converted sound files.</summary>
- public const string useOriginals = "ak.wwise.core.transport.useOriginals";
- }
- public class undo
- {
- /// <summary>Begins an undo group. Make sure to call \ref 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. When closing a WAMP session, a check is made to ensure that all undo groups are closed. If not, a cancelGroup is called for each of the groups still open.</summary>
- public const string beginGroup = "ak.wwise.core.undo.beginGroup";
- /// <summary>Cancels the last undo group.</summary>
- public const string cancelGroup = "ak.wwise.core.undo.cancelGroup";
- /// <summary>Ends the last undo group.</summary>
- public const string endGroup = "ak.wwise.core.undo.endGroup";
- /// <summary>Redoes the last operation in the Undo stack.</summary>
- public const string redo = "ak.wwise.core.undo.redo";
- /// <summary>Undoes the last operation in the Undo stack.</summary>
- public const string undo_ = "ak.wwise.core.undo.undo";
- }
- }
- public class debug
- {
- /// <summary>Sent when an assert has failed. This is only available in Debug builds.</summary>
- public const string assertFailed = "ak.wwise.debug.assertFailed";
- /// <summary>Enables debug assertions. Every call to enableAsserts with 'false' increments the ref count. Calling with true decrements the ref count. This is only available with Debug builds.</summary>
- public const string enableAsserts = "ak.wwise.debug.enableAsserts";
- /// <summary>Enables or disables 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.</summary>
- public const string enableAutomationMode = "ak.wwise.debug.enableAutomationMode";
- /// <summary>Generate a WAV file playing a tone with a simple envelope and save it to the specified location. This is provided as a utility to generate test WAV files.</summary>
- public const string generateToneWAV = "ak.wwise.debug.generateToneWAV";
- /// <summary>Retrieves the WAL tree, which describes the nodes that are synchronized in the Sound Engine. Private use only.</summary>
- public const string getWalTree = "ak.wwise.debug.getWalTree";
- /// <summary>Restart WAAPI servers. For internal use only.</summary>
- public const string restartWaapiServers = "ak.wwise.debug.restartWaapiServers";
- /// <summary>Private use only.</summary>
- public const string testAssert = "ak.wwise.debug.testAssert";
- /// <summary>Private use only.</summary>
- public const string testCrash = "ak.wwise.debug.testCrash";
- }
- public class ui
- {
- /// <summary>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.</summary>
- public const string bringToForeground = "ak.wwise.ui.bringToForeground";
- /// <summary>Captures a part of the Wwise UI relative to a view.</summary>
- public const string captureScreen = "ak.wwise.ui.captureScreen";
- public class commands
- {
- /// <summary>Executes a command. Some commands can take a list of objects as parameters. Refer to \ref globalcommandsids for the available commands.</summary>
- public const string execute = "ak.wwise.ui.commands.execute";
- /// <summary>Sent when a command is executed. The objects for which the command is executed are sent in the publication.</summary>
- public const string executed = "ak.wwise.ui.commands.executed";
- /// <summary>Gets the list of commands.</summary>
- public const string getCommands = "ak.wwise.ui.commands.getCommands";
- /// <summary>Registers an array of add-on commands. Registered commands remain until the Wwise process is terminated. Refer to \ref defining_custom_commands for more information about registering commands. Also refer to \ref ak_wwise_ui_commands_executed.</summary>
- public const string register = "ak.wwise.ui.commands.register";
- /// <summary>Unregisters an array of add-on UI commands.</summary>
- public const string unregister = "ak.wwise.ui.commands.unregister";
- }
- /// <summary>Retrieves the list of objects currently selected by the user in the active view.</summary>
- public const string getSelectedObjects = "ak.wwise.ui.getSelectedObjects";
- public class project
- {
- /// <summary>Closes the current project.</summary>
- public const string close = "ak.wwise.ui.project.close";
- /// <summary>Creates, saves and opens new empty project, specified by path and platform. The project has no factory setting WorkUnit. Please refer to \ref ak_wwise_core_project_loaded for further explanations on how to be notified when the operation has completed.</summary>
- public const string create = "ak.wwise.ui.project.create";
- /// <summary>Opens a project, specified by path. Please refer to \ref ak_wwise_core_project_loaded for further explanations on how to be notified when the operation has completed.</summary>
- public const string open = "ak.wwise.ui.project.open";
- }
- /// <summary>Sent when the selection changes in the project.</summary>
- public const string selectionChanged = "ak.wwise.ui.selectionChanged";
- }
- public class waapi
- {
- /// <summary>Retrieves the list of functions.</summary>
- public const string getFunctions = "ak.wwise.waapi.getFunctions";
- /// <summary>Retrieves the JSON schema of a Waapi URI.</summary>
- public const string getSchema = "ak.wwise.waapi.getSchema";
- /// <summary>Retrieves the list of topics to which a client can subscribe.</summary>
- public const string getTopics = "ak.wwise.waapi.getTopics";
- }
- }
- }
|