Symbian^3 Application Developer Library >

CEnvironmentalReverbUtility Class Reference

class CEnvironmentalReverbUtility : public CBase

This is the EnvironmentalReverb Utility class for managing audio EnvironmentalReverb presets.

EnvironmentalReverbUtility.lib
Since
3.0

Inherits from

  • CEnvironmentalReverbUtility
Public Member Functions
~CEnvironmentalReverbUtility ()
IMPORT_C void ApplyPresetL ( TInt )
IMPORT_C void CreatePresetL ( TDesC &, CEnvironmentalReverb &)
IMPORT_C void DeletePresetL ( TInt )
IMPORT_C void DisableEnvironmentalReverbL ()
IMPORT_C CEnvironmentalReverb & EnvironmentalReverb ()
IMPORT_C const TDesC & GetPresetL ( TInt )
IMPORT_C void ModifyPresetL ( TInt , TDesC &, CEnvironmentalReverb &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CMMFDevSound &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CMdaAudioConvertUtility &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CMdaAudioInputStream &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CMdaAudioOutputStream &)
IMPORT_C CEnvironmentalReverbUtility * NewL ( CMdaAudioPlayerUtility &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CMdaAudioRecorderUtility &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CMdaAudioToneUtility &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CCustomCommandUtility *)
IMPORT_C CEnvironmentalReverbUtility * NewL ( MCustomInterface &)
IMPORT_C CEnvironmentalReverbUtility * NewL (CMidiClientUtility &)
IMPORT_C CEnvironmentalReverbUtility * NewL ( CDrmPlayerUtility &)
IMPORT_C CEnvironmentalReverbUtility * NewL ( CVideoPlayerUtility &)
IMPORT_C TUint32 NumberOfPreDefinedPresets ()
IMPORT_C TArray < TEfEnvironmentalReverbUtilityPreset > Presets ()
IMPORT_C void ResetPresetL ( TInt )
Private Member Functions
CEnvironmentalReverbUtility ()
void ConstructL (CMMFDevSound &)
void ConstructL (CMdaAudioConvertUtility &)
void ConstructL (CMdaAudioInputStream &)
void ConstructL (CMdaAudioOutputStream &)
void ConstructL ( CMdaAudioPlayerUtility &)
void ConstructL (CMdaAudioRecorderUtility &)
void ConstructL (CMdaAudioToneUtility &)
void ConstructL (CCustomCommandUtility *)
void ConstructL ( MCustomInterface &)
void ConstructL (CMidiClientUtility &)
void ConstructL ( CDrmPlayerUtility &)
void ConstructL ( CVideoPlayerUtility &)
void UpdateFullPresetArrayFromCenRep ( RArray < TEfEnvironmentalReverbUtilityPreset > &)
void UpdatePresetArray ( RArray < TEfEnvironmentalReverbUtilityPreset > &, const RArray < TEfEnvironmentalReverbUtilityPreset > &)
Inherited Functions
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()
Private Attributes
CEnvironmentalReverb * iEnvironmentalReverb
RArray < TEfEnvironmentalReverbUtilityPreset > iFullPresetArray
RArray < TEfEnvironmentalReverbUtilityPreset > iPresetArray
CRepository * iPresetRepository
CEnvironmentalReverb * iTransEnvironmentalReverb

Constructor & Destructor Documentation

CEnvironmentalReverbUtility()

CEnvironmentalReverbUtility ( ) [private]

C++ default constructor.

~CEnvironmentalReverbUtility()

~CEnvironmentalReverbUtility ( ) [virtual]

Destructor.

Member Functions Documentation

ApplyPresetL(TInt)

IMPORT_C void ApplyPresetL ( TInt aPreset )
Apply the Preset Index value
Since
3.0

Parameters

TInt aPreset Preset Value

ConstructL(CMMFDevSound &)

void ConstructL ( CMMFDevSound & aDevSound ) [private]
By default Symbian 2nd phase constructor is private. Second Phase Costructor for DevSound Instance
Since
3.0

Parameters

CMMFDevSound & aDevSound DevSound Referece

ConstructL(CMdaAudioConvertUtility &)

void ConstructL ( CMdaAudioConvertUtility & aUtility ) [private]
Second Phase Costructor for Audio Convert Utility
Since
3.0

Parameters

CMdaAudioConvertUtility & aUtility CMdaAudioConvertUtility Referece

