FQLab Namespace Reference

Namespaces
namespace	PluginContracts

Classes
class	AudioEngine
	Core class responsible for managing the state and playback of the currently selected track. The lifespan of this instance matches the lifespan of the IAudioStream it consumes. More...
class	AudioEngineFactory
	Creates audio engines based on user setups. More...
class	AudioStreamWrapper
	Wrapper class for the NAudio file reader. Enables optional decoupling of NAudio from the project architecture. More...
class	ControlPanelView
	Stores all views that can communicate through the controller with the audio engine. More...
class	EqColumn
	Singular EQ selection column for a specific range. Allows for cut/boost from -5 to 5. More...
class	EqSelectorView
	Parent view of individual EQ selections. Accommodates ranges based on the engine's accepted setup. More...
struct	EqSettings
	Immutable struct used for sending updated settings data from the GUI to the audio pipeline. More...
class	FreqAxisView
class	FreqGraphView
class	FreqSpectrumView
	Encapsulates views that display the frequency graphs. Takes care of their layout. More...
class	FreqViewDataProcessor
	Acts as a data sink for frequency data. Makes sure all data is in proper format for the graph view. More...
interface	IAudioEngineFactory
	Factory interface that creates audio engines based on OS and AudioStream settings. More...
interface	IAudioPlayer
	Final component of the audio pipeline. Responsible for playing samples on an audio source. More...
interface	IAudioReader
	Abstracts readers to be used inside IAudioStream. More...
interface	IAudioStream
	Represents the decoded audio file. Enables on request fetching of data. More...
interface	IFftProcessor
	Provides methods for FFT operations. More...
interface	IFreqDataReceiver
	Enables the audio pipeline to export frequency data from within. More...
class	InputHandler
	Handles creation of audio stream from a file location. More...
class	InputSelectWindow
	Initial window used to select a file to be decoded and played. More...
class	Logger
class	LoggerAudioPlayer
class	MathNetFftProcessor
	Wraps the FFT from Math.NET. More...
class	NAudioBufferedProvider
	Custom buffer for the NAudioPlayer. More...
class	NAudioPlayer
	Wrapper around the NAudio WaveOutEvent. More...
class	NAudioReaderAdapter
	Helper class that retypes the external NAudioReader to the project specific IAudioReader. More...
class	PlayingWindow
	Window containing all views related to audio playback. Its lifetime is identical to that of the stream and engine. More...
class	Plugin
class	PluginInstance
	IAudioPlugin wrapper for enforcing bypass onto external plugins. More...
class	PluginListView
	Displays installed plugin in a list. Enables on/off toggles. More...
class	PluginLoader
	Static helper used for extraction of audio plugins (IAudioPlugin objects). More...
class	Program
class	SimpleFileBrowser
	Mouse-enabled file explorer. More...
class	SineWaveStream
class	UIController
	A core class of the program's UI. Keeps the state of the AudioEngine and processes requests to it made by individual Views. Ensures that all tasks on the engine finish and all resources are disposed of properly. More...

Enumerations
enum	EqRanges { Lows = 0 , Mids , Highs }

Functions
record	AudioFrame (float[] Samples, AudioFormat Format)
	Couples together crucial audio stream metadata with float samples.
record	FreqViewData (Complex[] FreqBins, AudioFormat AudioFormat, int FftSize)
	Holds results of FFT. Data about current frequency distribution of the audio stream.
record	AudioEngineFactoryResult (AudioEngine AudioEngine, FreqSpectrumView? View=null)
	Response of the engine factory. Used to return a tailored audio engine as well as an optional graph view.

Enumeration Type Documentation

EqRanges

enum FQLab.EqRanges

Enumerator
Lows
Mids
Highs

Function Documentation

AudioEngineFactoryResult()

record FQLab.AudioEngineFactoryResult	(	AudioEngine	AudioEngine,
		FreqSpectrumView?	View = null
	)

Response of the engine factory. Used to return a tailored audio engine as well as an optional graph view.

Parameters

AudioEngine	User settings specific engine.
View	Optional graph view.

Here is the caller graph for this function:

AudioFrame()

record FQLab.AudioFrame	(	float[]	Samples,
		AudioFormat	Format
	)

Couples together crucial audio stream metadata with float samples.

Parameters

Samples	PCM samples
Format	AudioFormat

Here is the caller graph for this function:

FreqViewData()

record FQLab.FreqViewData	(	Complex[]	FreqBins,
		AudioFormat	AudioFormat,
		int	FftSize
	)

Holds results of FFT. Data about current frequency distribution of the audio stream.

Parameters

FreqBins	Result of FFT.
AudioFormat	AudioFormat
FftSize	Resolution of the FFT used.

Here is the caller graph for this function: