|
Wwise SDK 2019.1.11
|
Retrieves all parameters affecting voice volume, highpass and lowpass for a voice path, resolved from pipeline IDs.
| Name | Type | Description |
|---|---|---|
| bussesPipelineID | array | An array of bus pipeline IDs. |
| bussesPipelineID [...] | number | The pipeline IDs of busses belonging to a common voice path. An empty array will default to the dry path. Identify a playing voice instance ID. Range: [0,*] |
| voicePipelineID * | number | The pipeline ID of the voice to get contributions from. Identify a playing voice instance ID. Range: [0,*] |
| 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 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.objects | array | A tree of contribution objects. |
| return.objects [...] | object | Identify a Voice Inspector contribution. |
| return.objects[...].name | string | The name of the contribution. |
| return.objects[...].parameters | array | An array of contribution parameters associated with the object. |
| return.objects[...].parameters [...] | object | A contribution parameter. |
| return.objects[...].parameters[...].reason | string | The reason for the parameter to affect the voice. |
| return.objects[...].parameters[...].driver | one of: | |
| string | The driving object GUID. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
|
| string | The driving reason when a parameter is not driven by an object. |
|
| return.objects[...].parameters[...].value | number | Contribution value |
| 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[...].propertyType | string | The object property affecting the voice |
| return.objects[...].HPF | number | The HPF difference applied. |
| return.objects[...].volume | number | The volume difference applied. |
| return.objects[...].LPF | number | The LPF difference applied. |
| return.objects[...].children | array | An array of child objects of the associated to the object. |
| return.objects[...].children [...] | A voice contribution object. |
|
| return.HPF | number | The HPF difference applied as a contribution. |
Refer to Wwise Authoring API (WAAPI)を使用する for more information about WAAPI.