Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::Audio::iEffect Class Referenceabstract

This is an interface class for an effect that can be applied to a sound. More...

#include <effect.h>

Public Member Functions

 iEffect ()
 Class constructor.
 
virtual ~iEffect ()
 Class destructor.
 
virtual void AttachFilter (iFilter *Fil)=0
 Attaches a filter to this effect. More...
 
virtual AutowahParameters GetAutowahParameters () const =0
 Gets the current parameters for the Autowah Effect. More...
 
virtual ChorusParameters GetChorusParameters () const =0
 Gets the current parameters for the Chorus Effect. More...
 
virtual CompressorParameters GetCompressorParameters () const =0
 Gets the current parameters for the Compressor Effect. More...
 
virtual DistortionParameters GetDistortionParameters () const =0
 Gets the current parameters for the Distortion Effect. More...
 
virtual EAXReverbParameters GetEAXReverbParameters () const =0
 Gets the current parameters for the EAX Reverb Effect. More...
 
virtual EchoParameters GetEchoParameters () const =0
 Gets the current parameters for the Echo Effect. More...
 
virtual EqualizerParameters GetEqualizerParameters () const =0
 Gets the current parameters for the Equalizer Effect. More...
 
virtual iFilterGetFilter () const =0
 Gets the filter being used by this effect. More...
 
virtual FlangerParameters GetFlangerParameters () const =0
 Gets the current parameters for the Flanger Effect. More...
 
virtual FrequencyShiftParameters GetFrequencyShiftParameters () const =0
 Gets the current parameters for the Frequency Shift Effect. More...
 
virtual PitchShifterParameters GetPitchShifterParameters () const =0
 Gets the current parameters for the PitchShifter Effect. More...
 
virtual ReverbParameters GetReverbParameters () const =0
 Gets the current parameters for the Reverb Effect. More...
 
virtual RingModulatorParameters GetRingModulatorParameters () const =0
 Gets the current parameters for the Ring Modulator Effect. More...
 
virtual EffectType GetType () const =0
 Gets the type of effect this is. More...
 
virtual VocalMorpherParameters GetVocalMorpherParameters () const =0
 Gets the current parameters for the Vocal Morpher Effect. More...
 
virtual Real GetVolume () const =0
 Gets the volume for this effect. More...
 
virtual void IgnoreAttenuation (Boole Ignore)=0
 Sets whether the effect for each attached source is attenuated by distance. More...
 
virtual Boole IsIgnoringAttenuation () const =0
 Gets whether or not attached sources are attenuated by distance. More...
 
virtual Boole IsValid () const =0
 Gets whether or not this effect is ready for use. More...
 
virtual void RemoveFilter ()=0
 Removes the currently attached filter.
 
virtual void SetAutowahParameters (const AutowahParameters &Param)=0
 Sets the parameters for the Autowah Effect. More...
 
virtual void SetChorusParameters (const ChorusParameters &Param)=0
 Sets the parameters for the Chorus Effect. More...
 
virtual void SetCompressorParameters (const CompressorParameters &Param)=0
 Sets the parameters for the Compressor Effect. More...
 
virtual void SetDistortionParameters (const DistortionParameters &Param)=0
 Sets the parameters for the Distortion Effect. More...
 
virtual void SetEAXReverbParameters (const EAXReverbParameters &Param)=0
 Sets the parameters for the EAX Reverb Effect. More...
 
virtual void SetEchoParameters (const EchoParameters &Param)=0
 Sets the parameters for the Echo Effect. More...
 
virtual void SetEqualizerParameters (const EqualizerParameters &Param)=0
 Sets the parameters for the Equalizer Effect. More...
 
virtual void SetFlangerParameters (const FlangerParameters &Param)=0
 Sets the parameters for the Flanger Effect. More...
 
virtual void SetFrequencyShiftParameters (const FrequencyShiftParameters &Param)=0
 Sets the parameters for the Frequency Shift Effect. More...
 
