CRoomLevel Class Reference

#include <RoomLevelBase.h>

Link against: RoomLevelEffect.lib

class CRoomLevel : public CAudioEffect

Inherits from

Protected Attributes
CEnvironmentalReverb *iClientReverb
TEfRoomLevelDataPckg iDataPckgFrom
TEfRoomLevelDataPckg iDataPckgTo
TEfRoomLevel iRoomLevelData
Public Member Functions
virtual ~CRoomLevel()
IMPORT_C TInt32Level()
IMPORT_C voidLevelRange(TInt32 &, TInt32 &)
IMPORT_C CRoomLevel *NewL(CMdaAudioConvertUtility &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CMdaAudioInputStream &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CMdaAudioOutputStream &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CMdaAudioPlayerUtility &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CMdaAudioRecorderUtility &, TBool, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CMdaAudioToneUtility &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CMMFDevSound &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CCustomCommandUtility *, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(MCustomInterface &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CMidiClientUtility &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CDrmPlayerUtility &, CEnvironmentalReverb &)
IMPORT_C CRoomLevel *NewL(CVideoPlayerUtility &, CEnvironmentalReverb &)
IMPORT_C voidSetRoomLevelL(TInt32)
virtual IMPORT_C TUidUid()
Protected Member Functions
CRoomLevel()
virtual IMPORT_C const TDesC8 &DoEffectData()
virtual IMPORT_C voidSetEffectData(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 RoomLevel effect class for managing RoomLevel settings.

Since
3.0

Member Attribute Documentation

iClientReverb

CEnvironmentalReverb *iClientReverb[protected]

iDataPckgFrom

TEfRoomLevelDataPckg iDataPckgFrom[protected]

iDataPckgTo

TEfRoomLevelDataPckg iDataPckgTo[protected]

iRoomLevelData

TEfRoomLevel iRoomLevelData[protected]

Constructor & Destructor Documentation

CRoomLevel ( )

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

Returns: -

~CRoomLevel ( )

IMPORT_C~CRoomLevel()[virtual]

Destructor

Member Function Documentation

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.

Level ( )

IMPORT_C TInt32Level()const
Gets the RoomLevel current level in mB
Since
3.0

Returns: RoomLevel current level

LevelRange ( TInt32 &, TInt32 & )

IMPORT_C voidLevelRange(TInt32 &aMin,
TInt32 &aMax
)
Gets the RoomLevel current level maximum and minimum in mB
Since
3.0
ParameterDescription
aMinMinimum current level
aMaxMaximum current level

Returns: -

NewL ( CMdaAudioConvertUtility &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMdaAudioConvertUtility &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to a convert utility
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CMdaAudioInputStream &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMdaAudioInputStream &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio input stream utility
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CMdaAudioOutputStream &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMdaAudioOutputStream &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio output stream utility
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CMdaAudioPlayerUtility &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMdaAudioPlayerUtility &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio player utility
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CMdaAudioRecorderUtility &, TBool, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMdaAudioRecorderUtility &aUtility,
TBoolaRecordStream,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio record utility
aRecordStreamETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CMdaAudioToneUtility &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMdaAudioToneUtility &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to an audio tone utility
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CMMFDevSound &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMMFDevSound &aDevSound,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aDevSoundA reference to a DevSound instance
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CCustomCommandUtility *, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CCustomCommandUtility *aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to a custom command utility
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( MCustomInterface &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(MCustomInterface &aCustomInterface,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aCustomInterfaceA reference to a custom interface
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CMidiClientUtility &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CMidiClientUtility &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the audio RoomLevel object.
Since
3.0
ParameterDescription
aUtilityA reference to a CMidiClientUtility object
aReverbA reference to a environmental reverb utility

Returns: pointer to CRoomLevel object

NewL ( CDrmPlayerUtility &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CDrmPlayerUtility &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the RoomLevel object.
Since
3.0

Returns: pointer to CRoomLevel object

NewL ( CVideoPlayerUtility &, CEnvironmentalReverb & )

IMPORT_C CRoomLevel *NewL(CVideoPlayerUtility &aUtility,
CEnvironmentalReverb &aReverb
)[static]
Factory function for creating the RoomLevel object.
Since
3.2

Returns: pointer to CRoomLevel object

SetEffectData ( const TDesC8 & )

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

Returns: -

SetRoomLevelL ( TInt32 )

IMPORT_C voidSetRoomLevelL(TInt32aRoomLevel)
Sets the RoomLevel level, it will leave if aRoomLevel is not within range of Min and Max
Since
3.0

Uid ( )

IMPORT_C TUidUid()const [virtual]

Reimplemented from CAudioEffect::Uid()const

© Nokia 2011.