CEnvironmentalReverb Class Reference

#include <EnvironmentalReverbBase.h>

Link against: EnvironmentalReverbEffect.lib

class CEnvironmentalReverb : public CAudioEffect

Inherits from

CEnvironmentalReverb
- CAudioEffect

Protected Attributes
TEfEnvReverbDataPckg	iDataPckgFrom
TEfEnvReverbDataPckg	iDataPckgTo
TEfEnvironmentalReverb	iReverbData

Public Member Functions
virtual	~CEnvironmentalReverb()
IMPORT_C TUint32	DecayHFRatio()
IMPORT_C void	DecayHFRatioRange(TUint32 &, TUint32 &)
IMPORT_C TUint32	DecayTime()
IMPORT_C void	DecayTimeRange(TUint32 &, TUint32 &)
IMPORT_C TUint32	DelayMax()
IMPORT_C TUint32	Density()
IMPORT_C TUint32	Diffusion()
IMPORT_C CEnvironmentalReverb *	NewL()
IMPORT_C CEnvironmentalReverb *	NewL(CMdaAudioConvertUtility &)
IMPORT_C CEnvironmentalReverb *	NewL(CMdaAudioInputStream &)
IMPORT_C CEnvironmentalReverb *	NewL(CMdaAudioOutputStream &)
IMPORT_C CEnvironmentalReverb *	NewL(CMdaAudioPlayerUtility &)
IMPORT_C CEnvironmentalReverb *	NewL(CMdaAudioRecorderUtility &, TBool)
IMPORT_C CEnvironmentalReverb *	NewL(CMdaAudioToneUtility &)
IMPORT_C CEnvironmentalReverb *	NewL(CMMFDevSound &)
IMPORT_C CEnvironmentalReverb *	NewL(CCustomCommandUtility *)
IMPORT_C CEnvironmentalReverb *	NewL(MCustomInterface &)
IMPORT_C CEnvironmentalReverb *	NewL(CMidiClientUtility &)
IMPORT_C CEnvironmentalReverb *	NewL(CDrmPlayerUtility &)
IMPORT_C CEnvironmentalReverb *	NewL(CVideoPlayerUtility &)
IMPORT_C void	ReflectionLevelRange(TInt32 &, TInt32 &)
IMPORT_C TUint32	ReflectionsDelay()
IMPORT_C TUint32	ReflectionsDelayMax()
IMPORT_C TInt32	ReflectionsLevel()
IMPORT_C TUint32	ReverbDelay()
IMPORT_C TUint32	ReverbDelayMax()
IMPORT_C TInt32	ReverbLevel()
IMPORT_C void	ReverbLevelRange(TInt32 &, TInt32 &)
IMPORT_C TInt32	RoomHFLevel()
IMPORT_C void	RoomHFLevelRange(TInt32 &, TInt32 &)
IMPORT_C TInt32	RoomLevel()
IMPORT_C void	RoomLevelRange(TInt32 &, TInt32 &)
IMPORT_C void	SetDecayHFRatioL(TUint32)
IMPORT_C void	SetDecayTimeL(TUint32)
IMPORT_C void	SetDensityL(TUint32)
IMPORT_C void	SetDiffusionL(TUint32)
IMPORT_C void	SetReflectionsDelayL(TUint32)
IMPORT_C void	SetReflectionsLevelL(TInt32)
IMPORT_C void	SetReverbDelayL(TUint32)
IMPORT_C void	SetReverbLevelL(TInt32)
IMPORT_C void	SetRoomHFLevelL(TInt32)
IMPORT_C void	SetRoomLevelL(TInt32)
virtual IMPORT_C TUid	Uid()

Protected Member Functions
	CEnvironmentalReverb()
virtual IMPORT_C const TDesC8 &	DoEffectData()
virtual IMPORT_C void	SetEffectData(const TDesC8 &)

Inherited Attributes
	CAudioEffect::iEnabled
	CAudioEffect::iEnforced
	CAudioEffect::iHaveUpdateRights
	CAudioEffect::iObservers

Inherited Functions
	CAudioEffect::ApplyL()
	CAudioEffect::CAudioEffect()
	CAudioEffect::DisableL()
	CAudioEffect::EnableL()
	CAudioEffect::EnforceL(TBool)
	CAudioEffect::HaveUpdateRights()const
	CAudioEffect::IsEnabled()const
	CAudioEffect::IsEnforced()const
	CAudioEffect::RegisterObserverL(MAudioEffectObserver &)
	CAudioEffect::UnRegisterObserver(MAudioEffectObserver &)
	CAudioEffect::~CAudioEffect()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

This is the Environmental Reverb effect class for managing reverb settings.

Since: 3.0

Member Attribute Documentation

iDataPckgFrom

TEfEnvReverbDataPckg

iDataPckgFrom

[protected]

iDataPckgTo

TEfEnvReverbDataPckg

iDataPckgTo

[protected]

iReverbData

TEfEnvironmentalReverb

iReverbData

[protected]

Constructor & Destructor Documentation

CEnvironmentalReverb ( )

IMPORT_C

CEnvironmentalReverb

(

)

