Wwise SDK 2018.1.11

Returns the list of assignments between a Switch Container's children and states.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
id *		The ID (GUID), name, or path of the Switch Container.

(Required *)

Arguments Details

id

description : The ID (GUID), name, or path of the Switch Container.
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
return		List of assignments (pairs of child and state).

Result Details

return

description : List of assignments (pairs of child and state).
Possible types : or object

resultSchema / return / ...

child

description : The ID (GUID), name, or path of the child assigned to a State.
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 : ^\

resultSchema / return / ...

stateOrSwitch

description : The ID (GUID), name, or path of the State or Switch to which the child is assigned.
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 : ^\

Examples :

Assignments of a Switch Container.

Get the list of assignments for a Switch Container.

Arguments:

{
    "id": "{7A12D08F-B0D9-4403-9EFA-2E6338C197C1}"
}

Result:

{
    "return": [
        {
            "child": "{7A12D08F-B0D9-4403-9EFA-2E6338C197C1}", 
            "stateOrSwitch": "{A076AA65-B71A-45BB-8841-5A20C52CE727}"
        }, 
        {
            "child": "{8B12D08F-B0D9-4403-9EFA-2E6338C197D1}", 
            "stateOrSwitch": "{B076BB65-B71A-45BB-8841-5A20C52CE738}"
        }
    ]
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "id": {
            "description": "The ID (GUID), name, or path of the Switch Container.", 
            "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": [
        "id"
    ], 
    "additionalProperties": false
}

Options :

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

Response :

{
    "type": "object", 
    "properties": {
        "return": {
            "description": "List of assignments (pairs of child and state).", 
            "items": [
                {
                    "type": "object", 
                    "properties": {
                        "child": {
                            "description": "The ID (GUID), name, or path of the child assigned to a State.", 
                            "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": "^\\\\"
                                }
                            ]
                        }, 
                        "stateOrSwitch": {
                            "description": "The ID (GUID), name, or path of the State or Switch to which the child is assigned.", 
                            "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": [
                        "child", 
                        "stateOrSwitch"
                    ], 
                    "additionalProperties": false
                }
            ]
        }
    }
}

Document version : 1

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