waapi.ts 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. /*
  2. The content of this file includes portions of the AUDIOKINETIC Wwise Technology
  3. released in source code form as part of the SDK installer package.
  4. Commercial License Usage
  5. Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
  6. may use this file in accordance with the end user license agreement provided
  7. with the software or, alternatively, in accordance with the terms contained in a
  8. written agreement between you and Audiokinetic Inc.
  9. Apache License Usage
  10. Alternatively, this file may be used under the Apache License, Version 2.0 (the
  11. "Apache License"); you may not use this file except in compliance with the
  12. Apache License. You may obtain a copy of the Apache License at
  13. http://www.apache.org/licenses/LICENSE-2.0.
  14. Unless required by applicable law or agreed to in writing, software distributed
  15. under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
  16. OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
  17. the specific language governing permissions and limitations under the License.
  18. Copyright (c) 2023 Audiokinetic Inc.
  19. */
  20. export const ak = {
  21. wwise: {
  22. core: {
  23. /** Retrieve global Wwise information. */
  24. getInfo: "ak.wwise.core.getInfo",
  25. /** Retrieve information about the current project opened, including platforms, languages and project directories. */
  26. getProjectInfo: "ak.wwise.core.getProjectInfo",
  27. project: {
  28. /** Saves the current project. */
  29. save: "ak.wwise.core.project.save",
  30. /** Sent when the project has been successfully loaded. */
  31. loaded: "ak.wwise.core.project.loaded",
  32. /** Sent when the project begins closing. */
  33. preClosed: "ak.wwise.core.project.preClosed",
  34. /** Sent when the after the project is completely closed. */
  35. postClosed: "ak.wwise.core.project.postClosed",
  36. /** Sent when the project has been saved. */
  37. saved: "ak.wwise.core.project.saved"
  38. },
  39. object: {
  40. /** Renames an object. */
  41. setName: "ak.wwise.core.object.setName",
  42. /** Sets an object's reference value. Refer to \ref wobjects_index for more information on the references available on each object type. */
  43. setReference: "ak.wwise.core.object.setReference",
  44. /** 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. */
  45. setProperty: "ak.wwise.core.object.setProperty",
  46. /** 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. */
  47. setRandomizer: "ak.wwise.core.object.setRandomizer",
  48. /** Sets the object's notes. */
  49. setNotes: "ak.wwise.core.object.setNotes",
  50. /** Gets the specified attenuation curve for a given attenuation object. */
  51. getAttenuationCurve: "ak.wwise.core.object.getAttenuationCurve",
  52. /** Sets the specified attenuation curve for a given attenuation object. */
  53. setAttenuationCurve: "ak.wwise.core.object.setAttenuationCurve",
  54. /** 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. */
  55. create: "ak.wwise.core.object.create",
  56. /** 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. */
  57. set: "ak.wwise.core.object.set",
  58. /** Moves an object to the given parent. Returns the moved object. */
  59. move: "ak.wwise.core.object.move",
  60. /** Copies an object to the given parent. */
  61. copy: "ak.wwise.core.object.copy",
  62. /** Deletes the specified object. */
  63. delete_: "ak.wwise.core.object.delete",
  64. /** Deletes the specified object. */
  65. delete: "ak.wwise.core.object.delete",
  66. /** 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. */
  67. get: "ak.wwise.core.object.get",
  68. /** Compares properties and lists of the source object with those in the target object. */
  69. diff: "ak.wwise.core.object.diff",
  70. /** 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. */
  71. pasteProperties: "ak.wwise.core.object.pasteProperties",
  72. /** Retrieves the list of all object types registered in Wwise's object model. This function returns the equivalent of \ref wobjects_index . */
  73. getTypes: "ak.wwise.core.object.getTypes",
  74. /** 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. */
  75. getPropertyInfo: "ak.wwise.core.object.getPropertyInfo",
  76. /**
  77. * Retrieves the list of property and reference names for an object.
  78. * \deprecated in favor of ak.wwise.core.object.getPropertyAndReferenceNames
  79. */
  80. getPropertyNames: "ak.wwise.core.object.getPropertyNames",
  81. /** Retrieves the list of property and reference names for an object. */
  82. getPropertyAndReferenceNames: "ak.wwise.core.object.getPropertyAndReferenceNames",
  83. /** Returns true if a property is enabled based on the values of the properties it depends on. */
  84. isPropertyEnabled: "ak.wwise.core.object.isPropertyEnabled",
  85. /** Sent when an object reference is changed. */
  86. referenceChanged: "ak.wwise.core.object.referenceChanged",
  87. /** Sent when an object is renamed. Publishes the renamed object. */
  88. nameChanged: "ak.wwise.core.object.nameChanged",
  89. /** Sent when the object's notes are changed. */
  90. notesChanged: "ak.wwise.core.object.notesChanged",
  91. /** Sent when an object is created. */
  92. created: "ak.wwise.core.object.created",
  93. /** Sent prior to an object's deletion. */
  94. preDeleted: "ak.wwise.core.object.preDeleted",
  95. /** Sent following an object's deletion. */
  96. postDeleted: "ak.wwise.core.object.postDeleted",
  97. /** Sent when an object is added as a child to another object. */
  98. childAdded: "ak.wwise.core.object.childAdded",
  99. /** Sent when an object is removed from the children of another object. */
  100. childRemoved: "ak.wwise.core.object.childRemoved",
  101. /** Sent when one or many curves are changed. */
  102. curveChanged: "ak.wwise.core.object.curveChanged",
  103. /** Sent when an attenuation curve is changed. */
  104. attenuationCurveChanged: "ak.wwise.core.object.attenuationCurveChanged",
  105. /** Sent when an attenuation curve's link/unlink is changed. */
  106. attenuationCurveLinkChanged: "ak.wwise.core.object.attenuationCurveLinkChanged",
  107. /** Sent when the watched property of an object changes. */
  108. propertyChanged: "ak.wwise.core.object.propertyChanged"
  109. },
  110. switchContainer: {
  111. /** 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. */
  112. addAssignment: "ak.wwise.core.switchContainer.addAssignment",
  113. /** Removes an assignment between a Switch Container's child and a State. */
  114. removeAssignment: "ak.wwise.core.switchContainer.removeAssignment",
  115. /** Returns the list of assignments between a Switch Container's children and states. */
  116. getAssignments: "ak.wwise.core.switchContainer.getAssignments",
  117. /** Sent when an assignment is added to a Switch Container. */
  118. assignmentAdded: "ak.wwise.core.switchContainer.assignmentAdded",
  119. /** Sent when an assignment is removed from a Switch Container. */
  120. assignmentRemoved: "ak.wwise.core.switchContainer.assignmentRemoved"
  121. },
  122. audio: {
  123. /** Creates Wwise objects and imports audio files. 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. */
  124. import_: "ak.wwise.core.audio.import",
  125. /** Creates Wwise objects and imports audio files. 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. */
  126. import: "ak.wwise.core.audio.import",
  127. /** Scripted object creation and audio file import from a tab-delimited file. */
  128. importTabDelimited: "ak.wwise.core.audio.importTabDelimited",
  129. /** Sent at the end of an import operation. */
  130. imported: "ak.wwise.core.audio.imported"
  131. },
  132. remote: {
  133. /** 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 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. */
  134. connect: "ak.wwise.core.remote.connect",
  135. /** Disconnects the Wwise Authoring application from a connected Wwise Sound Engine running executable. */
  136. disconnect: "ak.wwise.core.remote.disconnect",
  137. /** Retrieves all consoles available for connecting Wwise Authoring to a Sound Engine instance. */
  138. getAvailableConsoles: "ak.wwise.core.remote.getAvailableConsoles",
  139. /** Retrieves the connection status. */
  140. getConnectionStatus: "ak.wwise.core.remote.getConnectionStatus"
  141. },
  142. undo: {
  143. /** 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. */
  144. beginGroup: "ak.wwise.core.undo.beginGroup",
  145. /** Cancels the last undo group. Please note that this does not revert the operations made since the last \ref ak_wwise_core_undo_begingroup call. */
  146. cancelGroup: "ak.wwise.core.undo.cancelGroup",
  147. /** Ends the last undo group. */
  148. endGroup: "ak.wwise.core.undo.endGroup",
  149. /** Undoes the last operation in the Undo stack. */
  150. undo: "ak.wwise.core.undo.undo"
  151. },
  152. plugin: {
  153. /**
  154. * Retrieves the list of all object types registered in Wwise's object model. This function returns the equivalent of \ref wobjects_index .
  155. * \deprecated in favor of ak.wwise.core.object.getTypes
  156. */
  157. getList: "ak.wwise.core.plugin.getList",
  158. /**
  159. * 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.
  160. * \deprecated in favor of ak.wwise.core.object.getPropertyInfo
  161. */
  162. getProperty: "ak.wwise.core.plugin.getProperty",
  163. /**
  164. * Retrieves the list of property and reference names for an object.
  165. * \deprecated in favor of ak.wwise.core.object.getPropertyAndReferenceNames
  166. */
  167. getProperties: "ak.wwise.core.plugin.getProperties"
  168. },
  169. soundbank: {
  170. /** Retrieves a SoundBank's inclusion list. */
  171. getInclusions: "ak.wwise.core.soundbank.getInclusions",
  172. /** 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. */
  173. setInclusions: "ak.wwise.core.soundbank.setInclusions",
  174. /** Generate a list of SoundBank with import definition defined in the WAAPI request. If you choose to not write the SoundBanks to disk, subscribe to \ref ak_wwise_core_soundbank_generated to get SoundBank structure info and the bank data as base64. */
  175. generate: "ak.wwise.core.soundbank.generate",
  176. /** Imports SoundBank definitions from the specified file. Multiple files can be specified. See the WAAPI log for status messages. */
  177. processDefinitionFiles: "ak.wwise.core.soundbank.processDefinitionFiles",
  178. /** 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". */
  179. convertExternalSources: "ak.wwise.core.soundbank.convertExternalSources",
  180. /** 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. */
  181. generated: "ak.wwise.core.soundbank.generated",
  182. /** Sent when all SoundBanks are generated. */
  183. generationDone: "ak.wwise.core.soundbank.generationDone"
  184. },
  185. sound: {
  186. /** 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. */
  187. setActiveSource: "ak.wwise.core.sound.setActiveSource"
  188. },
  189. log: {
  190. /** Retrieves the latest log for a specific channel. Refer to \ref ak_wwise_core_log_itemadded to be notified when a item is added to the log. */
  191. get: "ak.wwise.core.log.get",
  192. /** 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. */
  193. itemAdded: "ak.wwise.core.log.itemAdded"
  194. },
  195. transport: {
  196. /** 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. */
  197. create: "ak.wwise.core.transport.create",
  198. /** Prepare the object and its dependencies for playback. Use this function before calling PostEventSync or PostMIDIOnEventSync from IAkGlobalPluginContext. */
  199. prepare: "ak.wwise.core.transport.prepare",
  200. /** Destroys the given transport object. */
  201. destroy: "ak.wwise.core.transport.destroy",
  202. /** Gets the state of the given transport object. */
  203. getState: "ak.wwise.core.transport.getState",
  204. /** Returns the list of transport objects. */
  205. getList: "ak.wwise.core.transport.getList",
  206. /** Executes an action on the given transport object, or all transport objects if none is specified. */
  207. executeAction: "ak.wwise.core.transport.executeAction",
  208. /** Sent when the transport's state has changed. */
  209. stateChanged: "ak.wwise.core.transport.stateChanged"
  210. },
  211. audioSourcePeaks: {
  212. /** 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. */
  213. getMinMaxPeaksInRegion: "ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInRegion",
  214. /** 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. */
  215. getMinMaxPeaksInTrimmedRegion: "ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInTrimmedRegion"
  216. },
  217. profiler: {
  218. /** Retrieves the Audio Objects at a specific profiler capture time. */
  219. getAudioObjects: "ak.wwise.core.profiler.getAudioObjects",
  220. /** Retrieves the game objects at a specific profiler capture time. */
  221. getGameObjects: "ak.wwise.core.profiler.getGameObjects",
  222. /** Retrieves the voices at a specific profiler capture time. */
  223. getVoices: "ak.wwise.core.profiler.getVoices",
  224. /** Retrieves active RTPCs at a specific profiler capture time. */
  225. getRTPCs: "ak.wwise.core.profiler.getRTPCs",
  226. /** Retrieves the busses at a specific profiler capture time. */
  227. getBusses: "ak.wwise.core.profiler.getBusses",
  228. /** Retrieves all parameters affecting voice volume, highpass and lowpass for a voice path, resolved from pipeline IDs. */
  229. getVoiceContributions: "ak.wwise.core.profiler.getVoiceContributions",
  230. /** Specifies the type of data you want to capture. Overrides the user's profiler settings. */
  231. enableProfilerData: "ak.wwise.core.profiler.enableProfilerData",
  232. /** Returns the current time of the specified profiler cursor, in milliseconds. */
  233. getCursorTime: "ak.wwise.core.profiler.getCursorTime",
  234. /** Starts the profiler capture and returns the time at the beginning of the capture, in milliseconds. */
  235. startCapture: "ak.wwise.core.profiler.startCapture",
  236. /** Stops the profiler capture and returns the time at the end of the capture, in milliseconds. */
  237. stopCapture: "ak.wwise.core.profiler.stopCapture",
  238. captureLog: {
  239. /** 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. */
  240. itemAdded: "ak.wwise.core.profiler.captureLog.itemAdded"
  241. },
  242. /** Sent when a game object has been registered. */
  243. gameObjectRegistered: "ak.wwise.core.profiler.gameObjectRegistered",
  244. /** Sent when a game object has been unregistered. */
  245. gameObjectUnregistered: "ak.wwise.core.profiler.gameObjectUnregistered",
  246. /** Sent when the game objects have been reset, such as closing a connection to a game while profiling. */
  247. gameObjectReset: "ak.wwise.core.profiler.gameObjectReset",
  248. /** Sent when a state group state has been changed. This subscription does not require the profiler capture log to be started. */
  249. stateChanged: "ak.wwise.core.profiler.stateChanged",
  250. /** Sent when a switch group state has been changed. This function does not require the profiler capture log to be started. */
  251. switchChanged: "ak.wwise.core.profiler.switchChanged"
  252. }
  253. },
  254. ui: {
  255. /** 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. */
  256. bringToForeground: "ak.wwise.ui.bringToForeground",
  257. project: {
  258. /** 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. */
  259. open: "ak.wwise.ui.project.open",
  260. /** Closes the current project. */
  261. close: "ak.wwise.ui.project.close"
  262. },
  263. commands: {
  264. /** Executes a command. Some commands can take a list of objects as parameters. Refer to \ref globalcommandsids for the available commands. */
  265. execute: "ak.wwise.ui.commands.execute",
  266. /** Gets the list of commands. */
  267. getCommands: "ak.wwise.ui.commands.getCommands",
  268. /** 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. */
  269. register: "ak.wwise.ui.commands.register",
  270. /** Unregisters an array of add-on UI commands. */
  271. unregister: "ak.wwise.ui.commands.unregister",
  272. /** Sent when a command is executed. The objects for which the command is executed are sent in the publication. */
  273. executed: "ak.wwise.ui.commands.executed"
  274. },
  275. /** Retrieves the list of objects currently selected by the user in the active view. */
  276. getSelectedObjects: "ak.wwise.ui.getSelectedObjects",
  277. /** Captures a part of the Wwise UI relative to a view. */
  278. captureScreen: "ak.wwise.ui.captureScreen",
  279. /** Sent when the selection changes in the project. */
  280. selectionChanged: "ak.wwise.ui.selectionChanged"
  281. },
  282. waapi: {
  283. /** Retrieves the list of topics to which a client can subscribe. */
  284. getTopics: "ak.wwise.waapi.getTopics",
  285. /** Retrieves the list of functions. */
  286. getFunctions: "ak.wwise.waapi.getFunctions",
  287. /** Retrieves the JSON schema of a Waapi URI. */
  288. getSchema: "ak.wwise.waapi.getSchema"
  289. },
  290. debug: {
  291. /** 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. */
  292. enableAsserts: "ak.wwise.debug.enableAsserts",
  293. /** Private use only. */
  294. testAssert: "ak.wwise.debug.testAssert",
  295. /** Private use only. */
  296. testCrash: "ak.wwise.debug.testCrash",
  297. /** 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. */
  298. enableAutomationMode: "ak.wwise.debug.enableAutomationMode",
  299. /** Sent when an assert has failed. This is only available in Debug builds. */
  300. assertFailed: "ak.wwise.debug.assertFailed"
  301. },
  302. cli: {
  303. /** Migrate and save the project. */
  304. migrate: "ak.wwise.cli.migrate",
  305. /** Load the project and do nothing else. This is useful to see the log for verification purposes without actually migrating and saving. */
  306. verify: "ak.wwise.cli.verify",
  307. /** 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. */
  308. tabDelimitedImport: "ak.wwise.cli.tabDelimitedImport",
  309. /** Starts a command-line Wwise Authoring API server, to which client applications, using the Wwise Authoring API, can connect. */
  310. waapiServer: "ak.wwise.cli.waapiServer",
  311. /** Creates a blank new project. The project must not already exist. If the folder does not exist, it is created. */
  312. createNewProject: "ak.wwise.cli.createNewProject",
  313. /** Dump the objects model of a project as a JSON file. */
  314. dumpObjects: "ak.wwise.cli.dumpObjects",
  315. /** Adds a new platform to a project. The platform must not already exist. */
  316. addNewPlatform: "ak.wwise.cli.addNewPlatform",
  317. /** 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 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 \ref integrating_external_sources. */
  318. convertExternalSource: "ak.wwise.cli.convertExternalSource",
  319. /** 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 will be loaded for the Source Control settings. Also, some of these settings can be overridden from the command line. */
  320. generateSoundbank: "ak.wwise.cli.generateSoundbank",
  321. /** Moves the project's media IDs from its work units (.wwu) to a single file, <project-name>.mediaid. This command will force a save of all the project's work units. */
  322. moveMediaIdsToSingleFile: "ak.wwise.cli.moveMediaIdsToSingleFile",
  323. /** Moves the project's media IDs from a single xml file <project-name>.mediaid to its work units (.wwu). This command will force a save of all the project's work units. */
  324. moveMediaIdsToWorkUnits: "ak.wwise.cli.moveMediaIdsToWorkUnits",
  325. /** Loads the project and updates the contents of <project-name>.mediaid, if it exists. */
  326. updateMediaIdsInSingleFile: "ak.wwise.cli.updateMediaIdsInSingleFile"
  327. }
  328. },
  329. soundengine: {
  330. /** Asynchronously post an Event to the sound engine (by event ID). See <tt>AK::SoundEngine::PostEvent</tt>. */
  331. postEvent: "ak.soundengine.postEvent",
  332. /** Executes an action on all nodes that are referenced in the specified event in a Play action. See <tt>AK::SoundEngine::ExecuteActionOnEvent</tt>. */
  333. executeActionOnEvent: "ak.soundengine.executeActionOnEvent",
  334. /** 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>. */
  335. registerGameObj: "ak.soundengine.registerGameObj",
  336. /** Stops the current content, associated to the specified playing ID, from playing. See <tt>AK::SoundEngine::StopPlayingID</tt>. */
  337. stopPlayingID: "ak.soundengine.stopPlayingID",
  338. /** 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>. */
  339. stopAll: "ak.soundengine.stopAll",
  340. /** Display a message in the Profiler's Capture Log view. */
  341. postMsgMonitor: "ak.soundengine.postMsgMonitor",
  342. /** 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>. */
  343. setObjectObstructionAndOcclusion: "ak.soundengine.setObjectObstructionAndOcclusion",
  344. /** Set the output bus volume (direct) to be used for the specified game object. See <tt>AK::SoundEngine::SetGameObjectOutputBusVolume</tt>. */
  345. setGameObjectOutputBusVolume: "ak.soundengine.setGameObjectOutputBusVolume",
  346. /** Sets the Auxiliary Busses to route the specified game object. See <tt>AK::SoundEngine::SetGameObjectAuxSendValues</tt>. */
  347. setGameObjectAuxSendValues: "ak.soundengine.setGameObjectAuxSendValues",
  348. /** Posts the specified Trigger. See <tt>AK::SoundEngine::PostTrigger</tt>. */
  349. postTrigger: "ak.soundengine.postTrigger",
  350. /** Sets the State of a Switch Group. See <tt>AK::SoundEngine::SetSwitch</tt>. */
  351. setSwitch: "ak.soundengine.setSwitch",
  352. /** Gets the current state of a Switch Group for a given Game Object. */
  353. getSwitch: "ak.soundengine.getSwitch",
  354. /** Sets the State of a State Group. See <tt>AK::SoundEngine::SetState</tt>. */
  355. setState: "ak.soundengine.setState",
  356. /** 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. */
  357. getState: "ak.soundengine.getState",
  358. /** 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>. */
  359. resetRTPCValue: "ak.soundengine.resetRTPCValue",
  360. /** Sets the value of a real-time parameter control. See <tt>AK::SoundEngine::SetRTPCValue</tt>. */
  361. setRTPCValue: "ak.soundengine.setRTPCValue",
  362. /** Sets a listener's spatialization parameters. This lets you define listener-specific volume offsets for each audio channel. See <tt>AK::SoundEngine::SetListenerSpatialization</tt>. */
  363. setListenerSpatialization: "ak.soundengine.setListenerSpatialization",
  364. /** 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>. */
  365. setMultiplePositions: "ak.soundengine.setMultiplePositions",
  366. /** Sets the position of a game object. See <tt>AK::SoundEngine::SetPosition</tt>. */
  367. setPosition: "ak.soundengine.setPosition",
  368. /** 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>. */
  369. setScalingFactor: "ak.soundengine.setScalingFactor",
  370. /** Sets the default active listeners for all subsequent game objects that are registered. See <tt>AK::SoundEngine::SetDefaultListeners</tt>. */
  371. setDefaultListeners: "ak.soundengine.setDefaultListeners",
  372. /** 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>. */
  373. setListeners: "ak.soundengine.setListeners",
  374. /** Seeks inside all playing objects that are referenced in Play Actions of the specified Event. See <tt>AK::SoundEngine::SeekOnEvent</tt>. */
  375. seekOnEvent: "ak.soundengine.seekOnEvent",
  376. /** 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>. */
  377. unregisterGameObj: "ak.soundengine.unregisterGameObj"
  378. }
  379. }