Version

menu_open
Wwise SDK 2023.1.2
ak.wwise.debug.generateToneWAV

Generate a WAV file playing a tone with a simple envelope and save it to the specified location. This is provided as a utility to generate test WAV files.

Arguments

Name Type Description
path * string File path to write the generated WAV file. This path normally uses the file extension WAV.
bitDepth string Bit depth of the audio file. Default is int16. Possible values:
  • int16
  • float32
sampleRate number Sample rate of the audio file. Default is 48000 Range: [300,192000]
channelConfig string 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. Possible values:
  • 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 number Number of seconds of the signal holds at the specified level. Default is 1 second. Range: [0,*]
sustainLevel number Decibel attenuation for the sustained signal. Default is 0 dB. Range: [-100,0]
attackTime number Number of seconds for the signal to reach sustain level. Default is 0 second. Range: [0,*]
releaseTime number Number of seconds for the signal to release from sustain level. Default is 0 second. Range: [0,*]
waveform string Waveform type. Default is silence. Possible values:
  • silence
  • sine
  • triangle
  • square
  • whiteNoise
frequency number Waveform frequency. Default is 440. Range: [1,22000]

(Required *)

Arguments 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.

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

Get started with Wwise