Firelight Technologies FMOD Studio API

FMOD_DSP_PARAMETER_FFT

Structure for data parameters of type FMOD_DSP_PARAMETER_DATA_TYPE_FFT. A parameter of this type is declared for the FMOD_DSP_TYPE_FFT effect.

C/C++ Syntax

typedef struct {
  int length;
  int numchannels;
  float *spectrum[32];
} FMOD_DSP_PARAMETER_FFT;

JavaScript Syntax

struct FMOD_DSP_PARAMETER_FFT
{
  length,
  numchannels,
};

Members

length

[r] Number of entries in this spectrum window. Divide this by the output rate to get the hz per entry.

numchannels

[r] Number of channels in spectrum.

spectrum

[r] Per channel spectrum arrays. See remarks for more.

Remarks

Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.

Notes on the spectrum data member. Values inside the float buffer are typically between 0 and 1.0.
Each top level array represents one PCM channel of data.
Address data as spectrum[channel][bin]. A bin is 1 fft window entry.
Only read/display half of the buffer typically for analysis as the 2nd half is usually the same data reversed due to the nature of the way FFT works.

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.DSP_PARAMETER_FFT()", no 'new' keyword is required.

See Also

• FMOD_DSP_PARAMETER_DATA_TYPE
• FMOD_DSP_PARAMETER_DESC
• FMOD_DSP_PARAMETER_DATA_TYPE_FFT
• FMOD_DSP_TYPE
• FMOD_DSP_FFT

Version 1.10.03 Built on Feb 1, 2018