|
Wwise SDK 2019.1.11
|
Retrieves the voices at a specific profiler capture time.
| Name | Type | Description |
|---|---|---|
| time * | one of: | Time in milliseconds to query for voices, or a Time Cursor to acquire the time from. The User Time Cursor is the one that can be manipulated by the user, while the Capture Time Cursor follows represents the latest time of the current capture. |
| integer | Range: [0,*] | |
| string | Identify one of the global profiler cursors. Possible values:
|
(Required *)
| 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:
|
| 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[...].lowPassFilter | number | Low-Pass Filter applied to the voice. |
| return[...].isForcedVirtual | boolean | True if the voice was forced as virtual, false otherwise. |
| return[...].playTargetID | integer | Short ID of the play target object corresponding to the voice. Unsigned Integer 32-bit. Range: [0,4294967295] |
| return[...].objectName | string | Object Name corresponding to the voice. |
| return[...].gameObjectID | integer | Game Object ID corresponding to the voice. Unsigned Integer 64-bit. Range: [0,18446744073709551615] |
| return[...].envelope | number | Current analyzed envelope value in dB. 0 if unavailable. |
| return[...].isVirtual | boolean | True if the voice is virtual, false otherwise. |
| return[...].pipelineID | integer | Pipeline ID of the voice. Unsigned Integer 32-bit. Range: [0,4294967295] |
| return[...].objectGUID | string | Object GUID corresponding to the voice. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].isStarted | boolean | True if the voice has started playing, false otherwise. |
| return[...].priority | integer | Priority given to the voice. Integer 8-bit. Range: [-128,127] |
| return[...].soundID | integer | Short ID of the sound object corresponding to the voice. Unsigned Integer 32-bit. Range: [0,4294967295] |
| return[...].playTargetName | string | Name of the play target object corresponding to the voice. |
| return[...].highPassFilter | number | High-Pass Filter applied to the voice. |
| return[...].gameAuxSendVolume | number | Volume send to the auxiliary bus send in dB. |
| return[...].normalizationGain | number | Loudness normalization and make-up gain in dB. |
| return[...].playingID | integer | Playing ID of the voice. Unsigned Integer 32-bit. Range: [0,4294967295] |
| return[...].baseVolume | number | Voice volume in dB, including HDR attenuation. |
| 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[...].gameObjectName | string | Game Object Name corresponding to the voice. |
(Required *)
Refer to Using the Wwise Authoring API (WAAPI) for more information about WAAPI.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise