A class representing a set of OpenAL effect properties. More...

#include <AudioEffectProperties.h>

Classes
struct	AutoWahProperties

struct	ChorusProperties

struct	CompressorProperties

struct	DistortionProperties

struct	EaxReverbProperties

struct	EchoProperties

struct	EqualizerProperties

struct	FlangerProperties

struct	FrequencyShifterProperties

struct	PitchShifterProperties

struct	ReverbProperties

struct	RingModulatorProperties

struct	VocalMorpherProperties

Public Types
enum	EfxReverbPresets { GENERIC , PADDED_CELL , ROOM , BATHROOM , LIVING_ROOM , STONE_ROOM , AUDITORIUM , CONCERT_HALL , CAVE , ARENA , HANGAR , CARPETED_HALLWAY , HALLWAY , STONE_CORRIDOR , ALLEY , FOREST , CITY , MOUNTAINS , QUARRY , PLAIN , PARKING_LOT , SEWER_PIPE , UNDERWATER , DRUGGED , DIZZY , PSYCHOTIC , CASTLE_SMALL_ROOM , CASTLE_SHORT_PASSAGE , CASTLE_MEDIUM_ROOM , CASTLE_LARGE_ROOM , CASTLE_LONG_PASSAGE , CASTLE_HALL , CASTLE_CUPBOARD , CASTLE_COURTYARD , CASTLE_ALCOVE , FACTORY_SMALL_ROOM , FACTORY_SHORT_PASSAGE , FACTORY_MEDIUM_ROOM , FACTORY_LARGE_ROOM , FACTORY_LONG_PASSAGE , FACTORY_HALL , FACTORY_CUPBOARD , FACTORY_COURTYARD , FACTORY_ALCOVE , ICEPALACE_SMALL_ROOM , ICEPALACE_SHORT_PASSAGE , ICEPALACE_MEDIUM_ROOM , ICEPALACE_LARGE_ROOM , ICEPALACE_LONG_PASSAGE , ICEPALACE_HALL , ICEPALACE_CUPBOARD , ICEPALACE_COURTYARD , ICEPALACE_ALCOVE , SPACE_STATION_SMALL_ROOM , SPACE_STATION_SHORT_PASSAGE , SPACE_STATION_MEDIUM_ROOM , SPACE_STATION_LARGE_ROOM , SPACE_STATION_LONG_PASSAGE , SPACE_STATION_HALL , SPACE_STATION_CUPBOARD , SPACE_STATION_ALCOVE , WOODEN_GALLEON_SMALL_ROOM , WOODEN_GALLEON_SHORT_PASSAGE , WOODEN_GALLEON_MEDIUM_ROOM , WOODEN_GALLEON_LARGE_ROOM , WOODEN_GALLEON_LONG_PASSAGE , WOODEN_GALLEON_HALL , WOODEN_GALLEON_CUPBOARD , WOODEN_GALLEON_COURTYARD , WOODEN_GALLEON_ALCOVE , SPORT_EMPTY_STADIUM , SPORT_SQUASH_COURT , SPORT_SMALL_SWIMMING_POOL , SPORT_LARGE_SWIMMING_POOL , SPORT_GYMNASIUM , SPORT_FULL_STADIUM , SPORT_STADIUM_TANNOY , PREFAB_WORKSHOP , PREFAB_SCHOOL_ROOM , PREFAB_PRACTISE_ROOM , PREFAB_OUTHOUSE , PREFAB_CARAVAN , DOME_TOMB , PIPE_SMALL , DOME_SAINT_PAULS , PIPE_LONGTHIN , PIPE_LARGE , PIPE_RESONANT , OUTDOORS_BACKYARD , OUTDOORS_ROLLING_PLAINS , OUTDOORS_DEEP_CANYON , OUTDOORS_CREEK , OUTDOORS_VALLEY , MOOD_HEAVEN , MOOD_HELL , MOOD_MEMORY , DRIVING_COMMENTATOR , DRIVING_PIT_GARAGE , DRIVING_INCAR_RACER , DRIVING_INCAR_SPORTS , DRIVING_INCAR_LUXURY , DRIVING_FULL_GRANDSTAND , DRIVING_EMPTY_GRANDSTAND , DRIVING_TUNNEL , CITY_STREETS , CITY_SUBWAY , CITY_MUSEUM , CITY_LIBRARY , CITY_UNDERPASS , CITY_ABANDONED , DUSTY_ROOM , CHAPEL , SMALL_WATER_ROOM , COUNT }

