cAudio::IEffect Class Reference

Interface for a single effect in cAudio. More...

#include <IEffect.h>

Inheritance diagram for cAudio::IEffect:

[legend]

Collaboration diagram for cAudio::IEffect:

[legend]

List of all members.

Public Member Functions
virtual const EffectTypes &	getType () const =0
	Returns the current type this effect object is set to.
virtual void	setType (const EffectTypes &type)=0
	Sets the type of this effect object.
virtual const sEAXReverbParameters &	getEAXReverbParameters () const =0
	Returns the current parameters for the EAX Reverb Effect.
virtual void	setEAXReverbParameters (const sEAXReverbParameters &param)=0
	Sets the parameters for the EAX Reverb Effect.
virtual const sReverbParameters &	getReverbParameters () const =0
	Returns the current parameters for the Reverb Effect.
virtual void	setReverbParameters (const sReverbParameters &param)=0
	Sets the parameters for the Reverb Effect.
virtual const sChorusParameters &	getChorusParameters () const =0
	Returns the current parameters for the Chorus Effect.
virtual void	setChorusParameters (const sChorusParameters &param)=0
	Sets the parameters for the Chorus Effect.
virtual const sDistortionParameters &	getDistortionParameters () const =0
	Returns the current parameters for the Distortion Effect.
virtual void	setDistortionParameters (const sDistortionParameters &param)=0
	Sets the parameters for the Distortion Effect.
virtual const sEchoParameters &	getEchoParameters () const =0
	Returns the current parameters for the Echo Effect.
virtual void	setEchoParameters (const sEchoParameters &param)=0
	Sets the parameters for the Echo Effect.
virtual const sFlangerParameters &	getFlangerParameters () const =0
	Returns the current parameters for the Flanger Effect.
virtual void	setFlangerParameters (const sFlangerParameters &param)=0
	Sets the parameters for the Flanger Effect.
virtual const sFrequencyShiftParameters &	getFrequencyShiftParameters () const =0
	Returns the current parameters for the Frequency Shift Effect.
virtual void	setFrequencyShiftParameters (const sFrequencyShiftParameters &param)=0
	Sets the parameters for the Frequency Shift Effect.
virtual const sVocalMorpherParameters &	getVocalMorpherParameters () const =0
	Returns the current parameters for the Vocal Morpher Effect.
virtual void	setVocalMorpherParameters (const sVocalMorpherParameters &param)=0
	Sets the parameters for the Vocal Morpher Effect.
virtual const sPitchShifterParameters &	getPitchShifterParameters () const =0
	Returns the current parameters for the Pitch Shifter Effect.
virtual void	setPitchShifterParameters (const sPitchShifterParameters &param)=0
	Sets the parameters for the Pitch Shifter Effect.
virtual const sRingModulatorParameters &	getRingModulatorParameters () const =0
	Returns the current parameters for the Ring Modulator Effect.
virtual void	setRingModulatorParameters (const sRingModulatorParameters &param)=0
	Sets the parameters for the Ring Modulator Effect.
virtual const sAutowahParameters &	getAutowahParameters () const =0
	Returns the current parameters for the Autowah Effect.
virtual void	setAutowahParameters (const sAutowahParameters &param)=0
	Sets the parameters for the Autowah Effect.
virtual const sCompressorParameters &	getCompressorParameters () const =0
	Returns the current parameters for the Compressor Effect.
virtual void	setCompressorParameters (const sCompressorParameters &param)=0
	Sets the parameters for the Compressor Effect.
virtual const sEqualizerParameters &	getEqualizerParameters () const =0
	Returns the current parameters for the Equalizer Effect.
virtual void	setEqualizerParameters (const sEqualizerParameters &param)=0
	Sets the parameters for the Equalizer Effect.
virtual float	getMasterVolume () const =0
	Returns the master volume for this effect.
virtual void	setMasterVolume (const float &volume)=0
	Sets the master volume for this effect.
virtual bool	isIgnoringAttenuation () const =0
	Returns if the effect for each attached source is attenuated by distance.
virtual void	ignoreAttenuation (const bool &ignore)=0
	Sets whether the effect for each attached source is attenuated by distance.
virtual IFilter *	getFilter () const =0
	Returns the attached filter to this audio effect.
virtual void	attachFilter (IFilter *filter)=0
	Attaches a filter to this effect.
virtual void	removeFilter ()=0
	Removes the currently attached filter.
virtual unsigned int	getLastUpdated () const =0
	Returns a timestamp indicating the last time settings on this effect were changed. Used internally by the engine to update attached sources.
virtual bool	isValid () const =0
	Returns if this effect is ready to be used or if it has encountered a fatal error.

---

Detailed Description

Interface for a single effect in cAudio.

Definition at line 38 of file IEffect.h.

---

Member Function Documentation

virtual void cAudio::IEffect::attachFilter

(

IFilter *

filter

)

[pure virtual]

Attaches a filter to this effect.

Parameters:

filter,:

A Pointer to the filter to attach.

Implemented in cAudio::cEffect.

virtual float cAudio::IEffect::getMasterVolume

(

)

const [pure virtual]

Returns the master volume for this effect.

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

Returns:

Currently set volume.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::ignoreAttenuation

(

const bool &

ignore

)

[pure virtual]

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

If set to true, can cause some interesting and non-realistic effects, so be careful with it.

Parameters:

ignore,:

Whether to ignore attenuation.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setAutowahParameters

(

const sAutowahParameters &

param

)

[pure virtual]

Sets the parameters for the Autowah Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setChorusParameters

(

const sChorusParameters &

param

)

[pure virtual]

Sets the parameters for the Chorus Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setCompressorParameters

(

const sCompressorParameters &

param

)

[pure virtual]

Sets the parameters for the Compressor Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setDistortionParameters

(

const sDistortionParameters &

param

)

[pure virtual]

Sets the parameters for the Distortion Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setEAXReverbParameters

(

const sEAXReverbParameters &

param

)

[pure virtual]

Sets the parameters for the EAX Reverb Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setEchoParameters

(

const sEchoParameters &

param

)

[pure virtual]

Sets the parameters for the Echo Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setEqualizerParameters

(

const sEqualizerParameters &

param

)

[pure virtual]

Sets the parameters for the Equalizer Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setFlangerParameters

(

const sFlangerParameters &

param

)

[pure virtual]

Sets the parameters for the Flanger Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setFrequencyShiftParameters

(

const sFrequencyShiftParameters &

param

)

[pure virtual]

Sets the parameters for the Frequency Shift Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setMasterVolume

(

const float &

volume

)

[pure virtual]

Sets the master volume for this effect.

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

Parameters:

volume,:

Volume to set the master volume to. 1.0f equal no volume change. Range: 0.0f to 1.0.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setPitchShifterParameters

(

const sPitchShifterParameters &

param

)

[pure virtual]

Sets the parameters for the Pitch Shifter Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setReverbParameters

(

const sReverbParameters &

param

)

[pure virtual]

Sets the parameters for the Reverb Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setRingModulatorParameters

(

const sRingModulatorParameters &

param

)

[pure virtual]

Sets the parameters for the Ring Modulator Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setType

(

const EffectTypes &

type

)

[pure virtual]

Sets the type of this effect object.

Parameters:

type,:

Type of effect to switch to.

Implemented in cAudio::cEffect.

virtual void cAudio::IEffect::setVocalMorpherParameters

(

const sVocalMorpherParameters &

param

)

[pure virtual]

Sets the parameters for the Vocal Morpher Effect.

Parameters:

param,:

Parameter struct to set this effect to.

Implemented in cAudio::cEffect.

---

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

• C:/Users/Wildicv/Desktop/cAudio/cAudio/Trunk/include/IEffect.h