CEnvironmentalReverb Class Reference

API published in: S60 3rd Ed

Link against: environmentalreverbeffect.lib

Capability Information

Required Capabilities

None

#include <environmentalreverbbase.h>

Inherits CAudioEffect.

Detailed Description

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

Public Member Functions

virtual IMPORT_C ~CEnvironmentalReverb ()
 Destructor.
IMPORT_C TUint32 DecayHFRatio () const
 Gets the decay HF Ratio in hundredths.
IMPORT_C void DecayHFRatioRange (TUint32 &aMin, TUint32 &aMax)
 Gets the reverb decay HF Ratio minimum and maximum in hundredths.
IMPORT_C TUint32 DecayTime () const
 Gets the decay time in milliseconds.
IMPORT_C void DecayTimeRange (TUint32 &aMin, TUint32 &aMax)
 Gets the allowable reverb decay time range in milliseconds.
IMPORT_C TUint32 Density () const
 Gets the density current value as a percentage in hundredths.
IMPORT_C TUint32 Diffusion () const
 Gets the diffusion current value as a percentage in hundredths.
IMPORT_C TUint32 ReflectionsDelay () const
 Gets the reverb reflections delay in ms.
IMPORT_C TUint32 ReflectionsDelayMax () const
 Gets the reverb reflections delay maximum in milliseconds.
IMPORT_C TInt32 ReflectionsLevel () const
 Gets the reverb reflections level in mB.
IMPORT_C void ReflectionLevelRange (TInt32 &aMin, TInt32 &aMax)
 Gets the reverb reflections level maximum and minimum in mB.
IMPORT_C TUint32 ReverbDelay () const
 Gets the reverb delay in milliseconds.
IMPORT_C TUint32 ReverbDelayMax () const
 Gets the reverb delay maximum in milliseconds.
IMPORT_C TInt32 ReverbLevel () const
 Gets the reverb current level in mB.
IMPORT_C void ReverbLevelRange (TInt32 &aMin, TInt32 &aMax)
 Gets the reverb current level maximum and minimum in mB.
IMPORT_C TInt32 RoomHFLevel () const
 Gets the room HF level current ratio.
IMPORT_C void RoomHFLevelRange (TInt32 &aMin, TInt32 &aMax)
 Gets the room HF level maximum and minimum ratios.
IMPORT_C TInt32 RoomLevel () const
 Gets the room level current value in mB.
IMPORT_C void RoomLevelRange (TInt32 &aMin, TInt32 &aMax)
 Gets the room level maximum and minimum in mB.
IMPORT_C void SetDecayHFRatioL (TUint32 aDecayHFRatio)
 Sets the decay HF Ratio in hundredths.
IMPORT_C void SetDecayTimeL (TUint32 aDecayTime)
 Sets the decay time in millisecond.
IMPORT_C void SetDensityL (TUint32 aDensity)
 Sets the density value as percentage in hundredths.
IMPORT_C void SetDiffusionL (TUint32 aDiffusion)
 Sets the diffusion value as a percentage in hundredths.
IMPORT_C void SetReflectionsDelayL (TUint32 aReflectionsDelay)
 Sets the reverb reflections delay.
IMPORT_C void SetReflectionsLevelL (TInt32 aReflectionsLevel)
 Sets the reverb reflections level in milli-dB.
IMPORT_C void SetReverbDelayL (TUint32 aReverbDelay)
 Sets the reverb delay.
IMPORT_C void SetReverbLevelL (TInt32 aReverbLevel)
 Sets the reverb level.
IMPORT_C void SetRoomHFLevelL (TInt32 aRoomHFLevel)
 Sets the room HF level ratio.
IMPORT_C void SetRoomLevelL (TInt32 aRoomLevel)
 Sets the room level value in milli-dB.
IMPORT_C TUint32 DelayMax () const
 Gets the total delay maximum in milliseconds.
IMPORT_C TUid Uid () const

Static Public Member Functions

static IMPORT_C CEnvironmentalReverb * NewL ()
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMdaAudioConvertUtility &aUtility)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMdaAudioInputStream &aUtility)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMdaAudioOutputStream &aUtility)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMdaAudioPlayerUtility &aUtility)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMdaAudioRecorderUtility &aUtility, TBool aRecordStream)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMdaAudioToneUtility &aUtility)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMMFDevSound &aDevSound)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CCustomCommandUtility *aUtility)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (MCustomInterface &aCustomInterface)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CMidiClientUtility &aUtility)
 Factory function for creating the audio reverb object.
static IMPORT_C CEnvironmentalReverb * NewL (CDrmPlayerUtility &aUtility)
 Factory function for creating the audio equalizer object.
static IMPORT_C CEnvironmentalReverb * NewL (CVideoPlayerUtility &aUtility)
 Factory function for creating the audio equalizer object.

Protected Member Functions

IMPORT_C const TDesC8 & DoEffectData ()
 From CAudioEffect Create a package of the effect data.