Public Member Functions
	AudioEffectProperties ()
	Creates an empty of properties without any effect type.

	AudioEffectProperties (AudioEffect::Type type)
	Creates a set of properties for an effect type.

	AudioEffectProperties (AudioEffectProperties &&other)=default
	Default move constructor.

AudioEffectProperties &	operator= (AudioEffectProperties &&other)=default
	Default move assignment operator.

	AudioEffectProperties (const AudioEffectProperties &)=default
	Default copy constructor.

AudioEffectProperties &	operator= (const AudioEffectProperties &)=default
	DEfault assignment operator.

AudioEffect::Type	type () const
	Returns the effect properties type.

void	setType (AudioEffect::Type type)
	Sets the effect properties type.

const ReverbProperties &	reverbProperties () const
	Returns the current constant values for the reverb effect properties.

ReverbProperties &	reverbProperties ()
	Returns the current values for the reverb effect properties.

void	setReverbProperties (const ReverbProperties &newReverbProperties)
	Sets all values for the reverb effect properties.

void	resetReverbProperties ()
	Resets all property values for the reverb effect to thir default.

const EaxReverbProperties &	eaxReverbProperties () const
	Returns the current constant values for the EAX reverb effect properties.

EaxReverbProperties &	eaxReverbProperties ()
	Returns the current values for the EAX reverb effect properties.

void	setEaxReverbProperties (const EaxReverbProperties &newEaxReverbProperties)
	Sets all values for the EAX reverb effect properties.

void	resetEaxReverbProperties ()
	Resets all property values for the EAX reverb effect to thir default.

const ChorusProperties &	chorusProperties () const
	Returns the current constant values for the chorus effect properties.

ChorusProperties &	chorusProperties ()
	Returns the current values for the chorus effect properties.

void	setChorusProperties (const ChorusProperties &newChorusProperties)
	Sets all values for the chorus effect properties.

void	resetChorusProperties ()
	Resets all property values for the chorus effect to thir default.

const DistortionProperties &	distortionProperties () const
	Returns the current constant values for the distortion effect properties.

DistortionProperties &	distortionProperties ()
	Returns the current values for the distortion effect properties.

void	setDistortionProperties (const DistortionProperties &newDistortionProperties)
	Sets all values for the distortion effect properties.

void	resetDistortionProperties ()
	Resets all property values for the distortion effect to thir default.

const EchoProperties &	echoProperties () const
	Returns the current constant values for the echo effect properties.

EchoProperties &	echoProperties ()
	Returns the current values for the echo effect properties.

void	setEchoProperties (const EchoProperties &newEchoProperties)
	Sets all values for the echo effect properties.

void	resetEchoProperties ()
	Resets all property values for the echo effect to thir default.

const FlangerProperties &	flangerProperties () const
	Returns the current constant values for the flanger effect properties.

FlangerProperties &	flangerProperties ()
	Returns the current values for the flanger effect properties.

void	setFlangerProperties (const FlangerProperties &newFlangerProperties)
	Sets all values for the flanger effect properties.

void	resetFlangerProperties ()
	Resets all property values for the flanger effect to thir default.

const FrequencyShifterProperties &	frequencyShifterProperties () const
	Returns the current constant values for the frequency shifter effect properties.

FrequencyShifterProperties &	frequencyShifterProperties ()
	Returns the current values for the frequency shifter effect properties.

void	setFrequencyShifterProperties (const FrequencyShifterProperties &newFrequencyShifterProperties)
	Sets all values for the frequency shifter effect properties.

void	resetFrequencyShifterProperties ()
	Resets all property values for the frequency shifter effect to thir default.

const VocalMorpherProperties &	vocalMorpherProperties () const
	Returns the current constant values for the vocal morpher effect properties.

VocalMorpherProperties &	vocalMorpherProperties ()
	Returns the current values for the vocal morpher effect properties.

void	setVocalMorpherProperties (const VocalMorpherProperties &newVocalMorpherProperties)
	Sets all values for the vocal morpher effect properties.

void	resetVocalMorpherProperties ()
	Resets all property values for the vocal morpher effect to thir default.

const PitchShifterProperties &	pitchShifterProperties () const
	Returns the current constant values for the pitch shifter effect properties.

PitchShifterProperties &	pitchShifterProperties ()
	Returns the current values for the pitch shifter effect properties.

void	setPitchShifterProperties (const PitchShifterProperties &newPitchShifterProperties)
	Sets all values for the pitch shifter effect properties.

void	resetPitchShifterProperties ()
	Resets all property values for the pitch shifter effect to thir default.

const RingModulatorProperties &	ringModulatorProperties () const
	Returns the current constant values for the ring modulator effect properties.

