Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Wwise SDK 2023.1.8

Retrieves the Audio Objects at a specific profiler capture time.

Arguments

Name	Type	Description
time *	one of:	Time in milliseconds to query for Audio Objects, or a Time Cursor from which to acquire the time. The User Time Cursor is the one that can be manipulated by the user, while the Capture Time Cursor represents the latest time of the current capture.
	integer	Range: [0,*]
	string	Identify one of the global profiler cursors. Possible values: user capture
busPipelineID	integer	The pipeline ID of a Bus instance for which to get Audio Objects. Unsigned Integer 32-bit. Range: [0,4294967295]

(Required *)

Arguments Schema

Options

Name	Type	Description
return	array	Members to return for each Audio Object. Defaults to Audio Object ID, Bus Pipeline ID, Instigator Pipeline ID and Effect Class ID. An array of options for the Audio Objects.
return [...]	string	Specifies one of the defined members for an Audio Object structure. Possible values: busName effectPluginName audioObjectID busPipelineID gameObjectID gameObjectName audioObjectName instigatorPipelineID busID busGUID spatializationMode x y z spread focus channelConfig effectClassID effectIndex metadata rmsMeter peakMeter

Options Schema

Result

Name	Type	Description
return *	array	Array of Audio Objects.
return [...]	object	Audio Object. An audio object. Use the return options to specify which property is required.
return[...].busName	string	Name of the bus instance.
return[...].effectPluginName	string	Name of the effect plug-in after which the Audio Object was captured.
return[...].audioObjectID	integer	The ID of the Audio Object. Unsigned Integer 64-bit. Range: [0,18446744073709551615]
return[...].busPipelineID	integer	The Pipeline ID of the Bus instance. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].gameObjectID	integer	The Game Object ID of the Bus instance. Unsigned Integer 64-bit. Range: [0,18446744073709551615]
return[...].gameObjectName	string	The name of the Game Object of the Bus Instance.
return[...].audioObjectName	string	The name of the Audio Object. Can be empty.
return[...].instigatorPipelineID	integer	The pipeline ID of the instigator from which the Audio Object originates. Can be either a Bus instance or a Voice. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].busID	integer	The short ID of the Bus. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].busGUID	string	The GUID of the Bus. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].spatializationMode	integer	The spatialization mode. Use `Ak3DSpatializationMode` to interpret the value. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].x	number	The X value of the Audio Object position.
return[...].y	number	The Y value of the Audio Object position.
return[...].z	number	The Z value of the Audio Object position.
return[...].spread	number	The spread value (normalized) of the Audio Object.
return[...].focus	number	The focus value (normalized) of the Audio Object.
return[...].channelConfig	integer	The channel configuration of the Audio Object. Use `AK::AkChannelConfig::Deserialize` to deserialize the value. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].effectClassID	integer	The Class ID of the effect after which the Audio Object was captured. Usage of `AK_INVALID_UNIQUE_ID` constant means that this Audio Object was captured before applying the first effect. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].effectIndex	integer	The index of the effect after which the Audio Object was captured. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].metadata	array	Array of objects containing metadata of the Audio Object.
return[...].metadata [...]	object	An object of metadata.
return[...].metadata[...].metadataClassID *	integer	The class ID of the metadata. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].metadata[...].metadataName	string	The name of the metadata.
return[...].metadata[...].sourceID	string	The ID (GUID) of the source object.
return[...].metadata[...].sourceShortID *	integer	The short ID of the source object. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].metadata[...].sourceName	string	The name of the source object.
return[...].rmsMeter	array	Array of volume values (one per channel) for the RMS meter.
return[...].rmsMeter [...]	number	The volume value (DB) of the channel.
return[...].peakMeter	array	Array of volume values (one per channel) for the Peak meter.
return[...].peakMeter [...]	number	The volume value (DB) of the channel.

(Required *)

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.

Get started with Wwise

Wwise SDK

ak.wwise.core.profiler.getAudioObjects