IMPORT_C void SetEffectData (const TDesC8 &aEffectDataBuffer)
 From CAudioEffect Internal function to unpack effect data.
IMPORT_C CEnvironmentalReverb ()
 Private C++ constructor for this class.

Protected Attributes

TEfEnvironmentalReverb iReverbData
TEfEnvReverbDataPckg iDataPckgTo
TEfEnvReverbDataPckg iDataPckgFrom

Friends

class CEnvironmentalReverbMessageHandler
class CEnvironmentalReverbUtility

Constructor & Destructor Documentation

virtual IMPORT_C CEnvironmentalReverb::~CEnvironmentalReverb (   )  [virtual]
 

Destructor.

IMPORT_C CEnvironmentalReverb::CEnvironmentalReverb (   )  [protected]
 

Private C++ constructor for this class.

Returns:
-

Member Function Documentation

IMPORT_C TUint32 CEnvironmentalReverb::DecayHFRatio (   )  const
 

Gets the decay HF Ratio in hundredths.

Returns:
decay HF Ratio
IMPORT_C void CEnvironmentalReverb::DecayHFRatioRange ( TUint32 &  aMin,
TUint32 &  aMax
) 
 

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

Parameters:
aMin Minimum decay HF Ratio
aMax Maximum decay HF Ratio
IMPORT_C TUint32 CEnvironmentalReverb::DecayTime (   )  const
 

Gets the decay time in milliseconds.

Returns:
decay time
IMPORT_C void CEnvironmentalReverb::DecayTimeRange ( TUint32 &  aMin,
TUint32 &  aMax
) 
 

Gets the allowable reverb decay time range in milliseconds.

Parameters:
aMin Minimum decay time in milliseconds
aMax Maximum decay time in milliseconds
IMPORT_C TUint32 CEnvironmentalReverb::DelayMax (   )  const
 

Gets the total delay maximum in milliseconds.

Returns:
reverb delay maximum
IMPORT_C TUint32 CEnvironmentalReverb::Density (   )  const
 

Gets the density current value as a percentage in hundredths.

Returns:
density value
IMPORT_C TUint32 CEnvironmentalReverb::Diffusion (   )  const
 

Gets the diffusion current value as a percentage in hundredths.

Returns:
diffusion value
IMPORT_C const TDesC8& CEnvironmentalReverb::DoEffectData (   )  [protected, virtual]
 

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CVideoPlayerUtility &  aUtility  )  [static]
 

Factory function for creating the audio equalizer object.

Parameters:
CVideoPlayerUtility A reference to a CVideoPlayerUtility object
Returns:
pointer to CAudioEqualizer object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CDrmPlayerUtility &  aUtility  )  [static]
 

Factory function for creating the audio equalizer object.

Parameters:
CDrmPlayerUtility A reference to a CDrmPlayerUtility object
Returns:
pointer to CAudioEqualizer object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMidiClientUtility &  aUtility  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aUtility A reference to a CMidiClientUtility object
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( MCustomInterface &  aCustomInterface  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aCustomInterface A reference to a custom interface
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CCustomCommandUtility *  aUtility  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aUtility A reference to a custom command utility
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMMFDevSound &  aDevSound  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aDevSound A reference to a DevSound instance
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMdaAudioToneUtility &  aUtility  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aUtility A reference to an audio tone utility
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMdaAudioRecorderUtility &  aUtility,
TBool  aRecordStream
)  [static]
 

Factory function for creating the audio reverb object.

Parameters:
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
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMdaAudioPlayerUtility &  aUtility  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aUtility A reference to an audio player utility
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMdaAudioOutputStream &  aUtility  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aUtility A reference to an audio output stream utility
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMdaAudioInputStream &  aUtility  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aUtility A reference to an audio input stream utility
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL ( CMdaAudioConvertUtility &  aUtility  )  [static]
 

Factory function for creating the audio reverb object.

Parameters:
aUtility A reference to a convert utility
Returns:
pointer to CEnvironmentalReverb object
static IMPORT_C CEnvironmentalReverb* CEnvironmentalReverb::NewL (   )  [static]
 

Factory function for creating the audio reverb object.

Returns:
pointer to CEnvironmentalReverb object
IMPORT_C void CEnvironmentalReverb::ReflectionLevelRange ( TInt32 &  aMin,
TInt32 &  aMax
) 
 

Gets the reverb reflections level maximum and minimum in mB.

Parameters:
aMin Minimum reflections level
aMax Maximum reflections level
IMPORT_C TUint32 CEnvironmentalReverb::ReflectionsDelay (   )  const
 

Gets the reverb reflections delay in ms.

Returns:
reverb reflections delay
IMPORT_C TUint32 CEnvironmentalReverb::ReflectionsDelayMax (   )  const
 

Gets the reverb reflections delay maximum in milliseconds.

Returns:
reverb reflections delay maximum
IMPORT_C TInt32 CEnvironmentalReverb::ReflectionsLevel (   )  const
 