ConstructL(CMdaAudioInputStream &)

void ConstructL ( CMdaAudioInputStream & aUtility ) [private]
Second Phase Costructor for CMdaAudioInputStream
Since
3.0

Parameters

CMdaAudioInputStream & aUtility CMdaAudioInputStream Referece

ConstructL(CMdaAudioOutputStream &)

void ConstructL ( CMdaAudioOutputStream & aUtility ) [private]
Second Phase Costructor for CMdaAudioOutputStream
Since
3.0

Parameters

CMdaAudioOutputStream & aUtility

ConstructL(CMdaAudioPlayerUtility &)

void ConstructL ( CMdaAudioPlayerUtility & aUtility ) [private]
Second Phase Costructor for CMdaAudioPlayerUtility
Since
3.0

Parameters

CMdaAudioPlayerUtility & aUtility CMdaAudioPlayerUtility Referece

ConstructL(CMdaAudioRecorderUtility &)

void ConstructL ( CMdaAudioRecorderUtility & aUtility ) [private]
Second Phase Costructor for CMdaAudioRecordUtility
Since
3.0

Parameters

CMdaAudioRecorderUtility & aUtility CMdaAudioRecordUtility Referece

ConstructL(CMdaAudioToneUtility &)

void ConstructL ( CMdaAudioToneUtility & aUtility ) [private]
Second Phase Costructor for CMdaAudioToneUtility
Since
3.0

Parameters

CMdaAudioToneUtility & aUtility CMdaAudioToneUtility Referece

ConstructL(CCustomCommandUtility *)

void ConstructL ( CCustomCommandUtility * aUtility ) [private]
Second Phase Costructor for MCustomCommand
Since
3.0

Parameters

CCustomCommandUtility * aUtility MCustomCommand Referece

ConstructL(MCustomInterface &)

void ConstructL ( MCustomInterface & aCustomInterface ) [private]
Second Phase Costructor for MCustomInterface
Since
3.0

Parameters

MCustomInterface & aCustomInterface

ConstructL(CMidiClientUtility &)

void ConstructL ( CMidiClientUtility & aUtility ) [private]
Second Phase Costructor for CMidiClientUtility
Since
3.0

Parameters

CMidiClientUtility & aUtility CMidiClientUtility Referece

ConstructL(CDrmPlayerUtility &)

void ConstructL ( CDrmPlayerUtility & aUtility ) [private]
Second Phase Costructor for CDrmPlayerUtility
Since
3.0

Parameters

CDrmPlayerUtility & aUtility CDrmPlayerUtility Referece

ConstructL(CVideoPlayerUtility &)

void ConstructL ( CVideoPlayerUtility & aUtility ) [private]
Second Phase Costructor for CVideoPlayerUtility
Since
3.2

Parameters

CVideoPlayerUtility & aUtility CVideoPlayerUtility Referece

CreatePresetL(TDesC &, CEnvironmentalReverb &)

IMPORT_C void CreatePresetL ( TDesC & aName,
CEnvironmentalReverb & aEnvironmentalReverbUI
)
Create a Preset with the given Name and EnvironmentalReverb Settings
Since
3.0

Parameters

TDesC & aName Name of the Preset
CEnvironmentalReverb & aEnvironmentalReverbUI

DeletePresetL(TInt)

IMPORT_C void DeletePresetL ( TInt aPresetIndex )
Delete a Preset with the given index in the Central Repository
Since
3.0

Parameters

TInt aPresetIndex Index of the Preset in the Array

DisableEnvironmentalReverbL()

IMPORT_C void DisableEnvironmentalReverbL ( )
Disable the EnvironmentalReverb
Since
3.0

EnvironmentalReverb()

IMPORT_C CEnvironmentalReverb & EnvironmentalReverb ( )
Get the reference to the EnvironmentalReverb Object
Since
3.0

GetPresetL(TInt)

IMPORT_C const TDesC & GetPresetL ( TInt aPresetIndex )
Retrieves a Preset with the given index from the Central Repository
Since
3.0

Parameters

TInt aPresetIndex Index of the Preset in the Array

ModifyPresetL(TInt, TDesC &, CEnvironmentalReverb &)

IMPORT_C void ModifyPresetL ( TInt aPresetIndex,
TDesC & aName,
CEnvironmentalReverb & aEnvironmentalReverbUI
)
Modify a Preset with the given Name and EnvironmentalReverb Settings
Since
3.0

