Symbian^3 Application Developer Library >

CEnvironmentalReverb Class Reference

class CEnvironmentalReverb : public CAudioEffect

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

EnvironmentalReverbEffect.lib
Since
3.0

Inherits from

Public Member Functions
~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 )
IMPORT_C TUid Uid ()
Protected Member Functions
CEnvironmentalReverb ()
IMPORT_C const TDesC8 & DoEffectData ()
IMPORT_C void SetEffectData (const TDesC8 &)
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()
Protected Attributes
TEfEnvReverbDataPckg iDataPckgFrom
TEfEnvReverbDataPckg iDataPckgTo
TEfEnvironmentalReverb iReverbData
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers

Constructor & Destructor Documentation

CEnvironmentalReverb()

IMPORT_C CEnvironmentalReverb ( ) [protected]
Private C++ constructor for this class.
Since
3.0

~CEnvironmentalReverb()

IMPORT_C ~CEnvironmentalReverb ( ) [virtual]

Destructor

Member Functions Documentation

DecayHFRatio()

IMPORT_C TUint32 DecayHFRatio ( ) const
Gets the decay HF Ratio in hundredths
Since
3.0

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

Parameters

TUint32 & aMin Minimum decay HF Ratio
TUint32 & aMax Maximum decay HF Ratio

DecayTime()

IMPORT_C TUint32 DecayTime ( ) const
Gets the decay time in milliseconds
Since
3.0

DecayTimeRange(TUint32 &, TUint32 &)

IMPORT_C void DecayTimeRange ( TUint32 & aMin,
TUint32 & aMax
)
Gets the allowable reverb decay time range in milliseconds.
Since
3.0

Parameters

TUint32 & aMin Minimum decay time in milliseconds
TUint32 & aMax Maximum decay time in milliseconds

DelayMax()

IMPORT_C TUint32 DelayMax ( ) const
Gets the total delay maximum in milliseconds
Since
3.0

Density()

IMPORT_C TUint32 Density ( ) const
Gets the density current value as a percentage in hundredths
Since
3.0

Diffusion()

IMPORT_C TUint32 Diffusion ( ) const
Gets the diffusion current value as a percentage in hundredths.
Since
3.0

DoEffectData()

IMPORT_C const TDesC8 & DoEffectData ( ) [protected, virtual]
From CAudioEffect Create a package of the effect data
Since
3.0

NewL()

IMPORT_C CEnvironmentalReverb * NewL ( ) [static]
Factory function for creating the audio reverb object.
Since
3.0

NewL(CMdaAudioConvertUtility &)