virtual void SetPitchShifterParameters (const PitchShifterParameters &Param)=0
 Sets the parameters for the Pitch Shifter Effect. More...
 
virtual void SetReverbParameters (const ReverbParameters &Param)=0
 Sets the parameters for the Reverb Effect. More...
 
virtual void SetRingModulatorParameters (const RingModulatorParameters &Param)=0
 Sets the parameters for the Ring Modulator Effect. More...
 
virtual void SetType (const EffectType &EffType)=0
 Sets the type of this effect. More...
 
virtual void SetVocalMorpherParameters (const VocalMorpherParameters &Param)=0
 Sets the parameters for the Vocal Morpher Effect. More...
 
virtual void SetVolume (const Real Vol)=0
 Sets the master volume for this effect. More...
 

Detailed Description

This is an interface class for an effect that can be applied to a sound.

Definition at line 58 of file effect.h.

Member Function Documentation

virtual void Mezzanine::Audio::iEffect::AttachFilter ( iFilter Fil)
pure virtual

Attaches a filter to this effect.

Parameters
FilA Pointer to the filter to attach.
virtual AutowahParameters Mezzanine::Audio::iEffect::GetAutowahParameters ( ) const
pure virtual

Gets the current parameters for the Autowah Effect.

Returns
Returns an AutowahParameters struct containing the currently set parameters.
virtual ChorusParameters Mezzanine::Audio::iEffect::GetChorusParameters ( ) const
pure virtual

Gets the current parameters for the Chorus Effect.

Returns
Returns an ChorusParameters struct containing the currently set parameters.
virtual CompressorParameters Mezzanine::Audio::iEffect::GetCompressorParameters ( ) const
pure virtual

Gets the current parameters for the Compressor Effect.

Returns
Returns an CompressorParameters struct containing the currently set parameters.
virtual DistortionParameters Mezzanine::Audio::iEffect::GetDistortionParameters ( ) const
pure virtual

Gets the current parameters for the Distortion Effect.

Returns
Returns an DistortionParameters struct containing the currently set parameters.
virtual EAXReverbParameters Mezzanine::Audio::iEffect::GetEAXReverbParameters ( ) const
pure virtual

Gets the current parameters for the EAX Reverb Effect.

Returns
Returns an EAXReverbParameters struct containing the currently set parameters.
virtual EchoParameters Mezzanine::Audio::iEffect::GetEchoParameters ( ) const
pure virtual

Gets the current parameters for the Echo Effect.

Returns
Returns an EchoParameters struct containing the currently set parameters.
virtual EqualizerParameters Mezzanine::Audio::iEffect::GetEqualizerParameters ( ) const
pure virtual

Gets the current parameters for the Equalizer Effect.

Returns
Returns an EqualizerParameters struct containing the currently set parameters.
virtual iFilter* Mezzanine::Audio::iEffect::GetFilter ( ) const
pure virtual

Gets the filter being used by this effect.

Returns
Returns the filter attached to this effect.
virtual FlangerParameters Mezzanine::Audio::iEffect::GetFlangerParameters ( ) const
pure virtual

Gets the current parameters for the Flanger Effect.

Returns
Returns an FlangerParameters struct containing the currently set parameters.
virtual FrequencyShiftParameters Mezzanine::Audio::iEffect::GetFrequencyShiftParameters ( ) const
pure virtual

Gets the current parameters for the Frequency Shift Effect.

Returns
Returns an FrequencyShiftParameters struct containing the currently set parameters.
virtual PitchShifterParameters Mezzanine::Audio::iEffect::GetPitchShifterParameters ( ) const
pure virtual

Gets the current parameters for the PitchShifter Effect.

Returns
Returns an PitchShifterParameters struct containing the currently set parameters.
virtual ReverbParameters Mezzanine::Audio::iEffect::GetReverbParameters ( ) const
pure virtual

Gets the current parameters for the Reverb Effect.