Gets the reverb reflections level in mB.

Returns:
Reverb reflections level
IMPORT_C TUint32 CEnvironmentalReverb::ReverbDelay (   )  const
 

Gets the reverb delay in milliseconds.

Returns:
reverb delay
IMPORT_C TUint32 CEnvironmentalReverb::ReverbDelayMax (   )  const
 

Gets the reverb delay maximum in milliseconds.

Returns:
reverb delay maximum
IMPORT_C TInt32 CEnvironmentalReverb::ReverbLevel (   )  const
 

Gets the reverb current level in mB.

Returns:
reverb current level
IMPORT_C void CEnvironmentalReverb::ReverbLevelRange ( TInt32 &  aMin,
TInt32 &  aMax
) 
 

Gets the reverb current level maximum and minimum in mB.

Parameters:
aMin Minimum current level
aMax Maximum current level
Returns:
-
IMPORT_C TInt32 CEnvironmentalReverb::RoomHFLevel (   )  const
 

Gets the room HF level current ratio.

Returns:
room HF level ratio
IMPORT_C void CEnvironmentalReverb::RoomHFLevelRange ( TInt32 &  aMin,
TInt32 &  aMax
) 
 

Gets the room HF level maximum and minimum ratios.

Parameters:
aMin Minimum current room HF level
aMax Maximum current room HF level
Returns:
-
IMPORT_C TInt32 CEnvironmentalReverb::RoomLevel (   )  const
 

Gets the room level current value in mB.

Returns:
room level value
IMPORT_C void CEnvironmentalReverb::RoomLevelRange ( TInt32 &  aMin,
TInt32 &  aMax
) 
 

Gets the room level maximum and minimum in mB.

Parameters:
aMin Minimum current room level
aMax Maximum current room level
Returns:
-
IMPORT_C void CEnvironmentalReverb::SetDecayHFRatioL ( TUint32  aDecayHFRatio  ) 
 

Sets the decay HF Ratio in hundredths.

Parameters:
aDecayHFRatio The decay high frequence ratio in hundredths
Returns:
-
IMPORT_C void CEnvironmentalReverb::SetDecayTimeL ( TUint32  aDecayTime  ) 
 

Sets the decay time in millisecond.

Parameters:
aDecayTime Decay time in ms
IMPORT_C void CEnvironmentalReverb::SetDensityL ( TUint32  aDensity  ) 
 

Sets the density value as percentage in hundredths.

Parameters:
aDensity The density.
IMPORT_C void CEnvironmentalReverb::SetDiffusionL ( TUint32  aDiffusion  ) 
 

Sets the diffusion value as a percentage in hundredths.

Parameters:
aDiffusion The diffusion.
IMPORT_C void CEnvironmentalReverb::SetEffectData ( const TDesC8 &  aEffectDataBuffer  )  [protected, virtual]
 

From CAudioEffect Internal function to unpack effect data.

Parameters:
aEffectDataBuffer Descriptor containing packed effect data
Returns:
-

Implements CAudioEffect.

IMPORT_C void CEnvironmentalReverb::SetReflectionsDelayL ( TUint32  aReflectionsDelay  ) 
 

Sets the reverb reflections delay.

Parameters:
aRefectionsDelay The reflection delay in ms.
IMPORT_C void CEnvironmentalReverb::SetReflectionsLevelL ( TInt32  aReflectionsLevel  ) 
 

Sets the reverb reflections level in milli-dB.

Parameters:
aRefectionsLevel The reflection level in mB
IMPORT_C void CEnvironmentalReverb::SetReverbDelayL ( TUint32  aReverbDelay  ) 
 

Sets the reverb delay.

Parameters:
aReverbDelay The reverb delay in ms
IMPORT_C void CEnvironmentalReverb::SetReverbLevelL ( TInt32  aReverbLevel  ) 
 

Sets the reverb level.

Parameters:
aReverbLevel The reverb level in mB
IMPORT_C void CEnvironmentalReverb::SetRoomHFLevelL ( TInt32  aRoomHFLevel  ) 
 

Sets the room HF level ratio.

Parameters:
aRoomHFLevel The room high frequency ratio
IMPORT_C void CEnvironmentalReverb::SetRoomLevelL ( TInt32  aRoomLevel  ) 
 

Sets the room level value in milli-dB.

Parameters:
aRoomLevel The room level
IMPORT_C TUid CEnvironmentalReverb::Uid (   )  const [virtual]
 

Implements CAudioEffect.

Friends And Related Function Documentation

friend class CEnvironmentalReverbMessageHandler [friend]
 
friend class CEnvironmentalReverbUtility [friend]
 

Field Documentation

TEfEnvReverbDataPckg CEnvironmentalReverb::iDataPckgFrom [protected]
 
TEfEnvReverbDataPckg CEnvironmentalReverb::iDataPckgTo [protected]
 
TEfEnvironmentalReverb CEnvironmentalReverb::iReverbData [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top