AudioEffectSpectrumAnalyzer — C# API

Creates an AudioEffectInstance which performs frequency analysis and exposes results to be accessed in real-time.

class AudioEffectSpectrumAnalyzerReckfellSharpInherits AudioEffect

Creates an AudioEffectInstance which performs frequency analysis and exposes results to be accessed in real-time.

Calculates a Fourier Transform of the audio signal. This effect does not alter the audio. Can be used for creating real-time audio visualizations, like a spectrogram. This resource configures an AudioEffectSpectrumAnalyzerInstance, which performs the actual analysis at runtime. An instance should be obtained with AudioServer.GetBusEffectInstance to make use of this effect.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioEffectSpectrumAnalyzerConstructor

# AudioEffectSpectrumAnalyzer

C#
public AudioEffectSpectrumAnalyzer();

Properties2

BufferLengthProperty

# BufferLength

C#
public float BufferLength { get; set; }

The length of the buffer to keep, in seconds. Higher values keep data around for longer, but require more memory. Value can range from 0.1 to 4.

FftSizeProperty

# FftSize

C#
public AudioEffectSpectrumAnalyzer.FftSizeEnum FftSize { get; set; }

The size of the Fast Fourier transform buffer. Higher values smooth out the spectrum analysis over time, but have greater latency. The effects of this higher latency are especially noticeable with sudden amplitude changes.

Methods6

GetBufferLengthfloat

# GetBufferLength

C#
public float GetBufferLength();

Returns float

GetFftSizeAudioEffectSpectrumAnalyzer.FftSizeEnum

# GetFftSize

C#
public AudioEffectSpectrumAnalyzer.FftSizeEnum GetFftSize();

Returns AudioEffectSpectrumAnalyzer.FftSizeEnum

GetTapBackPosfloat

# GetTapBackPos

C#
public float GetTapBackPos();

Returns float

SetBufferLengthvoid

# SetBufferLength

C#
public void SetBufferLength(float seconds);

Parameters
Name	Type	Default
`seconds`	`float`	—

SetFftSizevoid

# SetFftSize

C#
public void SetFftSize(AudioEffectSpectrumAnalyzer.FftSizeEnum size);

Parameters
Name	Type	Default
`size`	`AudioEffectSpectrumAnalyzer.FftSizeEnum`	—

SetTapBackPosvoid

# SetTapBackPos

C#
public void SetTapBackPos(float seconds);

Parameters
Name	Type	Default
`seconds`	`float`	—

AudioEffectSpectrumAnalyzer.FftSizeEnum

Value	Description
`Max = 5`	Represents the size of the `AudioEffectSpectrumAnalyzer.FftSizeEnum` enum.
`Size1024 = 2`	Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time.
`Size2048 = 3`	Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time.
`Size256 = 0`	Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time.
`Size4096 = 4`	Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time.
`Size512 = 1`	Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time.