Version
menu_open
Wwise SDK 2024.1.1
ak.wwise.core.object.get

Performs a query and returns the data, as specified in the options, for each object in the query result. The query can specify either a 'waql' argument or a 'from' argument with an optional 'transform' argument. Refer to Using the Wwise Authoring Query Language (WAQL) or Querying the Wwise Project for more information. Refer to Return Options to learn about options.

Arguments

Name Type Description
waql string Specifies a query in the WAQL language. Refer to Using the Wwise Authoring Query Language (WAQL) for more information.
from one of: The query starting point. Note, this is deprecated. The WAQL argument should be used instead.
object Specify an object with an id field.
object Specifies an object with a search field.
object Specifies an object with a name field.
object Specifies an object with a path field.
object Specify an object with an ofType field.
object Specifies an object with a query field.
from.id * array An array of object IDs, either GUID or Short ID (uint32).
from.id [...] one of: A GUID or Short ID (uint32).
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
object A Wwise object Short ID with its associated type.
from.id[...].shortId * integer The Short ID of the object.
Unsigned Integer 32-bit. Range: [0,4294967295]
from.id[...].type * integer This syntax is deprecated and we recommend the use of WAQL. The type of object for the Short ID. The type ​​can be 10 (Event), 12 (SwitchGroup), 14 (StateGroup), 17 (EffectPlugin), 18 (SoundBank), 19 (Bus), 20 (AuxBus), 22 (GameParameter), 41 (Trigger) or 68 (AudioDevicePlugin) Range: [1,*]
from.search * array An array of text tokens used for searching the project.
from.search [...] string A search token.
from.name * array An array of unique object qualified names.
from.name [...] 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
from.path * array An array of object paths.
from.path [...] 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.
from.ofType * array An array of object types.
from.ofType [...] string An object type. Refer to Wwise Objects Reference for a list of types.
from.query * array An array of query object ID.
from.query [...] string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
transform array Array of sequential transformations chained on the object list returned by "from".
transform [...] one of: An object transformation.
object An select transformation.
string Unique object instances are returned, i.e. no duplicate object is returned. Possible values:
  • distinct
object Specifies an object with a range field.
object Specifies an object with an where field.
transform[...].select * array An array of only 1 selector.
transform[...].select [...] string A selector. The resulting objects depend on the selector specified. Possible values:
  • parent
  • children
  • descendants
  • ancestors
  • referencesTo
transform[...].range * array An array of two numbers specifying the boundary indexes. Use this to only include a portion of the results. For example, this could be used to obtain the 100 first items of a search result: [0,100].
transform[...].range [...] number One of the two range limit numbers.
transform[...].where * array An array of two tokens to filter results. The first token is the filter predicate. Refer Querying the Wwise Project for the list of possible predicates. The second token is the parameter to the predicate.
transform[...].where [...] any of: A where statement.
string A string token. The first token in the array is always the 'where' predicate name string. The second token is the parameter.
array An array of strings. Refer Querying the Wwise Project for more information.
transform[...].where[...] [...] string The parameter for the 'where' predicate. Refer Querying the Wwise Project for more information.

Arguments Schema

Options

Name Type Description
return array Specifies what is being returned for every object. Refer to Wwise Objects Reference for more information on the properties and references available.
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.
return [...] any of: A return expression.
string Specifies one or many of the built-in accessors for Wwise objects. Possible values:
  • 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
  • originalRelativeFilePath
  • convertedFilePath
  • originalWavFilePath
  • soundbankBnkFilePath
  • musicTransitionRoot
  • musicPlaylistRoot
  • playbackDuration
  • duration
  • maxDurationSource
  • audioSourceTrimValues
  • maxRadiusAttenuation
  • audioSourceLanguage
  • workunitIsDefault
  • workunitType
  • workunitIsDirty
  • switchContainerChildContext
  • isExplicitMute
  • isExplicitSolo
  • isImplicitMute
  • isImplicitSolo
  • isIncluded
  • points
  • stateProperties
  • stateGroups
  • blendTracks
string 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 Wwise Objects Reference .
platform any of: The ID (GUID) or name of the platform. This is an optional argument. When not specified, the current platform is used.
string The name of the platform.
string The id of the platform.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
language any of: The ID (GUID) or name of the language.
string The name of the language.
string The id of the language.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.

Options Schema

Result

