Wwise SDK 2019.1.11

Performs a query, returns specified data for each object in query result. Refer to Querying the Wwise Project for more information.

Arguments

Name	Type	Description
from *	one of:	The query starting point.
	object	Specify an object with an id field.
	object	Specify an object with a search field.
	object	Specify an object with a name field.
	object	Specify an object with a path field.
	object	Specify an object with an ofType field.
	object	Specify 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	The type of object for the short ID. Refer to Wwise Objects Reference for object types. 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 object unique qualified names.
from.name [...]	string	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. Ex: Event:Play_Sound_01
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	Specify an object with a range field.
	object	Specify 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. Example: Get the descendant objects matching a filter .
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.

(Required *)

Arguments Schema

Options

Name	Type	Description
platform	any of:	The ID (GUID) or name of the platform.
	string	The name of the platform.
	string	The id of the platform. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
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 will be returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or 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 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
	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 .
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 options.
return [...]	object	Wwise object A Wwise object. Use the return options to specify which property is required.
return[...].soundbank:bnkFilePath	string	Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].objectSize	integer	The amount of space (in bytes) the meta-data of the object will 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[...].audioSource:maxDurationSource	object	Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
return[...].audioSource:maxDurationSource.id	string	The ID (GUID) of the audio source object with longest duration. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].audioSource:maxDurationSource.trimmedDuration	number	The duration in seconds of the longest trimmed source.
return[...].music:transitionRoot	object	The music transition root containing all other music transitions recursively.
return[...].music:transitionRoot.id	string	The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].workunit:type	string	The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder". Possible values: folder rootFile nestedFile
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[...].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[...].sound:originalWavFilePath	string	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[...].structureSize	integer	The amount of space (in bytes) the meta-data of the object and all of its children will 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[...].id	string	The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].category	string	The category of the object. Ex: 'Actor-Mixer Hierarchy'
return[...].switchContainerChild:context	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: property for the 1st only checkbox).
return[...].switchContainerChild:context.id	string	The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].totalSize	integer	The amount of space (in bytes) this object and all of its children will 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[...].type	string	The type of the object. Refer to Wwise Objects Reference for more information on the types available.
return[...].workunit:isDefault	boolean	True if the work unit is the default.
return[...].isPlayable	boolean	True if the object can be played in Transport.
return[...].audioSource:trimValues	object	Range of time for which the audio source is trimmed.
return[...].audioSource:trimValues.trimBegin	number	The time value in seconds of the start trim.
return[...].audioSource:trimValues.trimEnd	number	The time value in seconds of the end trim.
return[...].audioSource: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[...].audioSource:maxRadiusAttenuation.radius	number	The radius of the attenuation object.
return[...].audioSource: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[...].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[...].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:isDirty	boolean	True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.
return[...].workunit	object	The parent Work Unit containing the object. The 'id' and the 'name' will be 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[...].shortId	integer	The short ID of the object.
return[...].sound:convertedWemFilePath	string	Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
return[...].audioSource:playbackDuration	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[...].audioSource:playbackDuration.playbackDurationMin	number	The minimum possible time playback can take.
return[...].audioSource:playbackDuration.playbackDurationMax	number	The maximum possible time playback can take.
return[...].audioSource:playbackDuration.playbackDurationType	string	The type of duration.
return[...].path	string	The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
return[...].music:playlistRoot	object	The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
return[...].music:playlistRoot.id	string	The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].classId	integer	The class ID of the object. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].name	string	The name of the object.
return[...].audioSource:language	object	Language associated to the audio source. This only applies to Audio Source objects directly.
return[...].audioSource:language.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[...].audioSource:language.name	string	The name of the Language object to which the Audio Source object is associated.
return[...].notes	string	The notes of the object.
return[...].childrenCount	number	The number of children for the 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 using 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.
	number	A numeric value.
	boolean	A boolean value.
	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 WAAPI.

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.

Get started with Wwise