|
Wwise SDK 2019.1.11
|
Get the min/max peak pairs, in a given region of an audio source, as a collection of binary strings (one per channel). The strings are base-64 encoded 16-bit signed int arrays, with min and max values being interleaved. If getCrossChannelPeaks is true, there will be only one binary string representing peaks across all channels globally.
| Name | Type | Description |
|---|---|---|
| numPeaks * | integer | The number of peaks that are required (minimum 1). Range: [1,4294967295] |
| object * | any of: | The ID (GUID), name, or path of the audio source object. |
| string | The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01 |
|
| string | An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
|
| string | A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX. |
|
| timeFrom * | number | The start time, in seconds, of the section of the audio source for which peaks are required. This number must be smaller than timeTo. Range: [0,*] |
| timeTo * | number | The end time, in seconds, of the section of the audio source for which peaks are required. This number must be larger than timeFrom. Range: [0,*] |
| getCrossChannelPeaks | boolean | When true, peaks will be calculated globally across channels, instead of per channel. |
(Required *)
| Name | Type | Description |
|---|---|---|
| peaksBinaryStrings | array | An array of binary strings. |
| peaksBinaryStrings [...] | string | Binary string, representing one channel of min max peaks data. When getCrossChannelPeaks is true there will only be one binary string in this array, representing the min max peaks across all channels. |
| maxAbsValue | number | The maximum value that a peak can take. This can be used to normalize the peaks in the array (between -1, 1), by dividing each by this number. |
| numChannels | number | The number of channels of peak data (i.e. the number of strings in peaksBinaryStrings). This will be 1 if getCrossChannelPeaks is true. |
| peaksDataSize | number | The size of the data in the peaks min max arrays. This can be used (in conjunction with peaksArrayLength) to decode the peaksBinaryStrings to 16 bit integer arrays |
| peaksArrayLength | number | The number of peaks in the returned min max channel arrays. If peaksArrayLength is less than the numPeaks input argument, this indicates fewer samples were available than numPeaks requested. In this case, the arrays contain all of the sample values within the requested time window. |
Refer to Wwise Authoring API (WAAPI)を使用する for more information about WAAPI.