Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.debug.generateToneWAV Arguments Schema

Schema

{
"type": "object",
"properties": {
"path": {
"description": "File path to write the generated WAV file. This path normally uses the file extension WAV.",
"type": "string"
},
"bitDepth": {
"description": "Bit depth of the audio file. Default is int16.",
"type": "string",
"enum": [
"int16",
"float32"
]
},
"sampleRate": {
"description": "Sample rate of the audio file. Default is 48000",
"type": "number",
"minimum": 300,
"maximum": 192000
},
"channelConfig": {
"description": "Channel configuration of the audio file. Default is 1.0. Please use the silence waveform for the ambisonics configurations, as the other tone signals will be incompatible with the format.",
"type": "string",
"enum": [
"0.1",
"1.0",
"2.0",
"2.1",
"3.0",
"4.0",
"5.1",
"7.1",
"5.1.2",
"7.1.2",
"7.1.4",
"Ambisonics 1st order",
"Ambisonics 2nd order",
"Ambisonics 3rd order",
"Ambisonics 4th order",
"Ambisonics 5th order"
]
},
"sustainTime": {
"description": "Number of seconds of the signal holds at the specified level. Default is 1 second.",
"type": "number",
"minimum": 0
},
"sustainLevel": {
"description": "Decibel attenuation for the sustained signal. Default is 0 dB.",
"type": "number",
"minimum": -100,
"maximum": 0
},
"attackTime": {
"description": "Number of seconds for the signal to reach sustain level. Default is 0 second.",
"type": "number",
"minimum": 0
},
"releaseTime": {
"description": "Number of seconds for the signal to release from sustain level. Default is 0 second.",
"type": "number",
"minimum": 0
},
"waveform": {
"description": "Waveform type. Default is silence.",
"type": "string",
"enum": [
"silence",
"sine",
"triangle",
"square",
"whiteNoise"
]
},
"frequency": {
"description": "Waveform frequency. Default is 440.",
"type": "number",
"minimum": 1,
"maximum": 22000
}
},
"required": [
"path"
],
"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