This is an interface class for the creation, destruction, and overall management of audio effects. More...

#include <effectshandler.h>

Public Member Functions
	iEffectsHandler ()
	Class constructor.

virtual	~iEffectsHandler ()
	Class destructor.

virtual void	AddAutowahEffectPreset (const String &Name, const AutowahParameters &Setting)=0
	Adds a preset for the Autowah Audio Effect type. More...

virtual void	AddChorusEffectPreset (const String &Name, const ChorusParameters &Setting)=0
	Adds a preset for the Chorus Audio Effect type. More...

virtual void	AddCompressorEffectPreset (const String &Name, const CompressorParameters &Setting)=0
	Adds a preset for the Compressor Audio Effect type. More...

virtual void	AddDistortionEffectPreset (const String &Name, const DistortionParameters &Setting)=0
	Adds a preset for the Distortion Audio Effect type. More...

virtual void	AddEAXReverbEffectPreset (const String &Name, const EAXReverbParameters &Setting)=0
	Adds a preset for the EAX Reverb Audio Effect type. More...

virtual void	AddEchoEffectPreset (const String &Name, const EchoParameters &Setting)=0
	Adds a preset for the Echo Audio Effect type. More...

virtual void	AddEqualizerEffectPreset (const String &Name, const EqualizerParameters &Setting)=0
	Adds a preset for the Equalizer Audio Effect type. More...

virtual void	AddFlangerEffectPreset (const String &Name, const FlangerParameters &Setting)=0
	Adds a preset for the Flanger Audio Effect type. More...

virtual void	AddFrequencyShiftEffectPreset (const String &Name, const FrequencyShiftParameters &Setting)=0
	Adds a preset for the Frequency Shift Audio Effect type. More...

virtual void	AddPitchShifterEffectPreset (const String &Name, const PitchShifterParameters &Setting)=0
	Adds a preset for the Pitch Shifter Audio Effect type. More...

virtual void	AddReverbEffectPreset (const String &Name, const ReverbParameters &Setting)=0
	Adds a preset for the Reverb Audio Effect type. More...

virtual void	AddRingModulatorEffectPreset (const String &Name, const RingModulatorParameters &Setting)=0
	Adds a preset for the Ring Modulator Audio Effect type. More...

virtual void	AddVocalMorpherEffectPreset (const String &Name, const VocalMorpherParameters &Setting)=0
	Adds a preset for the Vocal Morpher Audio Effect type. More...

virtual iEffect *	CreateEffect ()=0
	Creates an Audio Effect for use with Audio::Sound instances. More...

virtual iFilter *	CreateFilter ()=0
	Creates an Audio Filter for use with iSound instances. More...

virtual void	DestroyAllEffects ()=0
	Destroys all Audio::iEffect instances being stored by this handler.

virtual void	DestroyAllFilters ()=0
	Destroys all iFilter instances being stored by this handler.

virtual void	DestroyEffect (iEffect *ToBeDestroyed)=0
	Destroys a single Audio::iEffect instance. More...

virtual void	DestroyFilter (iFilter *ToBeDestroyed)=0
	Destroys a single iFilter instance. More...

virtual Boole	EffectPresetExists (const EffectType Type, const String &Name)=0
	Gets whether or not an effect preset exists within this handler. More...

virtual AutowahParameters	GetAutowahEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Autowah Effect. More...

virtual ChorusParameters	GetChorusEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Chorus Effect. More...

virtual CompressorParameters	GetCompressorEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Compressor Effect. More...

virtual DistortionParameters	GetDistortionEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Distortion Effect. More...

virtual EAXReverbParameters	GetEAXReverbEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the EAX Reverb Effect. More...

virtual EchoParameters	GetEchoEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Echo Effect. More...

virtual iEffect *	GetEffect (const UInt32 Index) const =0
	Gets an Audio::iEffect instance by index. More...

virtual EqualizerParameters	GetEqualizerEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Equalizer Effect. More...

virtual iFilter *	GetFilter (const UInt32 Index) const =0
	Gets an Audio::iFilter instance by index. More...

virtual FlangerParameters	GetFlangerEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Flanger Effect. More...

virtual FrequencyShiftParameters	GetFrequencyShiftEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Frequency Shift Effect. More...

virtual UInt32	GetNumEffects () const =0
	Gets the number of Audio::iEffect instances being stored by this handler. More...

virtual UInt32	GetNumFilters () const =0
	Gets the number of iFilter instances being stored by this handler. More...