IMPORT_C CEnvironmentalReverb * NewL ( CMdaAudioConvertUtility & aUtility ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CMdaAudioConvertUtility & aUtility A reference to a convert utility

NewL(CMdaAudioInputStream &)

IMPORT_C CEnvironmentalReverb * NewL ( CMdaAudioInputStream & aUtility ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CMdaAudioInputStream & aUtility A reference to an audio input stream utility

NewL(CMdaAudioOutputStream &)

IMPORT_C CEnvironmentalReverb * NewL ( CMdaAudioOutputStream & aUtility ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CMdaAudioOutputStream & aUtility A reference to an audio output stream utility

NewL(CMdaAudioPlayerUtility &)

IMPORT_C CEnvironmentalReverb * NewL ( CMdaAudioPlayerUtility & aUtility ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CMdaAudioPlayerUtility & aUtility A reference to an audio player utility

NewL(CMdaAudioRecorderUtility &, TBool)

IMPORT_C CEnvironmentalReverb * NewL ( CMdaAudioRecorderUtility & aUtility,
TBool aRecordStream
) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

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

NewL(CMdaAudioToneUtility &)

IMPORT_C CEnvironmentalReverb * NewL ( CMdaAudioToneUtility & aUtility ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CMdaAudioToneUtility & aUtility A reference to an audio tone utility

NewL(CMMFDevSound &)

IMPORT_C CEnvironmentalReverb * NewL ( CMMFDevSound & aDevSound ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CMMFDevSound & aDevSound A reference to a DevSound instance

NewL(CCustomCommandUtility *)

IMPORT_C CEnvironmentalReverb * NewL ( CCustomCommandUtility * aUtility ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CCustomCommandUtility * aUtility A reference to a custom command utility

NewL(MCustomInterface &)

IMPORT_C CEnvironmentalReverb * NewL ( MCustomInterface & aCustomInterface ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

MCustomInterface & aCustomInterface A reference to a custom interface

NewL(CMidiClientUtility &)

IMPORT_C CEnvironmentalReverb * NewL ( CMidiClientUtility & aUtility ) [static]
Factory function for creating the audio reverb object.
Since
3.0

Parameters

CMidiClientUtility & aUtility A reference to a CMidiClientUtility object

NewL(CDrmPlayerUtility &)

IMPORT_C CEnvironmentalReverb * NewL ( CDrmPlayerUtility & aUtility ) [static]
Factory function for creating the audio equalizer object.
Since
3.0

Parameters

CDrmPlayerUtility & aUtility

NewL(CVideoPlayerUtility &)

IMPORT_C CEnvironmentalReverb * NewL ( CVideoPlayerUtility & aUtility ) [static]
Factory function for creating the audio equalizer object.
Since
3.2

Parameters

CVideoPlayerUtility & aUtility

ReflectionLevelRange(TInt32 &, TInt32 &)

IMPORT_C void ReflectionLevelRange ( TInt32 & aMin,
TInt32 & aMax
)
Gets the reverb reflections level maximum and minimum in mB
Since
3.0

Parameters

TInt32 & aMin Minimum reflections level
TInt32 & aMax Maximum reflections level

ReflectionsDelay()

IMPORT_C TUint32 ReflectionsDelay ( ) const
Gets the reverb reflections delay in ms.
Since
3.0

ReflectionsDelayMax()

IMPORT_C TUint32 ReflectionsDelayMax ( ) const
Gets the reverb reflections delay maximum in milliseconds.
Since
3.0

ReflectionsLevel()

IMPORT_C TInt32 ReflectionsLevel ( ) const
Gets the reverb reflections level in mB
Since
3.0

ReverbDelay()

IMPORT_C TUint32 ReverbDelay ( ) const
Gets the reverb delay in milliseconds
Since
3.0

ReverbDelayMax()

IMPORT_C TUint32 ReverbDelayMax ( ) const
Gets the reverb delay maximum in milliseconds
Since
3.0

ReverbLevel()

IMPORT_C TInt32 ReverbLevel ( ) const
Gets the reverb current level in mB
Since
3.0

ReverbLevelRange(TInt32 &, TInt32 &)

IMPORT_C void ReverbLevelRange ( TInt32 & aMin,
TInt32 & aMax
)
Gets the reverb current level maximum and minimum in mB
Since
3.0

Parameters

TInt32 & aMin Minimum current level
TInt32 & aMax Maximum current level

RoomHFLevel()

IMPORT_C TInt32 RoomHFLevel ( ) const
Gets the room HF level current ratio
Since
3.0

RoomHFLevelRange(TInt32 &, TInt32 &)

IMPORT_C void RoomHFLevelRange ( TInt32 & aMin,
TInt32 & aMax
)
Gets the room HF level maximum and minimum ratios
Since
3.0

Parameters

TInt32 & aMin Minimum current room HF level
TInt32 & aMax Maximum current room HF level

RoomLevel()

IMPORT_C TInt32 RoomLevel ( ) const
Gets the room level current value in mB
Since
3.0

RoomLevelRange(TInt32 &, TInt32 &)

IMPORT_C void RoomLevelRange ( TInt32 & aMin,
TInt32 & aMax
)
Gets the room level maximum and minimum in mB
Since
3.0

Parameters

TInt32 & aMin Minimum current room level
TInt32 & aMax Maximum current room level

SetDecayHFRatioL(TUint32)

IMPORT_C void SetDecayHFRatioL ( TUint32 aDecayHFRatio )
Sets the decay HF Ratio in hundredths
Since
3.0

Parameters

TUint32 aDecayHFRatio The decay high frequence ratio in hundredths

SetDecayTimeL(TUint32)

IMPORT_C void SetDecayTimeL ( TUint32 aDecayTime )
Sets the decay time in millisecond
Since
3.0

Parameters

TUint32 aDecayTime Decay time in ms

SetDensityL(TUint32)

IMPORT_C void SetDensityL ( TUint32 aDensity )
Sets the density value as percentage in hundredths
Since
3.0

Parameters

TUint32 aDensity The density.

SetDiffusionL(TUint32)

IMPORT_C void SetDiffusionL ( TUint32 aDiffusion )
Sets the diffusion value as a percentage in hundredths
Since
3.0

Parameters

TUint32 aDiffusion The diffusion.

SetEffectData(const TDesC8 &)

IMPORT_C void SetEffectData ( const TDesC8 & aEffectDataBuffer ) [protected, virtual]
From CAudioEffect Internal function to unpack effect data
Since
3.0

Parameters

const TDesC8 & aEffectDataBuffer Descriptor containing packed effect data

SetReflectionsDelayL(TUint32)

IMPORT_C void SetReflectionsDelayL ( TUint32 aReflectionsDelay )
Sets the reverb reflections delay
Since
3.0

Parameters

TUint32 aReflectionsDelay

SetReflectionsLevelL(TInt32)

IMPORT_C void SetReflectionsLevelL ( TInt32 aReflectionsLevel )
Sets the reverb reflections level in milli-dB
Since
3.0

Parameters

TInt32 aReflectionsLevel

SetReverbDelayL(TUint32)

IMPORT_C void SetReverbDelayL ( TUint32 aReverbDelay )
Sets the reverb delay
Since
3.0

Parameters

TUint32 aReverbDelay The reverb delay in ms

SetReverbLevelL(TInt32)

IMPORT_C void SetReverbLevelL ( TInt32 aReverbLevel )
Sets the reverb level
Since
3.0

Parameters

TInt32 aReverbLevel The reverb level in mB

SetRoomHFLevelL(TInt32)

IMPORT_C void SetRoomHFLevelL ( TInt32 aRoomHFLevel )
Sets the room HF level ratio
Since
3.0

Parameters

TInt32 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

Parameters

TInt32 aRoomLevel The room level

Uid()

IMPORT_C TUid Uid ( ) const [virtual]

Member Data Documentation

TEfEnvReverbDataPckg iDataPckgFrom

TEfEnvReverbDataPckg iDataPckgFrom [protected]

TEfEnvReverbDataPckg iDataPckgTo

TEfEnvReverbDataPckg iDataPckgTo [protected]

TEfEnvironmentalReverb iReverbData

TEfEnvironmentalReverb iReverbData [protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.