[protected]

Private C++ constructor for this class.

Since: 3.0

Returns: -

~CEnvironmentalReverb ( )

IMPORT_C

~CEnvironmentalReverb

(

)

[virtual]

Destructor

Member Function Documentation

DecayHFRatio ( )

IMPORT_C TUint32

DecayHFRatio

(

)

const

Gets the decay HF Ratio in hundredths

Since: 3.0

Returns: decay HF Ratio

DecayHFRatioRange ( TUint32 &, TUint32 & )

IMPORT_C void	DecayHFRatioRange	(	TUint32 &	aMin,
			TUint32 &	aMax
		)

Gets the reverb decay HF Ratio minimum and maximum in hundredths.

Since: 3.0

Parameter	Description
aMin	Minimum decay HF Ratio
aMax	Maximum decay HF Ratio

DecayTime ( )

IMPORT_C TUint32

DecayTime

(

)

const

Gets the decay time in milliseconds

Since: 3.0

Returns: decay time

DecayTimeRange ( TUint32 &, TUint32 & )

IMPORT_C void	DecayTimeRange	(	TUint32 &	aMin,
			TUint32 &	aMax
		)

Gets the allowable reverb decay time range in milliseconds.

Since: 3.0

Parameter	Description
aMin	Minimum decay time in milliseconds
aMax	Maximum decay time in milliseconds

DelayMax ( )

IMPORT_C TUint32

DelayMax

(

)

const

Gets the total delay maximum in milliseconds

Since: 3.0

Returns: reverb delay maximum

Density ( )

IMPORT_C TUint32

Density

(

)

const

Gets the density current value as a percentage in hundredths

Since: 3.0

Returns: density value

Diffusion ( )

IMPORT_C TUint32

Diffusion

(

)

const

Gets the diffusion current value as a percentage in hundredths.

Since: 3.0

Returns: diffusion value

DoEffectData ( )

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data

Since: 3.0

Returns: A descriptor containing the effect data.

NewL ( )

IMPORT_C CEnvironmentalReverb *

NewL

