Version

    Other Documentation

menu_open
Wwise SDK 2022.1.9
ak.wwise.core.object.getPropertyInfo

Retrieves information about an object property. Note that this function does not return the value of a property. To retrieve the value of a property, refer to ak.wwise.core.object.get and Return Options.

Arguments

Name Type Description
object any of: The ID (GUID), name, or path of the object to watch.
string 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
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string 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.
classId integer The ID (class ID) of the object to retrieve the property from.
Unsigned Integer 32-bit. Range: [0,4294967295]
property string The name of the property to retrieve. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference .
A property name. Refer to Wwise Objects Reference for information about the Wwise objects and their properties.

Arguments Schema

Result

Name Type Description
name string The name of the property.
type string The type of the property. For more information, refer to the property list of Wwise Objects found in Wwise Objects Reference .
audioEngineId integer The ID (audio engine ID) of the property.
Unsigned Integer 32-bit. Range: [0,4294967295]
default any of: The default value of the property.
The value of a property.
null A null value. No reference to an object.
string A string value.
number A numerical value.
boolean A boolean value.
supports object The features supported by the property.
supports.rtpc string The RTPC mode that is supported by the property. Possible values:
  • None
  • Additive
  • Exclusive
  • Multiplicative
supports.randomizer boolean Indicates if the randomizer is supported by the property.
supports.unlink boolean Indicates if unlink is supported by the property.
display object Displays information related to the property.
display.name string The display name of the property.
display.group string The display group of the property.
display.index integer The display index of the property.
dependencies array List of dependencies on other properties with their related action and conditions.
dependencies [...] object A dependency.
dependencies[...].type * string Defines the type of dependency. Possible values:
  • override
  • property
  • reference
  • objectType
dependencies[...].property string The name of the property to which the dependency is applied. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference .
A property name. Refer to Wwise Objects Reference for information about the Wwise objects and their properties.
dependencies[...].action * string The name of the action that is performed when the conditions are met.
dependencies[...].context * string The name of the context in which the dependency is evaluated.
dependencies[...].conditions array An array of conditions related to the dependency.
dependencies[...].conditions [...] object A dependency condition.
dependencies[...].conditions[...].referenceIsSet boolean Used for reference dependencies, defines if the target reference must be set or not.
dependencies[...].conditions[...].restriction one of: Used for property dependencies, defines the restriction on which the property must be set.
Restricts the value of the property.
object Empty object indicating that the property has no restriction.
object Restrictions on the range of values supported by the property.
object Restrictions on the reference object.
object Restrictions of the property values.
dependencies[...].conditions[...].restriction.type * string The value restriction of the property. Possible values:
  • range
dependencies[...].conditions[...].restriction.min * number The minimum value for the property.
dependencies[...].conditions[...].restriction.max * number The maximum value for the property.
dependencies[...].conditions[...].restriction.type * string The object reference restrictions of the property. Possible values:
  • reference
dependencies[...].conditions[...].restriction.restrictions * array The list of object reference restrictions.
dependencies[...].conditions[...].restriction.restrictions [...] one of:
object Restrictions on the object type that can be referenced.
object Restrictions on the object category from which objects can be referenced.
object Restrictions on the hierarchy position relative to a parent objects must occupy.
string Flag restrictions that, when present, are considered true. notNull indicates that the referenced object must exist; it cannot be null. playable indicates that the referenced object must be playable. Possible values:
  • notNull
  • playable
dependencies[...].conditions[...].restriction.restrictions[...].type * array An array of possible types.
dependencies[...].conditions[...].restriction.restrictions[...].type [...] string Possible object type supported. See Wwise Objects Reference for the list of objects.
dependencies[...].conditions[...].restriction.restrictions[...].sharedOnlyTypes array An array of types that are only supported as Shared objects (i.e., not Custom) even if the reference can support Custom objects. This is always a subset of "type".
dependencies[...].conditions[...].restriction.restrictions[...].sharedOnlyTypes [...] string Possible object type supported as Shared only. See Wwise Objects Reference for the list of objects.
dependencies[...].conditions[...].restriction.restrictions[...].category * array An array of supported categories.
dependencies[...].conditions[...].restriction.restrictions[...].category [...] string Possible category supported.
dependencies[...].conditions[...].restriction.restrictions[...].childOfReference * string Name of the reference.
dependencies[...].conditions[...].restriction.type * string The value restriction of the property. Possible values:
  • enum
dependencies[...].conditions[...].restriction.values * array Array of the possible enumerated values the property is restricted to.
dependencies[...].conditions[...].restriction.values [...] object An enumerated value with a name.
dependencies[...].conditions[...].restriction.values[...].value one of: The enumerated value.
number A numerical value.
boolean A boolean value.
dependencies[...].conditions[...].restriction.values[...].displayName string The name associated with the value.
restriction one of: Restricts the value of the property.
object Empty object indicating that the property has no restriction.
object Restrictions on the range of values supported by the property.
object Restrictions on the reference object.
object Restrictions of the property values.
restriction.type * string The value restriction of the property. Possible values:
  • range
restriction.min * number The minimum value for the property.
restriction.max * number The maximum value for the property.
restriction.type * string The object reference restrictions of the property. Possible values:
  • reference
restriction.restrictions * array The list of object reference restrictions.
restriction.restrictions [...] one of:
object Restrictions on the object type that can be referenced.
object Restrictions on the object category from which objects can be referenced.
object Restrictions on the hierarchy position relative to a parent objects must occupy.
string Flag restrictions that, when present, are considered true. notNull indicates that the referenced object must exist; it cannot be null. playable indicates that the referenced object must be playable. Possible values:
  • notNull
  • playable
restriction.restrictions[...].type * array An array of possible types.
restriction.restrictions[...].type [...] string Possible object type supported. See Wwise Objects Reference for the list of objects.
restriction.restrictions[...].sharedOnlyTypes array An array of types that are only supported as Shared objects (i.e., not Custom) even if the reference can support Custom objects. This is always a subset of "type".
restriction.restrictions[...].sharedOnlyTypes [...] string Possible object type supported as Shared only. See Wwise Objects Reference for the list of objects.
restriction.restrictions[...].category * array An array of supported categories.
restriction.restrictions[...].category [...] string Possible category supported.
restriction.restrictions[...].childOfReference * string Name of the reference.
restriction.type * string The value restriction of the property. Possible values:
  • enum
restriction.values * array Array of the possible enumerated values the property is restricted to.
restriction.values [...] object An enumerated value with a name.
restriction.values[...].value one of: The enumerated value.
number A numerical value.
boolean A boolean value.
restriction.values[...].displayName string The name associated with the value.
ui object Information related to how the property is displayed.
ui.value object Specifies how the property value is handled by Wwise UI.
ui.value.decimals integer The number of decimals displayed for the value.
ui.value.step number The amount by which the display increments the value.
ui.value.fine number The amount by which the display increments the value for fine adjustment.
ui.value.min number The minimum display value.
ui.value.max number The maximum display value.
ui.value.infinity number The number used to represent infinity.
ui.displayAs object Describe how the property is displayed.
ui.displayAs.lrMix boolean Indicates if the property should be displayed as a left-right mix.
ui.displayAs.musicNote boolean Indicates if the property should be displayed as a music note (MIDI).
ui.displayAs.bitfield boolean Indicates if the property should be displayed as a bitfield.
ui.dataMeaning string The unit type of the property. Possible values:
  • None
  • Frequency
  • Decibels
  • PitchCents
ui.autoUpdate boolean Indicates if the value of the property is updated while moving the slider.

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


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