|
Wwise SDK 2024.1.2
|
Retrieves all parameters affecting voice volume, highpass and lowpass for a voice path, resolved from pipeline IDs.
| Name | Type | Description |
|---|---|---|
| voicePipelineID * | number | The pipeline ID of the voice to get contributions from. Identifies a playing voice instance ID. Range: [0,*] |
| bussesPipelineID | array | An array of bus pipeline IDs. |
| bussesPipelineID [...] | number | The pipeline IDs of busses belonging to a common voice path. An empty array defaults to the dry path. Identifies a playing voice instance ID. Range: [0,*] |
| 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:
|
(Required *)
| Name | Type | Description |
|---|---|---|
| return | object | The hierarchy of objects with parameters contributing to the voice, ordered from top-level parent to the voice object |
| return.volume * | number | The volume difference applied as a contribution. |
| return.LPF * | number | The LPF difference applied as a contribution. |
| return.HPF * | number | The HPF difference applied as a contribution. |
| return.objects * | array | A tree of contribution objects. |
| return.objects [...] | object | Identifies a Voice Inspector contribution. |
| return.objects[...].name | string | The name of the contribution. |
| return.objects[...].volume | number | The volume difference applied. |
| return.objects[...].LPF | number | The LPF difference applied. |
| return.objects[...].HPF | number | The HPF difference applied. |
| return.objects[...].index | integer | Unique (per emitter) identifier for the emitter-listener ray. Unsigned Integer 32-bit. Range: [0,4294967295] |
| return.objects[...].children | array | An array of child objects associated to the object. |
| return.objects[...].children [...] | object | A voice contribution object. Identifies a Voice Inspector contribution. |
| return.objects[...].children[...].name | string | The name of the contribution. |
| return.objects[...].children[...].volume | number | The volume difference applied. |
| return.objects[...].children[...].LPF | number | The LPF difference applied. |
| return.objects[...].children[...].HPF | number | The HPF difference applied. |
| return.objects[...].children[...].index | integer | Unique (per emitter) identifier for the emitter-listener ray. Unsigned Integer 32-bit. Range: [0,4294967295] |
| return.objects[...].children[...].children | array | An array of child objects associated to the object. |
| return.objects[...].children[...].children [...] | A voice contribution object. | |
| return.objects[...].children[...].parameters | array | An array of contribution parameters associated to the object. |
| return.objects[...].children[...].parameters [...] | object | A contribution parameter. |
| return.objects[...].children[...].parameters[...].propertyType | string | The object property affecting the voice |
| return.objects[...].children[...].parameters[...].reason | string | The reason for the parameter to affect the voice. |
| return.objects[...].children[...].parameters[...].driver | string | The driving reason when a parameter is not driven by an object, or the driving object GUID. |
| return.objects[...].children[...].parameters[...].driverValue | one of: | |
| number | The value of the driver affecting the parameter. | |
| string | Can be an object, e.g. for States. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. | |
| return.objects[...].children[...].parameters[...].value | number | Contribution value |
| return.objects[...].parameters | array | An array of contribution parameters associated to the object. |
| return.objects[...].parameters [...] | object | A contribution parameter. |
| return.objects[...].parameters[...].propertyType | string | The object property affecting the voice |
| return.objects[...].parameters[...].reason | string | The reason for the parameter to affect the voice. |
| return.objects[...].parameters[...].driver | string | The driving reason when a parameter is not driven by an object, or the driving object GUID. |
| return.objects[...].parameters[...].driverValue | one of: | |
| number | The value of the driver affecting the parameter. | |
| string | Can be an object, e.g. for States. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. | |
| return.objects[...].parameters[...].value | number | Contribution value |
Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.
Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !
Visitez notre page d'AideEnregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !
Partir du bon pied avec Wwise