Retrieves a SoundBank's inclusion list.
(Required *)
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| soundbank * | The ID (GUID) or path of the SoundBank to add an inclusion to. |
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 : ^\
| Name | Type | Description |
|---|---|---|
| inclusions | array |
type : array
resultSchema / inclusions / ...
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 |
resultSchema / inclusions / items / ...
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 / ...
type : array
resultSchema / inclusions / items / filter / ...
type : string
Possible values : "events", "structures", "media"
maxItems : 3
Gets a SoundBank's inclusion list.
{
"soundbank": "{A076AA65-B71A-45BB-8841-5A20C52CE727}"
}
{
"inclusions": [
{
"object": "{1111AAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}",
"filter": [
"events"
]
},
{
"object": "{2222AAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}",
"filter": [
"structures",
"media"
]
}
]
}
{
"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
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"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
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