RingModulatorProperties &	ringModulatorProperties ()
	Returns the current values for the ring modulator effect properties.

void	setRingModulatorProperties (const RingModulatorProperties &newRingModulatorProperties)
	Sets all values for the ring modulator effect properties.

void	resetRingModulatorProperties ()
	Resets all property values for the ring modulator effect to thir default.

const AutoWahProperties &	autoWahProperties () const
	Returns the current constant values for the auto wah effect properties.

AutoWahProperties &	autoWahProperties ()
	Returns the current values for the auto wah effect properties.

void	setAutoWahProperties (const AutoWahProperties &newAutoWahProperties)
	Sets all values for the auto wah effect properties.

void	resetAutoWahProperties ()
	Resets all property values for the auto wah effect to thir default.

const CompressorProperties &	compressorProperties () const
	Returns the current constant values for the compressor effect properties.

CompressorProperties &	compressorProperties ()
	Returns the current values for the compressor effect properties.

void	setCompressorProperties (const CompressorProperties &newCompressorProperties)
	Sets all values for the compressor effect properties.

void	resetCompressorProperties ()
	Resets all property values for the compressor effect to thir default.

const EqualizerProperties &	equalizerProperties () const
	Returns the current constant values for the equalizer effect properties.

EqualizerProperties &	equalizerProperties ()
	Returns the current values for the equalizer effect properties.

void	setEqualizerProperties (const EqualizerProperties &newEqualizerProperties)
	Sets all values for the equalizer effect properties.

void	resetEqualizerProperties ()
	Resets all property values for the equalizer effect to thir default.

Static Public Member Functions
static ReverbProperties	minReverbProperties ()
	Returns the minimum values for the reverb effect properties.

static ReverbProperties	maxReverbProperties ()
	Returns the maximum values for the reverb effect properties.

static EaxReverbProperties	minEaxReverbProperties ()
	Returns the minimum values for the EAX reverb effect properties.

static EaxReverbProperties	maxEaxReverbProperties ()
	Returns the maximum values for the EAX reverb effect properties.

static ChorusProperties	minChorusProperties ()
	Returns the minimum values for the chorus effect properties.

static ChorusProperties	maxChorusProperties ()
	Returns the maximum values for the chorus effect properties.

static DistortionProperties	minDistortionProperties ()
	Returns the minimum values for the distortion effect properties.

static DistortionProperties	maxDistortionProperties ()
	Returns the maximum values for the distortion effect properties.

static EchoProperties	minEchoProperties ()
	Returns the minimum values for the echo effect properties.

static EchoProperties	maxEchoProperties ()
	Returns the maximum values for the echo effect properties.

static FlangerProperties	minFlangerProperties ()
	Returns the minimum values for the flanger effect properties.

static FlangerProperties	maxFlangerProperties ()
	Returns the maximum values for the flanger effect properties.

static FrequencyShifterProperties	minFrequencyShifterProperties ()
	Returns the minimum values for the frequency shifter effect properties.

static FrequencyShifterProperties	maxFrequencyShifterProperties ()
	Returns the maximum values for the frequency shifter effect properties.

static VocalMorpherProperties	minVocalMorpherProperties ()
	Returns the minimum values for the vocal morpher effect properties.

static VocalMorpherProperties	maxVocalMorpherProperties ()
	Returns the maximum values for the vocal morpher effect properties.

static PitchShifterProperties	minPitchShifterProperties ()
	Returns the minimum values for the pitch shifter effect properties.

static PitchShifterProperties	maxPitchShifterProperties ()
	Returns the maximum values for the pitch shifter effect properties.

static RingModulatorProperties	minRingModulatorProperties ()
	Returns the minimum values for the ring modulator effect properties.

static RingModulatorProperties	maxRingModulatorProperties ()
	Returns the maximum values for the ring modulator effect properties.

static AutoWahProperties	minAutoWahProperties ()
	Returns the minimum values for the auto wah effect properties.

static AutoWahProperties	maxAutoWahProperties ()
	Returns the maximum values for the auto wah effect properties.

static CompressorProperties	minCompressorProperties ()
	Returns the minimum values for the compressor effect properties.

static CompressorProperties	maxCompressorProperties ()
	Returns the maximum values for the compressor effect properties.

static EqualizerProperties	minEqualizerProperties ()
	Returns the minimum values for the equalizer effect properties.

static EqualizerProperties	maxEqualizerProperties ()
	Returns the maximum values for the equalizer effect properties.

Detailed Description

A class representing a set of OpenAL effect properties.

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

include/ncine/AudioEffectProperties.h
src/audio/AudioEffectProperties.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description