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.
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| soundbank * | The ID (GUID) 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 *)
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 : ^\
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.
type : array
argsSchema / inclusions / ...
type : object
| Name | Type | Description |
|---|---|---|
| object * | The ID (GUID) or path of the object to add to / remove from the SoundBank's inclusion list. | |
| filter * | array |
(Required *)
argsSchema / inclusions / items / ...
description : The ID (GUID) or path of the object to add to / remove from the SoundBank's inclusion list.
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 : ^\
argsSchema / inclusions / items / ...
type : array
argsSchema / inclusions / items / filter / ...
type : string
Possible values : "events", "structures", "media"
maxItems : 3
Adds an object to the SoundBank's inclusion list. The 'media' filter is left out.
{
"soundbank": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"operation": "add",
"inclusions": [
{
"object": "{AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}",
"filter": [
"events",
"structures"
]
}
]
}
{}
The SoundBank's inclusion list is cleared via the 'replace' operation and an empty 'inclusions' list.
{
"soundbank": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"operation": "replace",
"inclusions": []
}
{}
{
"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": "^\\\\"
}
]
},
"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) or path of the object to add to / remove from the SoundBank's inclusion list.",
"anyOf": [
{
"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
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Document version : 1
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise