Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8
ak.wwise.core.soundbank.getInclusions

Retrieves a SoundBank's inclusion list.

Arguments

Name Type Description
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 or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
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

Result

Name Type Description
inclusions array An array of inclusions.
inclusions [...] object A SoundBank inclusion.
inclusions[...].object * string The ID (GUID) of the object to add to / remove from the SoundBank's inclusion list.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
inclusions[...].filter * array Specifies what relations are being included.
inclusions[...].filter [...] string Specifies one of the inclusion types. Possible values:
  • events
  • structures
  • media

Result Schema

See Also

Examples

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

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise