Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInRegion Result Schema

Schema

{
"type": "object",
"properties": {
"peaksBinaryStrings": {
"type": "array",
"items": {
"type": "string",
"description": "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."
},
"description": "An array of binary strings."
},
"numChannels": {
"type": "number",
"description": "The number of channels of peak data (i.e. the number of strings in peaksBinaryStrings). This is 1 if getCrossChannelPeaks is true."
},
"maxAbsValue": {
"type": "number",
"description": "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": {
"type": "number",
"description": "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": {
"type": "number",
"description": "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": {
"type": "string",
"description": "The channel configuration."
}
},
"additionalProperties": false
}

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.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise