バージョン

menu_open

(Deprecated) ak.wwise.core.plugin.getProperties


Retrieves the list of property names for an object.

Deprecated in favor of ak.wwise.core.object.getPropertyNames

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
object   The ID (GUID) or path of the object to watch.
classId integer The ID (class ID) of the object to retrieve the properties from.

Required argument groups:

Arguments Details


object

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

classId

description : The ID (class ID) of the object to retrieve the properties 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.


Examples :

Retrieving the list of properties of an object.

Retrieves the list of properties 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) or path of the object to watch.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "classId": {
            "description": "The ID (class ID) of the object to retrieve the properties from.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 4294967295
        }
    }, 
    "oneOf": [
        {
            "required": [
                "object"
            ]
        }, 
        {
            "required": [
                "classId"
            ]
        }
    ], 
    "additionalProperties": false
}


Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

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

Document version : 1


このページはお役に立ちましたか?

サポートは必要ですか?

ご質問や問題、ご不明点はございますか?お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう