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를 시작해 보세요