Version

menu_open
Wwise SDK 2019.1.11
ak.wwise.core.soundbank.setInclusions

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.

Arguments

Name Type Description
operation * string Determines how the 'inclusions' argument is used to modify the SoundBank's inclusion list; 'inclusions' may be used to add to / remove from / replace the SoundBank's inclusion list.
Possible values:
  • add
  • remove
  • replace
inclusions * array An array of SoundBank inclusions.
inclusions [...] object A SoundBank inclusion.
inclusions[...].filter * array An array of inclusion types defining what to include.
inclusions[...].filter [...] string One of the possible inclusion types.
Possible values:
  • events
  • structures
  • media
inclusions[...].object * any of: The ID (GUID), name, or path of the object to add to / remove from the SoundBank's inclusion list.
string The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
soundbank * any of: The ID (GUID), name, or path of the SoundBank to add an inclusion to.
string The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.

(Required *)

Arguments Schema

See Also

Examples

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


Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise