cAudio::IAudioEffects Class Reference

Interface for Audio Effects in cAudio. More...

#include <IAudioEffects.h>

Inheritance diagram for cAudio::IAudioEffects:

Public Member Functions
virtual IEffect *	createEffect ()=0
	Creates an Audio Effect for use with audio sources.
virtual IFilter *	createFilter ()=0
	Creates an Audio Filter for use with audio sources.
virtual unsigned int	getMaxEffectsSupported () const =0
	Returns the max number of effects supported.
virtual bool	isEffectSupported (const EffectTypes &type) const =0
	Checks to see if the given effect type is supported.
virtual bool	isFilterSupported (const FilterTypes &type) const =0
	Checks to see if the given filter type is supported.
virtual bool	addEAXReverbEffectPreset (const char *name, const sEAXReverbParameters &setting)=0
	Adds a preset for the EAX Reverb Audio Effect type.
virtual bool	addReverbEffectPreset (const char *name, const sReverbParameters &setting)=0
	Adds a preset for the Reverb Audio Effect type.
virtual bool	addChorusEffectPreset (const char *name, const sChorusParameters &setting)=0
	Adds a preset for the Chorus Audio Effect type.
virtual bool	addDistortionEffectPreset (const char *name, const sDistortionParameters &setting)=0
	Adds a preset for the Distortion Audio Effect type.
virtual bool	addEchoEffectPreset (const char *name, const sEchoParameters &setting)=0
	Adds a preset for the Echo Audio Effect type.
virtual bool	addFlangerEffectPreset (const char *name, const sFlangerParameters &setting)=0
	Adds a preset for the Flanger Audio Effect type.
virtual bool	addFrequencyShiftEffectPreset (const char *name, const sFrequencyShiftParameters &setting)=0
	Adds a preset for the Frequency Shift Audio Effect type.
virtual bool	addVocalMorpherEffectPreset (const char *name, const sVocalMorpherParameters &setting)=0
	Adds a preset for the Vocal Morpher Audio Effect type.
virtual bool	addPitchShifterEffectPreset (const char *name, const sPitchShifterParameters &setting)=0
	Adds a preset for the Pitch Shifter Audio Effect type.
virtual bool	addRingModulatorEffectPreset (const char *name, const sRingModulatorParameters &setting)=0
	Adds a preset for the Ring Modulator Audio Effect type.
virtual bool	addAutowahEffectPreset (const char *name, const sAutowahParameters &setting)=0
	Adds a preset for the Autowah Audio Effect type.
virtual bool	addCompressorEffectPreset (const char *name, const sCompressorParameters &setting)=0
	Adds a preset for the Compressor Audio Effect type.
virtual bool	addEqualizerEffectPreset (const char *name, const sEqualizerParameters &setting)=0
	Adds a preset for the Equalizer Audio Effect type.
virtual sEAXReverbParameters	getEAXReverbEffectPreset (const char *name)=0
	Returns a previously registered preset for the EAX Reverb Effect.
virtual sReverbParameters	getReverbEffectPreset (const char *name)=0
	Returns a previously registered preset for the Reverb Effect.
virtual sChorusParameters	getChorusEffectPreset (const char *name)=0
	Returns a previously registered preset for the Chorus Effect.
virtual sDistortionParameters	getDistortionEffectPreset (const char *name)=0
	Returns a previously registered preset for the Distortion Effect.
virtual sEchoParameters	getEchoEffectPreset (const char *name)=0
	Returns a previously registered preset for the Echo Effect.
virtual sFlangerParameters	getFlangerEffectPreset (const char *name)=0
	Returns a previously registered preset for the Flanger Effect.
virtual sFrequencyShiftParameters	getFrequencyShiftEffectPreset (const char *name)=0
	Returns a previously registered preset for the Frequency Shift Effect.
virtual sVocalMorpherParameters	getVocalMorpherEffectPreset (const char *name)=0
	Returns a previously registered preset for the Vocal Morpher Effect.
virtual sPitchShifterParameters	getPitchShifterEffectPreset (const char *name)=0
	Returns a previously registered preset for the Pitch Shifter Effect.
virtual sRingModulatorParameters	getRingModulatorEffectPreset (const char *name)=0
	Returns a previously registered preset for the Ring Modulator Effect.
virtual sAutowahParameters	getAutowahEffectPreset (const char *name)=0
	Returns a previously registered preset for the Autowah Effect.
virtual sCompressorParameters	getCompressorEffectPreset (const char *name)=0
	Returns a previously registered preset for the Compressor Effect.
virtual sEqualizerParameters	getEqualizerEffectPreset (const char *name)=0
	Returns a previously registered preset for the Equalizer Effect.
virtual void	removeEffectPreset (const EffectTypes &type, const char *name)=0
	Removes a previously registered effect preset.
virtual bool	isEffectPresetRegistered (const EffectTypes &type, const char *name)=0
	Returns if a effect preset of a certain name is registered.
virtual void	removeAllEffectPresets (const EffectTypes &type)=0
	Removes all effect presets for a specific effect type.

Detailed Description

Interface for Audio Effects in cAudio.

Definition at line 17 of file IAudioEffects.h.

Member Function Documentation

virtual bool cAudio::IAudioEffects::addAutowahEffectPreset	(	const char *	name,
		const sAutowahParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Autowah Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addChorusEffectPreset	(	const char *	name,
		const sChorusParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Chorus Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addCompressorEffectPreset	(	const char *	name,
		const sCompressorParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Compressor Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addDistortionEffectPreset	(	const char *	name,
		const sDistortionParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Distortion Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addEAXReverbEffectPreset	(	const char *	name,
		const sEAXReverbParameters &	setting
	)			`[pure virtual]`

Adds a preset for the EAX Reverb Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addEchoEffectPreset	(	const char *	name,
		const sEchoParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Echo Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addEqualizerEffectPreset	(	const char *	name,
		const sEqualizerParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Equalizer Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addFlangerEffectPreset	(	const char *	name,
		const sFlangerParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Flanger Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addFrequencyShiftEffectPreset	(	const char *	name,
		const sFrequencyShiftParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Frequency Shift Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addPitchShifterEffectPreset	(	const char *	name,
		const sPitchShifterParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Pitch Shifter Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addReverbEffectPreset	(	const char *	name,
		const sReverbParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Reverb Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addRingModulatorEffectPreset	(	const char *	name,
		const sRingModulatorParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Ring Modulator Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::addVocalMorpherEffectPreset	(	const char *	name,
		const sVocalMorpherParameters &	setting
	)			`[pure virtual]`

Adds a preset for the Vocal Morpher Audio Effect type.

Parameters:

	name,:	Name of the preset.
	setting,:	Instance of the Effect parameter struct for this type of effect.

Returns:: True on success, False on failure.

Implemented in cAudio::cAudioEffects.

virtual IEffect* cAudio::IAudioEffects::createEffect ( ) [pure virtual]

Creates an Audio Effect for use with audio sources.

Returns:: Pointer to the created Effect instance.

Implemented in cAudio::cAudioEffects.

virtual IFilter* cAudio::IAudioEffects::createFilter ( ) [pure virtual]

Creates an Audio Filter for use with audio sources.

Returns:: Pointer to the created Filter instance.

Implemented in cAudio::cAudioEffects.

virtual sAutowahParameters cAudio::IAudioEffects::getAutowahEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Autowah Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sChorusParameters cAudio::IAudioEffects::getChorusEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Chorus Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sCompressorParameters cAudio::IAudioEffects::getCompressorEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Compressor Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sDistortionParameters cAudio::IAudioEffects::getDistortionEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Distortion Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sEAXReverbParameters cAudio::IAudioEffects::getEAXReverbEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the EAX Reverb Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sEchoParameters cAudio::IAudioEffects::getEchoEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Echo Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sEqualizerParameters cAudio::IAudioEffects::getEqualizerEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Equalizer Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sFlangerParameters cAudio::IAudioEffects::getFlangerEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Flanger Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sFrequencyShiftParameters cAudio::IAudioEffects::getFrequencyShiftEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Frequency Shift Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sPitchShifterParameters cAudio::IAudioEffects::getPitchShifterEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Pitch Shifter Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sReverbParameters cAudio::IAudioEffects::getReverbEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Reverb Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sRingModulatorParameters cAudio::IAudioEffects::getRingModulatorEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Ring Modulator Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual sVocalMorpherParameters cAudio::IAudioEffects::getVocalMorpherEffectPreset ( const char * name ) [pure virtual]

Returns a previously registered preset for the Vocal Morpher Effect.

Parameters:

name,:

Name of the preset to retrieve.

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

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::isEffectPresetRegistered	(	const EffectTypes &	type,
		const char *	name
	)			`[pure virtual]`

Returns if a effect preset of a certain name is registered.

Parameters:

	type,:	Type of the effect.
	name,:	Name of the preset.

Returns:: True if it exists, false if not.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::isEffectSupported ( const EffectTypes & type ) const [pure virtual]

Checks to see if the given effect type is supported.

Parameters:

type,:

the effect type to be checked.

Returns:: True if the effect is supported, False if the effect isn't supported.

Implemented in cAudio::cAudioEffects.

virtual bool cAudio::IAudioEffects::isFilterSupported ( const FilterTypes & type ) const [pure virtual]

Checks to see if the given filter type is supported.

Parameters:

type,:

the filter type to be checked.

Returns:: True if the filter is supported, False if the filter isn't supported.

Implemented in cAudio::cAudioEffects.

virtual void cAudio::IAudioEffects::removeAllEffectPresets ( const EffectTypes & type ) [pure virtual]

Removes all effect presets for a specific effect type.

Parameters:

type,:

Type of effect to remove presets for, or EET_NULL to remove all of them.

Implemented in cAudio::cAudioEffects.

virtual void cAudio::IAudioEffects::removeEffectPreset	(	const EffectTypes &	type,
		const char *	name
	)			`[pure virtual]`

Removes a previously registered effect preset.

Parameters:

	type,:	Type of effect to remove a preset for.
	name,:	Name of the preset to remove.

Implemented in cAudio::cAudioEffects.

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

C:/Users/Wildicv/Desktop/cAudio/cAudio/Trunk/include/IAudioEffects.h

cAudio::IAudioEffects Class Reference

Public Member Functions

Detailed Description

Member Function Documentation