(

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Returns: pointer to CEnvironmentalReverb object

NewL ( CMdaAudioConvertUtility & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CMdaAudioConvertUtility &

aUtility

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to a convert utility

Returns: pointer to CEnvironmentalReverb object

NewL ( CMdaAudioInputStream & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CMdaAudioInputStream &

aUtility

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio input stream utility

Returns: pointer to CEnvironmentalReverb object

NewL ( CMdaAudioOutputStream & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CMdaAudioOutputStream &

aUtility

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio output stream utility

Returns: pointer to CEnvironmentalReverb object

NewL ( CMdaAudioPlayerUtility & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CMdaAudioPlayerUtility &

aUtility

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio player utility

Returns: pointer to CEnvironmentalReverb object

NewL ( CMdaAudioRecorderUtility &, TBool )

IMPORT_C CEnvironmentalReverb *	NewL	(	CMdaAudioRecorderUtility &	aUtility,
			TBool	aRecordStream
		)	[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio record utility
aRecordStream	ETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback

Returns: pointer to CEnvironmentalReverb object

NewL ( CMdaAudioToneUtility & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CMdaAudioToneUtility &

aUtility

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio tone utility

Returns: pointer to CEnvironmentalReverb object

NewL ( CMMFDevSound & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CMMFDevSound &

aDevSound

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aDevSound	A reference to a DevSound instance

Returns: pointer to CEnvironmentalReverb object

NewL ( CCustomCommandUtility * )

IMPORT_C CEnvironmentalReverb *

NewL

(

CCustomCommandUtility *

aUtility

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to a custom command utility

Returns: pointer to CEnvironmentalReverb object

NewL ( MCustomInterface & )

IMPORT_C CEnvironmentalReverb *

NewL

(

MCustomInterface &

aCustomInterface

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aCustomInterface	A reference to a custom interface

Returns: pointer to CEnvironmentalReverb object

NewL ( CMidiClientUtility & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CMidiClientUtility &

aUtility

)

[static]

Factory function for creating the audio reverb object.

Since: 3.0

Parameter	Description
aUtility	A reference to a CMidiClientUtility object

Returns: pointer to CEnvironmentalReverb object

NewL ( CDrmPlayerUtility & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CDrmPlayerUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Returns: pointer to CAudioEqualizer object

NewL ( CVideoPlayerUtility & )

IMPORT_C CEnvironmentalReverb *

NewL

(

CVideoPlayerUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.2

Returns: pointer to CAudioEqualizer object

ReflectionLevelRange ( TInt32 &, TInt32 & )

IMPORT_C void	ReflectionLevelRange	(	TInt32 &	aMin,
			TInt32 &	aMax
		)

Gets the reverb reflections level maximum and minimum in mB

Since: 3.0

Parameter	Description
aMin	Minimum reflections level
aMax	Maximum reflections level

ReflectionsDelay ( )

IMPORT_C TUint32

ReflectionsDelay

(

)

const

Gets the reverb reflections delay in ms.

Since: 3.0

Returns: reverb reflections delay

ReflectionsDelayMax ( )

IMPORT_C TUint32

ReflectionsDelayMax

(

)

const

Gets the reverb reflections delay maximum in milliseconds.

Since: 3.0

Returns: reverb reflections delay maximum

ReflectionsLevel ( )

IMPORT_C TInt32

ReflectionsLevel

(

)

const

Gets the reverb reflections level in mB

Since: 3.0

Returns: Reverb reflections level

ReverbDelay ( )

IMPORT_C TUint32

ReverbDelay

(

)

const

Gets the reverb delay in milliseconds

Since: 3.0

Returns: reverb delay

ReverbDelayMax ( )

IMPORT_C TUint32

ReverbDelayMax

(

)

const

Gets the reverb delay maximum in milliseconds

Since: 3.0

Returns: reverb delay maximum

ReverbLevel ( )

IMPORT_C TInt32

ReverbLevel

(

)

const

Gets the reverb current level in mB

Since: 3.0

Returns: reverb current level

ReverbLevelRange ( TInt32 &, TInt32 & )

IMPORT_C void	ReverbLevelRange	(	TInt32 &	aMin,
			TInt32 &	aMax
		)

Gets the reverb current level maximum and minimum in mB

Since: 3.0

Parameter	Description
aMin	Minimum current level
aMax	Maximum current level

Returns: -

RoomHFLevel ( )

IMPORT_C TInt32

RoomHFLevel

(

)

const

Gets the room HF level current ratio

Since: 3.0

Returns: room HF level ratio

RoomHFLevelRange ( TInt32 &, TInt32 & )

IMPORT_C void	RoomHFLevelRange	(	TInt32 &	aMin,
			TInt32 &	aMax
		)

Gets the room HF level maximum and minimum ratios

Since: 3.0

Parameter	Description
aMin	Minimum current room HF level
aMax	Maximum current room HF level

Returns: -

RoomLevel ( )

IMPORT_C TInt32

RoomLevel

(

)

const

Gets the room level current value in mB

Since: 3.0

Returns: room level value

RoomLevelRange ( TInt32 &, TInt32 & )

IMPORT_C void	RoomLevelRange	(	TInt32 &	aMin,
			TInt32 &	aMax
		)

Gets the room level maximum and minimum in mB

Since: 3.0

Parameter	Description
aMin	Minimum current room level
aMax	Maximum current room level

Returns: -

SetDecayHFRatioL ( TUint32 )

IMPORT_C void

SetDecayHFRatioL

(

TUint32

aDecayHFRatio

)

Sets the decay HF Ratio in hundredths

Since: 3.0

Parameter	Description
aDecayHFRatio	The decay high frequence ratio in hundredths

Returns: -

SetDecayTimeL ( TUint32 )

IMPORT_C void

SetDecayTimeL

(

TUint32

aDecayTime

)

Sets the decay time in millisecond

Since: 3.0

Parameter	Description
aDecayTime	Decay time in ms

SetDensityL ( TUint32 )

IMPORT_C void

SetDensityL

(

TUint32

aDensity

)

Sets the density value as percentage in hundredths

Since: 3.0

Parameter	Description
aDensity	The density.

SetDiffusionL ( TUint32 )

IMPORT_C void

SetDiffusionL

(

TUint32

aDiffusion

)

Sets the diffusion value as a percentage in hundredths

Since: 3.0

Parameter	Description
aDiffusion	The diffusion.

SetEffectData ( const TDesC8 & )

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

Reimplemented from CAudioEffect::SetEffectData(const TDesC8 &)

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameter	Description
aEffectDataBuffer	Descriptor containing packed effect data

Returns: -

SetReflectionsDelayL ( TUint32 )

IMPORT_C void

SetReflectionsDelayL

(

TUint32

aReflectionsDelay

)

Sets the reverb reflections delay

Since: 3.0

SetReflectionsLevelL ( TInt32 )

IMPORT_C void

SetReflectionsLevelL

(

TInt32

aReflectionsLevel

)

Sets the reverb reflections level in milli-dB

Since: 3.0

SetReverbDelayL ( TUint32 )

IMPORT_C void

SetReverbDelayL

(

TUint32

aReverbDelay

)

Sets the reverb delay

Since: 3.0

Parameter	Description
aReverbDelay	The reverb delay in ms

SetReverbLevelL ( TInt32 )

IMPORT_C void

SetReverbLevelL

(

TInt32

aReverbLevel

)

Sets the reverb level

Since: 3.0

Parameter	Description
aReverbLevel	The reverb level in mB

SetRoomHFLevelL ( TInt32 )

IMPORT_C void

SetRoomHFLevelL

(

TInt32

aRoomHFLevel

)

Sets the room HF level ratio

Since: 3.0

Parameter	Description
aRoomHFLevel	The room high frequency ratio

SetRoomLevelL ( TInt32 )

IMPORT_C void

SetRoomLevelL

(

TInt32

aRoomLevel

)

Sets the room level value in milli-dB

Since: 3.0

Parameter	Description
aRoomLevel	The room level

Uid ( )

IMPORT_C TUid

Uid

(

)

const [virtual]

Reimplemented from CAudioEffect::Uid()const