Version

menu_open
Wwise SDK 2022.1.12
ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInRegion Arguments Schema

Schema

{
"type": "object",
"properties": {
"object": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "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"
},
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"description": "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."
}
],
"description": "The ID (GUID), name, or path of the audio source object."
},
"timeFrom": {
"type": "number",
"description": "The start time, in seconds, of the section of the audio source for which peaks are required. This number must be smaller than timeTo.",
"minimum": 0
},
"timeTo": {
"type": "number",
"description": "The end time, in seconds, of the section of the audio source for which peaks are required. This number must be larger than timeFrom.",
"minimum": 0
},
"numPeaks": {
"type": "integer",
"description": "The number of peaks that are required (minimum 1).",
"minimum": 1,
"maximum": 4294967295
},
"getCrossChannelPeaks": {
"type": "boolean",
"description": "When true, peaks are calculated globally across channels, instead of per channel."
}
},
"additionalProperties": false,
"required": [
"object",
"timeFrom",
"timeTo",
"numPeaks"
]
}

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