Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
object		The ID (GUID), name, or path of the object to watch.
classId	integer	The ID (class ID) of the object to retrieve the property and reference names from.

Required argument groups:

(object)
(classId)

Arguments Details

object

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

classId

description : The ID (class ID) of the object to retrieve the property and reference names from.
type : integer
minimum : 0
maximum : 4294967295

Result

Name	Type	Description
return	array

Result Details

return

type : array

resultSchema / return / ...

items

type : string
description : The name of the property or reference.

Examples :

Retrieving the list of property and reference names of an object.

Retrieves the list of property and reference names of an object.

Arguments:

{
    "classId": 8192003
}

Result:

{
    "return": [
        "DelayTime", 
        "DryLevel", 
        "FeedForwardLevel", 
        "FeedBackLevel", 
        "EnableLFO", 
        "ModDepth", 
        "ModFrequency", 
        "ModWaveform", 
        "ModSmoothing", 
        "ModPWM", 
        "ModPhaseOffset", 
        "ModPhaseMode", 
        "ModPhaseSpread", 
        "WetDryMix", 
        "OutputLevel", 
        "ProcessCenter", 
        "ProcessLFE"
    ]
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID), name, or path of the object to watch.", 
            "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": "^\\\\"
                }
            ]
        }, 
        "classId": {
            "description": "The ID (class ID) of the object to retrieve the property and reference names from.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 4294967295
        }
    }, 
    "oneOf": [
        {
            "required": [
                "object"
            ]
        }, 
        {
            "required": [
                "classId"
            ]
        }
    ], 
    "additionalProperties": false
}

Options :

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

Response :

{
    "type": "object", 
    "properties": {
        "return": {
            "type": "array", 
            "items": {
                "type": "string", 
                "description": "The name of the property or reference."
            }
        }
    }, 
    "additionalProperties": false
}

Document version : 1

이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요