Arguments

Name	Type	Description
time *	one of:	Time in milliseconds to query for voices, 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
voicePipelineID	integer	The pipeline ID of a single voice to get. Unsigned Integer 32-bit. Range: [0,4294967295]

(Required *)

Arguments Schema

Options

Name	Type	Description
return	array	Members to return for each voice. Defaults to Pipeline ID, Game Object ID and Object GUID. An array of options for the playing voices.
return [...]	string	Specifies one of the defined members for a voice pipeline structure. Possible values: pipelineID playingID soundID gameObjectID gameObjectName objectGUID objectName playTargetID playTargetGUID playTargetName baseVolume gameAuxSendVolume envelope normalizationGain lowPassFilter highPassFilter priority isStarted isVirtual isForcedVirtual

Options Schema

Result

Name	Type	Description
return *	array	Array of voices.
return [...]	object	Voice item. A playing voice. Use the return options to specify which property is required.
return[...].pipelineID	integer	Pipeline ID of the voice. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].playingID	integer	Playing ID of the voice. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].soundID	integer	Short ID of the sound object corresponding to the voice. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].gameObjectID	any of:	Game Object ID corresponding to the voice.
	integer	Unsigned Integer 64-bit. Range: [0,18446744073709551615]
	integer	Integer 64-bit. Range: [-9223372036854775808,9223372036854775807]
return[...].gameObjectName	string	Game Object Name corresponding to the voice.
return[...].objectGUID	string	Object GUID corresponding to the voice. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].objectName	string	Object Name corresponding to the voice.
return[...].playTargetID	integer	Short ID of the play target object corresponding to the voice. Unsigned Integer 32-bit. Range: [0,4294967295]
return[...].playTargetGUID	string	GUID of the play target object corresponding to the voice. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].playTargetName	string	Name of the play target object corresponding to the voice.
return[...].baseVolume	number	Voice volume in dB, including HDR attenuation.
return[...].gameAuxSendVolume	number	Volume send to the auxiliary bus send in dB.
return[...].envelope	number	Current analyzed envelope value in dB. 0 if unavailable.
return[...].normalizationGain	number	Loudness normalization and make-up gain in dB.
return[...].lowPassFilter	number	Low-Pass Filter applied to the voice.
return[...].highPassFilter	number	High-Pass Filter applied to the voice.
return[...].priority	integer	Priority given to the voice. Integer 8-bit. Range: [-128,127]
return[...].isStarted	boolean	True if the voice has started playing, false otherwise.
return[...].isVirtual	boolean	True if the voice is virtual, false otherwise.
return[...].isForcedVirtual	boolean	True if the voice was forced as virtual, false otherwise.

(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.getVoices