Parameters

TInt aPresetIndex Array Index of the Preset
TDesC & aName Name of the Preset
CEnvironmentalReverb & aEnvironmentalReverbUI

NewL(CMMFDevSound &)

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

Parameters

CMMFDevSound & aDevSound

NewL(CMdaAudioConvertUtility &)

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

Parameters

CMdaAudioConvertUtility & aUtility A reference to a convert utility

NewL(CMdaAudioInputStream &)

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

Parameters

CMdaAudioInputStream & aUtility A reference to a audio input stream utility

NewL(CMdaAudioOutputStream &)

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

Parameters

CMdaAudioOutputStream & aUtility A reference to a audio output stream utility

NewL(CMdaAudioPlayerUtility &)

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

Parameters

CMdaAudioPlayerUtility & aUtility A reference to a audio player utility

NewL(CMdaAudioRecorderUtility &)

IMPORT_C CEnvironmentalReverbUtility * NewL ( CMdaAudioRecorderUtility & aUtility ) [static]
Factory function for creating the audio EnvironmentalReverb utility object.
Since
3.0

Parameters

CMdaAudioRecorderUtility & aUtility A reference to a audio recorder utility

NewL(CMdaAudioToneUtility &)

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

Parameters

CMdaAudioToneUtility & aUtility A reference to a audio tone utility

NewL(CCustomCommandUtility *)

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

Parameters

CCustomCommandUtility * aUtility A reference to custom command utility

NewL(MCustomInterface &)

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

Parameters

MCustomInterface & aCustomInterface

NewL(CMidiClientUtility &)

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

Parameters

CMidiClientUtility & aUtility A reference to CMidiClientUtility

NewL(CDrmPlayerUtility &)

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

Parameters

CDrmPlayerUtility & aUtility

NewL(CVideoPlayerUtility &)

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

Parameters

CVideoPlayerUtility & aUtility

NumberOfPreDefinedPresets()

IMPORT_C TUint32 NumberOfPreDefinedPresets ( ) const
Get the number of Pre Defined Presets
Since
3.0

Presets()

IMPORT_C TArray < TEfEnvironmentalReverbUtilityPreset > Presets ( )
Get all the Presets defined in the Central Repository
Since
3.0

ResetPresetL(TInt)

IMPORT_C void ResetPresetL ( TInt aPresetIndex )
Reset a System Defined Preset with the given index in the Array returned from Presets()
Since
3.0

Parameters

TInt aPresetIndex Index of the Preset in the Array

UpdateFullPresetArrayFromCenRep(RArray< TEfEnvironmentalReverbUtilityPreset > &)

void UpdateFullPresetArrayFromCenRep ( RArray < TEfEnvironmentalReverbUtilityPreset > & aFullPresetArray ) [private]
Function for Updating the Array from the Central Repository
Since
3.0

Parameters

RArray < TEfEnvironmentalReverbUtilityPreset > & aFullPresetArray

UpdatePresetArray(RArray< TEfEnvironmentalReverbUtilityPreset > &, const RArray< TEfEnvironmentalReverbUtilityPreset > &)

void UpdatePresetArray ( RArray < TEfEnvironmentalReverbUtilityPreset > & aPresetArray,
const RArray < TEfEnvironmentalReverbUtilityPreset > & aFullPresetArray
) [private]
Function of Updating the Preset Array for the User
Since
3.0

Parameters

RArray < TEfEnvironmentalReverbUtilityPreset > & aPresetArray
const RArray < TEfEnvironmentalReverbUtilityPreset > & aFullPresetArray

Member Data Documentation

CEnvironmentalReverb * iEnvironmentalReverb

CEnvironmentalReverb * iEnvironmentalReverb [private]

RArray< TEfEnvironmentalReverbUtilityPreset > iFullPresetArray

RArray < TEfEnvironmentalReverbUtilityPreset > iFullPresetArray [private]

RArray< TEfEnvironmentalReverbUtilityPreset > iPresetArray

RArray < TEfEnvironmentalReverbUtilityPreset > iPresetArray [private]

CRepository * iPresetRepository

CRepository * iPresetRepository [private]

CEnvironmentalReverb * iTransEnvironmentalReverb

CEnvironmentalReverb * iTransEnvironmentalReverb [private]

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.