ak.wwise.core.soundbank.getInclusions

Retrieves a SoundBank's inclusion list.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
soundbank *		The ID (GUID) or path of the SoundBank to add an inclusion to.

(Required *)

description : The ID (GUID) or path of the SoundBank to add an inclusion to.
Possibilities, one of the following :

1) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

2) type : string
pattern : ^\

Result

Name	Type	Description
inclusions	array

Result Details

inclusions

type : array

resultSchema / inclusions / ...

items

type : object

Name	Type	Description
object *	string	The ID (GUID) of the object to add to / remove from the SoundBank's inclusion list.
filter *	array

(Required *)

resultSchema / inclusions / items / ...

object

description : The ID (GUID) of the object to add to / remove from the SoundBank's inclusion list.
type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

resultSchema / inclusions / items / ...

filter

type : array

resultSchema / inclusions / items / filter / ...

items

type : string
Possible values : "events", "structures", "media"
maxItems : 3

Examples :

Retrieving a SoundBank's inclusion list

Gets a SoundBank's inclusion list.

Arguments:

{
    "soundbank": "{A076AA65-B71A-45BB-8841-5A20C52CE727}"
}

Result:

{
    "inclusions": [
        {
            "object": "{1111AAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}", 
            "filter": [
                "events"
            ]
        }, 
        {
            "object": "{2222AAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}", 
            "filter": [
                "structures", 
                "media"
            ]
        }
    ]
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "soundbank": {
            "description": "The ID (GUID) or path of the SoundBank to add an inclusion to.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }
    }, 
    "required": [
        "soundbank"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}

Response :

{
    "type": "object", 
    "properties": {
        "inclusions": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "object": {
                        "description": "The ID (GUID) of the object to add to / remove from the SoundBank's inclusion list.", 
                        "type": "string", 
                        "pattern": *Must be a valid GUID*
                    }, 
                    "filter": {
                        "type": "array", 
                        "items": {
                            "type": "string", 
                            "enum": [
                                "events", 
                                "structures", 
                                "media"
                            ], 
                            "maxItems": 3
                        }
                    }
                }, 
                "required": [
                    "object", 
                    "filter"
                ], 
                "additionalProperties": false
            }
        }
    }, 
    "additionalProperties": false
}

Document version : 1

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.

Get started with Wwise

Wwise SDK 2017.2.10