Version

menu_open
Wwise SDK 2022.1.12
ak.wwise.core.object.propertyChanged Options Schema

Schema

{
"type": "object",
"properties": {
"object": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792"
},
{
"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}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"description": "A project path to a Wwise object, including the category and the work-unit. For example: \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\New Sound SFX."
}
],
"description": "The ID (GUID), name, or path of the object to watch."
},
"property": {
"type": "string",
"pattern": "^[:a-zA-Z0-9 _]+$",
"description": "The property of the watched object to watch.\\n A property name. Refer to \\ref wobjects_index for information about the Wwise objects and their properties."
},
"return": {
"type": "array",
"description": "Data to be returned for every change on \"property\" of \"object\". Refer to \\ref wobjects_index for more information on the properties available.\\n The array of return expressions defines which elements of the Wwise object is returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or the Pitch.",
"items": {
"description": "A return expression.",
"anyOf": [
{
"type": "string",
"description": "Specifies one or many of the built-in accessors for Wwise objects.",
"enum": [
"id",
"name",
"notes",
"type",
"pluginName",
"shortId",
"classId",
"category",
"filePath",
"workunit",
"parent",
"owner",
"path",
"isPlayable",
"childrenCount",
"totalSize",
"mediaSize",
"objectSize",
"structureSize",
"sound:convertedWemFilePath",
"sound:originalWavFilePath",
"soundbank:bnkFilePath",
"music:transitionRoot",
"music:playlistRoot",
"audioSource:playbackDuration",
"audioSource:maxDurationSource",
"audioSource:trimValues",
"audioSource:maxRadiusAttenuation",
"audioSource:language",
"workunit:isDefault",
"workunit:type",
"workunit:isDirty",
"switchContainerChild:context",
"convertedWemFilePath",
"originalFilePath",
"convertedFilePath",
"originalWavFilePath",
"soundbankBnkFilePath",
"musicTransitionRoot",
"musicPlaylistRoot",
"playbackDuration",
"duration",
"maxDurationSource",
"audioSourceTrimValues",
"maxRadiusAttenuation",
"audioSourceLanguage",
"workunitIsDefault",
"workunitType",
"workunitIsDirty",
"switchContainerChildContext",
"isExplicitMute",
"isExplicitSolo",
"isImplicitMute",
"isImplicitSolo",
"isIncluded",
"points"
]
},
{
"type": "string",
"description": "Specifies one or many dot-separated accessors that form a query and yields a value or an object reference. Specifying a single @ returns the value of the property for the associated object. Specifying a double @@ returns the value of the property for the source of override. Refer to \\ref wobjects_index .",
"pattern": "^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\\‍(.+\\‍))(\\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\\‍(.+\\‍))*$"
}
]
}
},
"platform": {
"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}\\}$",
"description": "The ID (GUID) of the platform.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
},
"required": [
"object",
"property"
],
"additionalProperties": false
}

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise