Symbian^3 Product Developer Library >

CRoomLevel Class Reference

class CRoomLevel : public CAudioEffect

This is the Environmental RoomLevel effect class for managing RoomLevel settings.

RoomLevelEffect.lib
Since
3.0

Inherits from

Public Member Functions
~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)
IMPORT_C TUidUid()
Protected Member Functions
CRoomLevel()
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
CEnvironmentalReverb *iClientReverb
TEfRoomLevelDataPckg iDataPckgFrom
TEfRoomLevelDataPckg iDataPckgTo
TEfRoomLevel iRoomLevelData
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers

Constructor & Destructor Documentation

CRoomLevel()

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

~CRoomLevel()

IMPORT_C~CRoomLevel()[virtual]

Destructor

Member Functions Documentation

DoEffectData()

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

Level()

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

LevelRange(TInt32 &, TInt32 &)

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

Parameters

TInt32 & aMinMinimum current level
TInt32 & aMaxMaximum current level

NewL(CMdaAudioConvertUtility &, CEnvironmentalReverb &)

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

Parameters

CMdaAudioConvertUtility & aUtilityA reference to a convert utility
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CMdaAudioInputStream &, CEnvironmentalReverb &)

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

Parameters

CMdaAudioInputStream & aUtilityA reference to an audio input stream utility
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CMdaAudioOutputStream &, CEnvironmentalReverb &)

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

Parameters

CMdaAudioOutputStream & aUtilityA reference to an audio output stream utility
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CMdaAudioPlayerUtility &, CEnvironmentalReverb &)

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

Parameters

CMdaAudioPlayerUtility & aUtilityA reference to an audio player utility
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

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

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
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CMdaAudioToneUtility &, CEnvironmentalReverb &)

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

Parameters

CMdaAudioToneUtility & aUtilityA reference to an audio tone utility
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CMMFDevSound &, CEnvironmentalReverb &)

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

Parameters

CMMFDevSound & aDevSoundA reference to a DevSound instance
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CCustomCommandUtility *, CEnvironmentalReverb &)

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

Parameters

CCustomCommandUtility * aUtilityA reference to a custom command utility
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(MCustomInterface &, CEnvironmentalReverb &)

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

Parameters

MCustomInterface & aCustomInterfaceA reference to a custom interface
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CMidiClientUtility &, CEnvironmentalReverb &)

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

Parameters

CMidiClientUtility & aUtilityA reference to a CMidiClientUtility object
CEnvironmentalReverb & aReverbA reference to a environmental reverb utility

NewL(CDrmPlayerUtility &, CEnvironmentalReverb &)

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

Parameters

CDrmPlayerUtility & aUtility
CEnvironmentalReverb & aReverb

NewL(CVideoPlayerUtility &, CEnvironmentalReverb &)

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

Parameters

CVideoPlayerUtility & aUtility
CEnvironmentalReverb & aReverb

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

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

Parameters

TInt32 aRoomLevel

Uid()

IMPORT_C TUidUid()const [virtual]

Member Data Documentation

CEnvironmentalReverb * iClientReverb

CEnvironmentalReverb *iClientReverb[protected]

TEfRoomLevelDataPckg iDataPckgFrom

TEfRoomLevelDataPckg iDataPckgFrom[protected]

TEfRoomLevelDataPckg iDataPckgTo

TEfRoomLevelDataPckg iDataPckgTo[protected]

TEfRoomLevel iRoomLevelData

TEfRoomLevel iRoomLevelData[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.