Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Wwise SDK 2023.1.8

Gets the min/max peak pairs, in the 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, only one binary string represents the peaks across all channels globally.

Arguments

Name	Type	Description
object *	any of:	The ID (GUID), name, or path of the audio source object.
	string	The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
	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,*]
numPeaks *	integer	The number of peaks that are required (minimum 1). Range: [1,4294967295]
getCrossChannelPeaks	boolean	When true, peaks are calculated globally across channels, instead of per channel.

(Required *)

Arguments Schema

Result

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 is only one binary string in this array, representing the min max peaks across all channels.
numChannels	number	The number of channels of peak data (i.e. the number of strings in peaksBinaryStrings). This is 1 if getCrossChannelPeaks is true.
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.
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.
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
channelConfig	string	The channel configuration.

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.audioSourcePeaks.getMinMaxPeaksInRegion