LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Obsolete
GetSpectrumData returning a float[] is deprecated, use GetOutputData and pass a pre allocated array instead.

AudioListener.GetSpectrumData

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static function GetSpectrumData(samples: float[], channel: int, window: FFTWindow): void;
public static void GetSpectrumData(float[] samples, int channel, FFTWindow window);

Parameters

samples The array to populate with audio samples. Its length must be a power of 2.
channel The channel to sample from.
window The FFTWindow type to use when sampling.

Description

Provides a block of the listener (master)'s spectrum data.

The array given in the samples parameter will be filled with the requested data.

Number of values (the length of the samples array) must be a power of 2. (ie 128/256/512 etc). Min = 64. Max = 8192. Use window to reduce leakage between frequency bins/bands. Note, the more complex window type, the better the quality, but reduced speed.

This function will use the sampling rate specified in AudioSettings.outputSampleRate, and NOT the sampling rate specified for the audio clip.

See Also: AudioListener.GetOutputData, AudioSource.GetSpectrumData, AudioSource.GetOutputData.


public static function GetSpectrumData(numSamples: int, channel: int, window: FFTWindow): float[];
public static float[] GetSpectrumData(int numSamples, int channel, FFTWindow window);

Parameters

Description

Deprecated Version. Returns a block of the listener (master)'s spectrum data.

This variation of the function allocates a new array each time it is called. Use the Non-alloc version instead for better performance.