virtual PitchShifterParameters	GetPitchShifterEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Pitch Shifter Effect. More...

virtual ReverbParameters	GetReverbEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Reverb Effect. More...

virtual RingModulatorParameters	GetRingModulatorEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Ring Modulator Effect. More...

virtual VocalMorpherParameters	GetVocalMorpherEffectPreset (const String &Name) const =0
	Returns a previously registered preset for the Vocal Morpher Effect. More...

virtual Boole	IsEffectSupported (const EffectType Type) const =0
	Checks to see if the given effect type is supported. More...

virtual Boole	IsFilterSupported (const FilterType Type) const =0
	Checks to see if the given filter type is supported. More...

virtual void	RemoveAllEffectPresets (const EffectType Type)=0
	Removes all effect presets for a specific effect type. More...

virtual void	RemoveEffectPreset (const EffectType Type, const String &Name)=0
	Removes a previously registered effect preset. More...

Detailed Description

This is an interface class for the creation, destruction, and overall management of audio effects.

Definition at line 58 of file effectshandler.h.

Member Function Documentation

virtual void Mezzanine::Audio::iEffectsHandler::AddAutowahEffectPreset	(	const String &	Name,
		const AutowahParameters &	Setting
	)

pure virtual

Adds a preset for the Autowah Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddChorusEffectPreset	(	const String &	Name,
		const ChorusParameters &	Setting
	)

pure virtual

Adds a preset for the Chorus Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddCompressorEffectPreset	(	const String &	Name,
		const CompressorParameters &	Setting
	)

pure virtual

Adds a preset for the Compressor Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddDistortionEffectPreset	(	const String &	Name,
		const DistortionParameters &	Setting
	)

pure virtual

Adds a preset for the Distortion Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddEAXReverbEffectPreset	(	const String &	Name,
		const EAXReverbParameters &	Setting
	)

pure virtual

Adds a preset for the EAX Reverb Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddEchoEffectPreset	(	const String &	Name,
		const EchoParameters &	Setting
	)

pure virtual

Adds a preset for the Echo Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddEqualizerEffectPreset	(	const String &	Name,
		const EqualizerParameters &	Setting
	)

pure virtual

Adds a preset for the Equalizer Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddFlangerEffectPreset	(	const String &	Name,
		const FlangerParameters &	Setting
	)

pure virtual

Adds a preset for the Flanger Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddFrequencyShiftEffectPreset	(	const String &	Name,
		const FrequencyShiftParameters &	Setting
	)

pure virtual

Adds a preset for the Frequency Shift Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddPitchShifterEffectPreset	(	const String &	Name,
		const PitchShifterParameters &	Setting
	)

pure virtual

Adds a preset for the Pitch Shifter Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddReverbEffectPreset	(	const String &	Name,
		const ReverbParameters &	Setting
	)

pure virtual

Adds a preset for the Reverb Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddRingModulatorEffectPreset	(	const String &	Name,
		const RingModulatorParameters &	Setting
	)

pure virtual

Adds a preset for the Ring Modulator Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual void Mezzanine::Audio::iEffectsHandler::AddVocalMorpherEffectPreset	(	const String &	Name,
		const VocalMorpherParameters &	Setting
	)

pure virtual

Adds a preset for the Vocal Morpher Audio Effect type.

Parameters

Name	The name to be given to the preset.
Setting	Parameter struct containing all the parameters to be given to this preset.

virtual iEffect* Mezzanine::Audio::iEffectsHandler::CreateEffect ( )

pure virtual

Creates an Audio Effect for use with Audio::Sound instances.

Returns: Returns a pointer to the created Effect, or NULL if there was an error.

virtual iFilter* Mezzanine::Audio::iEffectsHandler::CreateFilter ( )

pure virtual

Creates an Audio Filter for use with iSound instances.

Returns: Returns a pointer to the created Filter, or NULL if there was an error.

virtual void Mezzanine::Audio::iEffectsHandler::DestroyEffect ( iEffect * ToBeDestroyed )

pure virtual

Destroys a single Audio::iEffect instance.

Parameters

ToBeDestroyed A pointer to the Audio::iEffect to be destroyed.

virtual void Mezzanine::Audio::iEffectsHandler::DestroyFilter ( iFilter * ToBeDestroyed )

pure virtual

Destroys a single iFilter instance.

Parameters

ToBeDestroyed A pointer to the iFilter to be destroyed.

