Symbian^3 Product 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 TUint32DecayHFRatio()
IMPORT_C voidDecayHFRatioRange(TUint32 &, TUint32 &)
IMPORT_C TUint32DecayTime()
IMPORT_C voidDecayTimeRange(TUint32 &, TUint32 &)
IMPORT_C TUint32DelayMax()
IMPORT_C TUint32Density()
IMPORT_C TUint32Diffusion()
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 voidReflectionLevelRange(TInt32 &, TInt32 &)
IMPORT_C TUint32ReflectionsDelay()
IMPORT_C TUint32ReflectionsDelayMax()
IMPORT_C TInt32ReflectionsLevel()
IMPORT_C TUint32ReverbDelay()
IMPORT_C TUint32ReverbDelayMax()
IMPORT_C TInt32ReverbLevel()
IMPORT_C voidReverbLevelRange(TInt32 &, TInt32 &)
IMPORT_C TInt32RoomHFLevel()
IMPORT_C voidRoomHFLevelRange(TInt32 &, TInt32 &)
IMPORT_C TInt32RoomLevel()
IMPORT_C voidRoomLevelRange(TInt32 &, TInt32 &)
IMPORT_C voidSetDecayHFRatioL(TUint32)
IMPORT_C voidSetDecayTimeL(TUint32)
IMPORT_C voidSetDensityL(TUint32)
IMPORT_C voidSetDiffusionL(TUint32)
IMPORT_C voidSetReflectionsDelayL(TUint32)
IMPORT_C voidSetReflectionsLevelL(TInt32)
IMPORT_C voidSetReverbDelayL(TUint32)
IMPORT_C voidSetReverbLevelL(TInt32)
IMPORT_C voidSetRoomHFLevelL(TInt32)
IMPORT_C voidSetRoomLevelL(TInt32)
IMPORT_C TUidUid()
Protected Member Functions
CEnvironmentalReverb()
IMPORT_C const TDesC8 &DoEffectData()
IMPORT_C voidSetEffectData(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_CCEnvironmentalReverb()[protected]
Private C++ constructor for this class.
Since
3.0

~CEnvironmentalReverb()

IMPORT_C~CEnvironmentalReverb()[virtual]

Destructor

Member Functions Documentation

DecayHFRatio()

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

DecayHFRatioRange(TUint32 &, TUint32 &)

IMPORT_C voidDecayHFRatioRange(TUint32 &aMin,
TUint32 &aMax
)
Gets the reverb decay HF Ratio minimum and maximum in hundredths.
Since
3.0

Parameters

TUint32 & aMinMinimum decay HF Ratio
TUint32 & aMaxMaximum decay HF Ratio

DecayTime()

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

DecayTimeRange(TUint32 &, TUint32 &)

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

Parameters

TUint32 & aMinMinimum decay time in milliseconds
TUint32 & aMaxMaximum decay time in milliseconds

DelayMax()

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

Density()

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

Diffusion()

IMPORT_C TUint32Diffusion()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 & aUtilityA 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 & aUtilityA 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 & aUtilityA 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 & aUtilityA reference to an audio player utility

NewL(CMdaAudioRecorderUtility &, TBool)

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

Parameters

CMdaAudioRecorderUtility & aUtilityA reference to an audio record utility
TBool aRecordStreamETrue 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 & aUtilityA 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 & aDevSoundA 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 * aUtilityA 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 & aCustomInterfaceA 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 & aUtilityA 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 voidReflectionLevelRange(TInt32 &aMin,
TInt32 &aMax
)
Gets the reverb reflections level maximum and minimum in mB
Since
3.0

Parameters

TInt32 & aMinMinimum reflections level
TInt32 & aMaxMaximum reflections level

ReflectionsDelay()

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

ReflectionsDelayMax()

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

ReflectionsLevel()

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

ReverbDelay()

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

ReverbDelayMax()

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

ReverbLevel()

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

ReverbLevelRange(TInt32 &, TInt32 &)

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

Parameters

TInt32 & aMinMinimum current level
TInt32 & aMaxMaximum current level

RoomHFLevel()

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

RoomHFLevelRange(TInt32 &, TInt32 &)

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

Parameters

TInt32 & aMinMinimum current room HF level
TInt32 & aMaxMaximum current room HF level

RoomLevel()

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

RoomLevelRange(TInt32 &, TInt32 &)

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

Parameters

TInt32 & aMinMinimum current room level
TInt32 & aMaxMaximum current room level

SetDecayHFRatioL(TUint32)

IMPORT_C voidSetDecayHFRatioL(TUint32aDecayHFRatio)
Sets the decay HF Ratio in hundredths
Since
3.0

Parameters

TUint32 aDecayHFRatioThe decay high frequence ratio in hundredths

SetDecayTimeL(TUint32)

IMPORT_C voidSetDecayTimeL(TUint32aDecayTime)
Sets the decay time in millisecond
Since
3.0

Parameters

TUint32 aDecayTimeDecay time in ms

SetDensityL(TUint32)

IMPORT_C voidSetDensityL(TUint32aDensity)
Sets the density value as percentage in hundredths
Since
3.0

Parameters

TUint32 aDensityThe density.

SetDiffusionL(TUint32)

IMPORT_C voidSetDiffusionL(TUint32aDiffusion)
Sets the diffusion value as a percentage in hundredths
Since
3.0

Parameters

TUint32 aDiffusionThe diffusion.

SetEffectData(const TDesC8 &)

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

Parameters

const TDesC8 & aEffectDataBufferDescriptor containing packed effect data

SetReflectionsDelayL(TUint32)

IMPORT_C voidSetReflectionsDelayL(TUint32aReflectionsDelay)
Sets the reverb reflections delay
Since
3.0

Parameters

TUint32 aReflectionsDelay

SetReflectionsLevelL(TInt32)

IMPORT_C voidSetReflectionsLevelL(TInt32aReflectionsLevel)
Sets the reverb reflections level in milli-dB
Since
3.0

Parameters

TInt32 aReflectionsLevel

SetReverbDelayL(TUint32)

IMPORT_C voidSetReverbDelayL(TUint32aReverbDelay)
Sets the reverb delay
Since
3.0

Parameters

TUint32 aReverbDelayThe reverb delay in ms

SetReverbLevelL(TInt32)

IMPORT_C voidSetReverbLevelL(TInt32aReverbLevel)
Sets the reverb level
Since
3.0

Parameters

TInt32 aReverbLevelThe reverb level in mB

SetRoomHFLevelL(TInt32)

IMPORT_C voidSetRoomHFLevelL(TInt32aRoomHFLevel)
Sets the room HF level ratio
Since
3.0

Parameters

TInt32 aRoomHFLevelThe room high frequency ratio

SetRoomLevelL(TInt32)

IMPORT_C voidSetRoomLevelL(TInt32aRoomLevel)
Sets the room level value in milli-dB
Since
3.0

Parameters

TInt32 aRoomLevelThe room level

Uid()

IMPORT_C TUidUid()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.