MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Mezzanine::Audio::iFilter Class Referenceabstract

This is an interface class for the application of filters to audio playback. More...

#include <filter.h>

Public Member Functions

 iFilter ()
 Class constructor.
 
virtual ~iFilter ()
 Class destructor.
 
virtual Real GetHighFrequencyVolume () const =0
 Gets the high frequency volume of this filter. More...
 
virtual Real GetLowFrequencyVolume () const =0
 Gets the low frequency volume of this filter. More...
 
virtual FilterType GetType () const =0
 Gets the type of filter this is. More...
 
virtual Real GetVolume () const =0
 Gets the master volume of this filter. More...
 
virtual bool IsValid () const =0
 Gets whether or not this filter is ready to be used. More...
 
virtual void SetHighFrequencyVolume (const Real HFVol)=0
 Sets the high frequency volume of this filter. More...
 
virtual void SetLowFrequencyVolume (const Real LFVol)=0
 Sets the low frequency volume of this filter. More...
 
virtual void SetType (const FilterType FilType)=0
 Sets the type of filter this is. More...
 
virtual void SetVolume (const Real Vol)=0
 Sets the master volume of this filter. More...
 

Detailed Description

This is an interface class for the application of filters to audio playback.

Definition at line 57 of file filter.h.

Member Function Documentation

virtual Real Mezzanine::Audio::iFilter::GetHighFrequencyVolume ( ) const
pure virtual

Gets the high frequency volume of this filter.

Returns
Returns a Real representing the volume scale being applied to higher frequency audio passing through this filter.
virtual Real Mezzanine::Audio::iFilter::GetLowFrequencyVolume ( ) const
pure virtual

Gets the low frequency volume of this filter.

Returns
Returns a Real representing the volume scale being applied to lower frequency audio passing through this filter.
virtual FilterType Mezzanine::Audio::iFilter::GetType ( ) const
pure virtual

Gets the type of filter this is.

Returns
Returns the type of filter this filter is currently set as.
virtual Real Mezzanine::Audio::iFilter::GetVolume ( ) const
pure virtual

Gets the master volume of this filter.

Returns
Returns a Real representing the volume scale being applied to all audio passing through this filter.
virtual bool Mezzanine::Audio::iFilter::IsValid ( ) const
pure virtual

Gets whether or not this filter is ready to be used.

Returns
Returns true if this filter is ready for use, or false if there is an error.
virtual void Mezzanine::Audio::iFilter::SetHighFrequencyVolume ( const Real  HFVol)
pure virtual

Sets the high frequency volume of this filter.

Note
Valid range: 0.0 to 1.0.
Parameters
HFVolThe volume scale to apply to higher frequency audio passed through this filter.
virtual void Mezzanine::Audio::iFilter::SetLowFrequencyVolume ( const Real  LFVol)
pure virtual

Sets the low frequency volume of this filter.

Note
Valid range: 0.0 to 1.0.
Parameters
LFVolThe volume scale to apply to lower frequency audio passed through this filter.
virtual void Mezzanine::Audio::iFilter::SetType ( const FilterType  FilType)
pure virtual

Sets the type of filter this is.

Parameters
FilTypeThe type of filter to set this as. See enum FilterType for more information.
virtual void Mezzanine::Audio::iFilter::SetVolume ( const Real  Vol)
pure virtual

Sets the master volume of this filter.

Note
Valid range: 0.0 to 1.0.
Parameters
VolThe volume scale to apply to all audio passed through this filter.

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