virtual Boole Mezzanine::Audio::iEffectsHandler::EffectPresetExists	(	const EffectType	Type,
		const String &	Name
	)

pure virtual

Gets whether or not an effect preset exists within this handler.

Parameters

Type	The effect type to be checked.
Name	The name of the preset to check for.

Returns: True if it exists, false if not.

virtual AutowahParameters Mezzanine::Audio::iEffectsHandler::GetAutowahEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Autowah Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual ChorusParameters Mezzanine::Audio::iEffectsHandler::GetChorusEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Chorus Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual CompressorParameters Mezzanine::Audio::iEffectsHandler::GetCompressorEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Compressor Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual DistortionParameters Mezzanine::Audio::iEffectsHandler::GetDistortionEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Distortion Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual EAXReverbParameters Mezzanine::Audio::iEffectsHandler::GetEAXReverbEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the EAX Reverb Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual EchoParameters Mezzanine::Audio::iEffectsHandler::GetEchoEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Echo Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual iEffect* Mezzanine::Audio::iEffectsHandler::GetEffect ( const UInt32 Index ) const

pure virtual

Gets an Audio::iEffect instance by index.

Parameters

Index The index of the Audio::iEffect instance to retrieve.

Returns: Returns a pointer to the Audio::iEffect at the specified index.

virtual EqualizerParameters Mezzanine::Audio::iEffectsHandler::GetEqualizerEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Equalizer Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual iFilter* Mezzanine::Audio::iEffectsHandler::GetFilter ( const UInt32 Index ) const

pure virtual

Gets an Audio::iFilter instance by index.

Parameters

Index The index of the Audio::iFilter instance to retrieve.

Returns: Returns a pointer to the Audio::iFilter at the specified index.

virtual FlangerParameters Mezzanine::Audio::iEffectsHandler::GetFlangerEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Flanger Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual FrequencyShiftParameters Mezzanine::Audio::iEffectsHandler::GetFrequencyShiftEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Frequency Shift Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual UInt32 Mezzanine::Audio::iEffectsHandler::GetNumEffects ( ) const

pure virtual

Gets the number of Audio::iEffect instances being stored by this handler.

Returns: Returns a UInt32 representing the number of Audio::iEffect instances contained in this handler.

virtual UInt32 Mezzanine::Audio::iEffectsHandler::GetNumFilters ( ) const

pure virtual

Gets the number of iFilter instances being stored by this handler.

Returns: Returns a UInt32 representing the number of iFilter instances contained in this handler.

virtual PitchShifterParameters Mezzanine::Audio::iEffectsHandler::GetPitchShifterEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Pitch Shifter Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual ReverbParameters Mezzanine::Audio::iEffectsHandler::GetReverbEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Reverb Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual RingModulatorParameters Mezzanine::Audio::iEffectsHandler::GetRingModulatorEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Ring Modulator Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual VocalMorpherParameters Mezzanine::Audio::iEffectsHandler::GetVocalMorpherEffectPreset ( const String & Name ) const

pure virtual

Returns a previously registered preset for the Vocal Morpher Effect.

Parameters

Name	The name of the preset to retrieve.

Returns: Returns the specified preset or the default parameters if the preset could not be found.

virtual Boole Mezzanine::Audio::iEffectsHandler::IsEffectSupported ( const EffectType Type ) const

pure virtual

Checks to see if the given effect type is supported.

Parameters

Type	The effect type to be checked.

Returns: Returns true if the effect is supported, false if the effect isn't supported.

virtual Boole Mezzanine::Audio::iEffectsHandler::IsFilterSupported ( const FilterType Type ) const

pure virtual

Checks to see if the given filter type is supported.

Parameters

Type	The filter type to be checked.

Returns: Returns true if the filter is supported, false if the filter isn't supported.

virtual void Mezzanine::Audio::iEffectsHandler::RemoveAllEffectPresets ( const EffectType Type )

pure virtual

Removes all effect presets for a specific effect type.

Parameters

Type	The type of effect to remove presets for, or ET_Null to remove all of them.

virtual void Mezzanine::Audio::iEffectsHandler::RemoveEffectPreset	(	const EffectType	Type,
		const String &	Name
	)

pure virtual

Removes a previously registered effect preset.

Parameters

Type	The type of effect to remove.
Name	The name of the preset to remove.

The documentation for this class was generated from the following file:

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Audio/effectshandler.h

Public Member Functions

Detailed Description

Member Function Documentation