Symbian^3 Application Developer Library >

CAudioEqualizerUtility Class Reference

class CAudioEqualizerUtility : public CBase

This is the Equalizer Utility class for managing audio equalizer presets.

AudioEqualizerUtility.lib
Since
3.0

Inherits from

Public Member Functions
~CAudioEqualizerUtility ()
IMPORT_C void ApplyPresetL ( TInt )
IMPORT_C CBassBoost & BassBoost ()
IMPORT_C void CreatePresetL ( TDesC &, CAudioEqualizer &)
IMPORT_C void DeletePresetL ( TInt )
IMPORT_C void DisableEqualizerL ()
IMPORT_C CAudioEqualizer & Equalizer ()
IMPORT_C const TDesC & GetPresetL ( TInt )
IMPORT_C void ModifyPresetL ( TInt , TDesC &, CAudioEqualizer &)
IMPORT_C CAudioEqualizerUtility * NewL (CMMFDevSound &)
IMPORT_C CAudioEqualizerUtility * NewL (CMdaAudioConvertUtility &)
IMPORT_C CAudioEqualizerUtility * NewL (CMdaAudioInputStream &)
IMPORT_C CAudioEqualizerUtility * NewL (CMdaAudioOutputStream &)
IMPORT_C CAudioEqualizerUtility * NewL ( CMdaAudioPlayerUtility &)
IMPORT_C CAudioEqualizerUtility * NewL (CMdaAudioRecorderUtility &)
IMPORT_C CAudioEqualizerUtility * NewL (CMdaAudioToneUtility &)
IMPORT_C CAudioEqualizerUtility * NewL (CCustomCommandUtility *)
IMPORT_C CAudioEqualizerUtility * NewL ( MCustomInterface &)
IMPORT_C CAudioEqualizerUtility * NewL (CMidiClientUtility &)
IMPORT_C CAudioEqualizerUtility * NewL ( CDrmPlayerUtility &)
IMPORT_C CAudioEqualizerUtility * NewL ( CVideoPlayerUtility &)
IMPORT_C TUint32 NumberOfPreDefinedPresets ()
IMPORT_C TArray < TEfAudioEqualizerUtilityPreset > Presets ()
IMPORT_C void ResetPresetL ( TInt )
Private Member Functions
CAudioEqualizerUtility ()
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 < TEfAudioEqualizerUtilityPreset > &)
void UpdatePresetArray ( RArray < TEfAudioEqualizerUtilityPreset > &, const RArray < TEfAudioEqualizerUtilityPreset > &)
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
CAudioEqualizer * iAudioEqualizer
CBassBoost * iBassBoost
RArray < TEfAudioEqualizerUtilityPreset > iFullPresetArray
RArray < TEfAudioEqualizerUtilityPreset > iPresetArray
CRepository * iPresetRepository
CAudioEqualizer * iTransAudioEqualizer

Constructor & Destructor Documentation

CAudioEqualizerUtility()

CAudioEqualizerUtility ( ) [private]

C++ default constructor.

~CAudioEqualizerUtility()

~CAudioEqualizerUtility ( ) [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

BassBoost()

IMPORT_C CBassBoost & BassBoost ( )
Get the reference to the BassBoost Object
Since
3.0

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 &, CAudioEqualizer &)

IMPORT_C void CreatePresetL ( TDesC & aName,
CAudioEqualizer & aAudioEqualizerUI
)
Create a Preset with the given Name and Equalizer Settings
Since
3.0

Parameters

TDesC & aName Name of the Preset
CAudioEqualizer & aAudioEqualizerUI

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

DisableEqualizerL()

IMPORT_C void DisableEqualizerL ( )
Disable the Equalizer
Since
3.0

Equalizer()

IMPORT_C CAudioEqualizer & Equalizer ( )
Get the reference to the Equalizer 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 &, CAudioEqualizer &)

IMPORT_C void ModifyPresetL ( TInt aPresetIndex,
TDesC & aName,
CAudioEqualizer & aAudioEqualizerUI
)
Modify a Preset with the given Name and Equalizer Settings
Since
3.0

Parameters

TInt aPresetIndex Array Index of the Preset
TDesC & aName Name of the Preset
CAudioEqualizer & aAudioEqualizerUI

NewL(CMMFDevSound &)

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

Parameters

CMMFDevSound & aDevSound

NewL(CMdaAudioConvertUtility &)

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

Parameters

CMdaAudioConvertUtility & aUtility A reference to a convert utility

NewL(CMdaAudioInputStream &)

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

Parameters

CMdaAudioInputStream & aUtility A reference to a audio input stream utility

NewL(CMdaAudioOutputStream &)

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

Parameters

CMdaAudioOutputStream & aUtility A reference to a audio output stream utility

NewL(CMdaAudioPlayerUtility &)

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

Parameters

CMdaAudioPlayerUtility & aUtility A reference to a audio player utility

NewL(CMdaAudioRecorderUtility &)

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

Parameters

CMdaAudioRecorderUtility & aUtility A reference to a audio recorder utility

NewL(CMdaAudioToneUtility &)

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

Parameters

CMdaAudioToneUtility & aUtility A reference to a audio tone utility

NewL(CCustomCommandUtility *)

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

Parameters

CCustomCommandUtility * aUtility A reference to custom command utility

NewL(MCustomInterface &)

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

Parameters

MCustomInterface & aCustomInterface

NewL(CMidiClientUtility &)

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

Parameters

CMidiClientUtility & aUtility A reference to CMidiClientUtility

NewL(CDrmPlayerUtility &)

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

Parameters

CDrmPlayerUtility & aUtility

NewL(CVideoPlayerUtility &)

IMPORT_C CAudioEqualizerUtility * 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 < TEfAudioEqualizerUtilityPreset > 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< TEfAudioEqualizerUtilityPreset > &)

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

Parameters

RArray < TEfAudioEqualizerUtilityPreset > & aFullPresetArray

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

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

Parameters

RArray < TEfAudioEqualizerUtilityPreset > & aPresetArray
const RArray < TEfAudioEqualizerUtilityPreset > & aFullPresetArray

Member Data Documentation

CAudioEqualizer * iAudioEqualizer

CAudioEqualizer * iAudioEqualizer [private]

CBassBoost * iBassBoost

CBassBoost * iBassBoost [private]

RArray< TEfAudioEqualizerUtilityPreset > iFullPresetArray

RArray < TEfAudioEqualizerUtilityPreset > iFullPresetArray [private]

RArray< TEfAudioEqualizerUtilityPreset > iPresetArray

RArray < TEfAudioEqualizerUtilityPreset > iPresetArray [private]

CRepository * iPresetRepository

CRepository * iPresetRepository [private]

CAudioEqualizer * iTransAudioEqualizer

CAudioEqualizer * iTransAudioEqualizer [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.