Returns
Returns an ReverbParameters struct containing the currently set parameters.
virtual RingModulatorParameters Mezzanine::Audio::iEffect::GetRingModulatorParameters ( ) const
pure virtual

Gets the current parameters for the Ring Modulator Effect.

Returns
Returns an RingModulatorParameters struct containing the currently set parameters.
virtual EffectType Mezzanine::Audio::iEffect::GetType ( ) const
pure virtual

Gets the type of effect this is.

Returns
Returns the current type this effect object is set to.
virtual VocalMorpherParameters Mezzanine::Audio::iEffect::GetVocalMorpherParameters ( ) const
pure virtual

Gets the current parameters for the Vocal Morpher Effect.

Returns
Returns an VocalMorpherParameters struct containing the currently set parameters.
virtual Real Mezzanine::Audio::iEffect::GetVolume ( ) const
pure virtual

Gets the volume for this effect.

Remarks
This volume scales the amount of effect audible from all attached sources.
Returns
Returns a Real representing the currently set volume.
virtual void Mezzanine::Audio::iEffect::IgnoreAttenuation ( Boole  Ignore)
pure virtual

Sets whether the effect for each attached source is attenuated by distance.

Remarks
If set to true, can cause some interesting and non-realistic effects, so be careful with it.
Parameters
IgnoreWhether or not to ignore attenuation.
virtual Boole Mezzanine::Audio::iEffect::IsIgnoringAttenuation ( ) const
pure virtual

Gets whether or not attached sources are attenuated by distance.

Returns
Returns true if the effect for each attached source is attenuated by distance.
virtual Boole Mezzanine::Audio::iEffect::IsValid ( ) const
pure virtual

Gets whether or not this effect is ready for use.

Returns
Returns if this effect is ready to be used or if it has encountered a fatal error.
virtual void Mezzanine::Audio::iEffect::SetAutowahParameters ( const AutowahParameters Param)
pure virtual

Sets the parameters for the Autowah Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetChorusParameters ( const ChorusParameters Param)
pure virtual

Sets the parameters for the Chorus Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetCompressorParameters ( const CompressorParameters Param)
pure virtual

Sets the parameters for the Compressor Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetDistortionParameters ( const DistortionParameters Param)
pure virtual

Sets the parameters for the Distortion Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetEAXReverbParameters ( const EAXReverbParameters Param)
pure virtual

Sets the parameters for the EAX Reverb Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetEchoParameters ( const EchoParameters Param)
pure virtual

Sets the parameters for the Echo Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetEqualizerParameters ( const EqualizerParameters Param)
pure virtual

Sets the parameters for the Equalizer Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetFlangerParameters ( const FlangerParameters Param)
pure virtual

Sets the parameters for the Flanger Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetFrequencyShiftParameters ( const FrequencyShiftParameters Param)
pure virtual

Sets the parameters for the Frequency Shift Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetPitchShifterParameters ( const PitchShifterParameters Param)
pure virtual

Sets the parameters for the Pitch Shifter Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetReverbParameters ( const ReverbParameters Param)
pure virtual

Sets the parameters for the Reverb Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetRingModulatorParameters ( const RingModulatorParameters Param)
pure virtual

Sets the parameters for the Ring Modulator Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetType ( const EffectType EffType)
pure virtual

Sets the type of this effect.

Parameters
EffTypeType of effect to switch to.
virtual void Mezzanine::Audio::iEffect::SetVocalMorpherParameters ( const VocalMorpherParameters Param)
pure virtual

Sets the parameters for the Vocal Morpher Effect.

Parameters
ParamParameter struct populated with the settings for this effect.
virtual void Mezzanine::Audio::iEffect::SetVolume ( const Real  Vol)
pure virtual

Sets the master volume for this effect.

Remarks
This volume scales the amount of effect audible from all attached sources.

1.0f equal no volume change. Range: 0.0f to 1.0
Parameters
VolThe volume to be set.

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