Wwise SDK 2018.1.11

Retrieves a 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.

(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 : ^\

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), 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": "^\\\\"
                }
            ]
        }
    }, 
    "required": [
        "soundbank"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "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

此页面对您是否有帮助？

需要技术支持？

仍有疑问？或者问题？需要更多信息？欢迎联系我们，我们可以提供帮助！

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目，我们帮您快速入门，不带任何附加条件！

开始 Wwise 之旅

Wwise SDK 2018.1.11

ak.wwise.core.soundbank.getInclusions

Supported by

Arguments

Arguments Details

soundbank

Result

Result Details

inclusions

items

object

filter

items

Examples :

Retrieving a SoundBank's inclusion list

Arguments:

Result:

Detailed JSON Schema

Arguments :

Options :

Response :

此页面对您是否有帮助？

需要技术支持？

介绍一下自己的项目。我们会竭力为您提供帮助。