Name Type Description
return array An array of objects found, with properties matching what was supplied in the options.
return [...] object Wwise object
A Wwise object. Use the return options to specify which property is required.
return[...].id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].name string The name of the object.
return[...].notes string The notes of the object.
return[...].type string The type of the object. Refer to Wwise Objects Reference for more information on the types available.
return[...].pluginName string The name of the plug-in for Source, Effect, Mixer, Device and Metadata plug-in.
return[...].path string The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
return[...].parent object The parent of the object in the hierarchy.
return[...].parent.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].parent.name string The name of the object.
return[...].owner object The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
return[...].owner.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].owner.name string The name of the object.
return[...].isPlayable boolean True if the object can be played in Transport.
return[...].shortId integer The Short ID of the object.
return[...].classId integer The class ID of the object.
Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].category string The category of the object. Ex: 'Actor-Mixer Hierarchy'
return[...].filePath string The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].workunit object The parent Work Unit containing the object. The 'id' and the 'name' is returned.
return[...].workunit.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].workunit.name string The name of the object.
return[...].childrenCount number The number of children for the object. Note, this is deprecated. The same result can be obtained with children.count().
return[...].totalSize integer The amount of space (in bytes) this object and all of its children take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate.
return[...].mediaSize integer The total converted size (in bytes) of the media files of this object and all of its children. Note that SoundBanks need to be generated for this value to be accurate.
return[...].objectSize integer The amount of space (in bytes) the meta-data of the object takes up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
return[...].structureSize integer The amount of space (in bytes) the meta-data of the object and all of its children take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
return[...].musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. Note, this is deprecated. The TransitionRoot reference should be used instead.
return[...].musicTransitionRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].musicPlaylistRoot object (DEPRECATED) The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. Note, this is deprecated. The PlaylistRoot reference should be used instead.
return[...].musicPlaylistRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].originalWavFilePath string (DEPRECATED) Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].originalFilePath string Absolute path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].originalRelativeFilePath string Relative (from project's Originals Folder) path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].activeSource object The active source of the sound object.
return[...].activeSource.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].activeSource.name string The name of the object.
return[...].convertedWemFilePath string (DEPRECATED) Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].convertedFilePath string Absolute path to the converted file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].soundbankBnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].playbackDuration object The duration root that contains the min and max durations and duration type. Note, this is deprecated. The duration should be used instead. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
return[...].playbackDuration.playbackDurationMin number The minimum possible time playback can take.
return[...].playbackDuration.playbackDurationMax number The maximum possible time playback can take.
return[...].playbackDuration.playbackDurationType string The type of duration.
return[...].duration object The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
return[...].duration.min number The minimum possible time playback can take.
return[...].duration.max number The maximum possible time playback can take.
return[...].duration.type string The type of duration.
return[...].maxDurationSource object Audio source with the longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
return[...].maxDurationSource.id string The ID (GUID) of the audio source object with the longest duration.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].maxDurationSource.trimmedDuration number The duration in seconds of the longest trimmed source.
return[...].audioSourceTrimValues object Range of time for which the audio source is trimmed.
return[...].audioSourceTrimValues.trimBegin number The time value in seconds of the start trim.
return[...].audioSourceTrimValues.trimEnd number The time value in seconds of the end trim.
return[...].maxRadiusAttenuation object Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
return[...].maxRadiusAttenuation.id string The ID (GUID) of the attenuation object with the largest radius.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].maxRadiusAttenuation.radius number The radius of the attenuation object.
return[...].audioSourceLanguage object Language associated to the audio source. This only applies to Audio Source objects directly.
return[...].audioSourceLanguage.id string The ID (GUID) of the Language object to which the Audio Source object is associated.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].audioSourceLanguage.name string The name of the Language object to which the Audio Source object is associated.
return[...].originalTotalChannelCount number The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalNormalChannelCount number The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalHeightChannelCount number The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalLFEChannelCount number The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalChannelConfig string The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalBitDepth number The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalDuration number The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].originalCodec string The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedTotalChannelCount number The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedNormalChannelCount number The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedHeightChannelCount number The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedLFEChannelCount number The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedChannelConfig string The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedBitDepth number The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedDuration number The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].convertedCodec string The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
return[...].workunitIsDefault boolean True if the work unit is the default.
return[...].workunitType string The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders have the workunitType "folder". Possible values:
  • folder
  • rootFile
  • nestedFile
return[...].workunitIsDirty boolean True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved.
return[...].switchContainerChildContext object The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: the properties of the '1st only' checkbox).
return[...].switchContainerChildContext.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].isExplicitMute boolean Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects.
return[...].isExplicitSolo boolean Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one.
return[...].isImplicitMute boolean Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects.
return[...].isImplicitSolo boolean Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one.
return[...].isIncluded boolean Whether or not the object is Included. Specify the platform in the options. This takes into consideration the Inclusion status of the object's ancestors.
return[...].points array This only applies to Curve objects.
An array of points defining a curve.
return[...].points [...] object A point in the curve.
return[...].points[...].x * number X coordinate of curve point.
return[...].points[...].y * number Y coordinate of curve point.
return[...].points[...].shape * string Shape of the curve segment between this point and the next. Possible values:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3
return[...].stateProperties array An array of state properties to set.
return[...].stateProperties [...] string The name of the property to set.
return[...].stateGroups array The State Group objects associated with this object.
return[...].stateGroups [...] object A State Group object.
return[...].stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].stateGroups[...].name string The name of the State Group object.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) any of: Specifies dot-separated accessors that form a query and yields a property value or an object reference. A single @ specifies the value of the property for the associated object. A double @ specifies the value of the property for the source of override. Refer to Wwise Objects Reference for more information on the properties and references for all types available.
string A string value.
array An array of string values.
number A numeric value.
array An array of numeric values.
boolean A boolean value.
array An array of boolean values.
object An object reference value.
array An object list reference value.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string A string value.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number A numeric value.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean A boolean value.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name string The name of the object.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] object An object reference value.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name string The name of the object.

Result Schema

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