Wwise SDK 2018.1.11

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.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
soundbank *		The ID (GUID), name, or path of the SoundBank to add an inclusion to.
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

(Required *)

Arguments Details

soundbank

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

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : 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.

2) 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}\}$

3) type : string
pattern : ^\

operation

type : string
Possible values : "add", "remove", "replace"
description : 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.

inclusions

type : array

argsSchema / inclusions / ...

items

type : object

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

(Required *)

argsSchema / inclusions / items / ...

object

description : The ID (GUID), name, or path of the object to add to / remove from the SoundBank's inclusion list.
Possibilities, one of the following :

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : 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.

2) 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}\}$

3) type : string
pattern : ^\

argsSchema / inclusions / items / ...

filter

type : array

argsSchema / inclusions / items / filter / ...

items

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

Examples :

Adding an object to the inclusion list

Adds an object to the SoundBank's inclusion list. The 'media' filter is left out.

Arguments:

{
    "soundbank": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "operation": "add", 
    "inclusions": [
        {
            "object": "{AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}", 
            "filter": [
                "events", 
                "structures"
            ]
        }
    ]
}

Result:

{}

Clearing the inclusion list

The SoundBank's inclusion list is cleared via the 'replace' operation and an empty 'inclusions' list.

Arguments:

{
    "soundbank": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "operation": "replace", 
    "inclusions": []
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "soundbank": {
            "description": "The ID (GUID), name, or path of the SoundBank to add an inclusion to.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$", 
                    "description": "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."
                }, 
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "operation": {
            "type": "string", 
            "enum": [
                "add", 
                "remove", 
                "replace"
            ], 
            "description": "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."
        }, 
        "inclusions": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "object": {
                        "description": "The ID (GUID), name, or path of the object to add to / remove from the SoundBank's inclusion list.", 
                        "anyOf": [
                            {
                                "type": "string", 
                                "pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$", 
                                "description": "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."
                            }, 
                            {
                                "type": "string", 
                                "pattern": *Must be a valid GUID*
                            }, 
                            {
                                "type": "string", 
                                "pattern": "^\\\\"
                            }
                        ]
                    }, 
                    "filter": {
                        "type": "array", 
                        "items": {
                            "type": "string", 
                            "enum": [
                                "events", 
                                "structures", 
                                "media"
                            ], 
                            "maxItems": 3
                        }
                    }
                }, 
                "required": [
                    "object", 
                    "filter"
                ], 
                "additionalProperties": false
            }
        }
    }, 
    "required": [
        "soundbank", 
        "inclusions", 
        "operation"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Response :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Document version : 1

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