Symbian^3 Product 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

  • CAudioEqualizerUtility
Public Member Functions
~CAudioEqualizerUtility()
IMPORT_C voidApplyPresetL(TInt)
IMPORT_C CBassBoost &BassBoost()
IMPORT_C voidCreatePresetL(TDesC &, CAudioEqualizer &)
IMPORT_C voidDeletePresetL(TInt)
IMPORT_C voidDisableEqualizerL()
IMPORT_C CAudioEqualizer &Equalizer()
IMPORT_C const TDesC &GetPresetL(TInt)
IMPORT_C voidModifyPresetL(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 TUint32NumberOfPreDefinedPresets()
IMPORT_C TArray< TEfAudioEqualizerUtilityPreset >Presets()
IMPORT_C voidResetPresetL(TInt)
Private Member Functions
CAudioEqualizerUtility()
voidConstructL(CMMFDevSound &)
voidConstructL(CMdaAudioConvertUtility &)
voidConstructL(CMdaAudioInputStream &)
voidConstructL(CMdaAudioOutputStream &)
voidConstructL(CMdaAudioPlayerUtility &)
voidConstructL(CMdaAudioRecorderUtility &)
voidConstructL(CMdaAudioToneUtility &)
voidConstructL(CCustomCommandUtility *)
voidConstructL(MCustomInterface &)
voidConstructL(CMidiClientUtility &)
voidConstructL(CDrmPlayerUtility &)
voidConstructL(CVideoPlayerUtility &)
voidUpdateFullPresetArrayFromCenRep(RArray< TEfAudioEqualizerUtilityPreset > &)
voidUpdatePresetArray(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 voidApplyPresetL(TIntaPreset)
Apply the Preset Index value
Since
3.0

Parameters

TInt aPresetPreset Value

BassBoost()

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

ConstructL(CMMFDevSound &)

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

Parameters

CMMFDevSound & aDevSoundDevSound Referece

ConstructL(CMdaAudioConvertUtility &)

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

Parameters

CMdaAudioConvertUtility & aUtilityCMdaAudioConvertUtility Referece

ConstructL(CMdaAudioInputStream &)

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

Parameters

CMdaAudioInputStream & aUtilityCMdaAudioInputStream Referece

ConstructL(CMdaAudioOutputStream &)

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

Parameters

CMdaAudioOutputStream & aUtility

ConstructL(CMdaAudioPlayerUtility &)

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

Parameters

CMdaAudioPlayerUtility & aUtilityCMdaAudioPlayerUtility Referece

ConstructL(CMdaAudioRecorderUtility &)

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

Parameters

CMdaAudioRecorderUtility & aUtilityCMdaAudioRecordUtility Referece

ConstructL(CMdaAudioToneUtility &)

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

Parameters

CMdaAudioToneUtility & aUtilityCMdaAudioToneUtility Referece

ConstructL(CCustomCommandUtility *)

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

Parameters

CCustomCommandUtility * aUtilityMCustomCommand Referece

ConstructL(MCustomInterface &)

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

Parameters

MCustomInterface & aCustomInterface

ConstructL(CMidiClientUtility &)

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

Parameters

CMidiClientUtility & aUtilityCMidiClientUtility Referece

ConstructL(CDrmPlayerUtility &)

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

Parameters

CDrmPlayerUtility & aUtilityCDrmPlayerUtility Referece

ConstructL(CVideoPlayerUtility &)

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

Parameters

CVideoPlayerUtility & aUtilityCVideoPlayerUtility Referece

CreatePresetL(TDesC &, CAudioEqualizer &)

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

Parameters

TDesC & aNameName of the Preset
CAudioEqualizer & aAudioEqualizerUI

DeletePresetL(TInt)

IMPORT_C voidDeletePresetL(TIntaPresetIndex)
Delete a Preset with the given index in the Central Repository
Since
3.0

Parameters

TInt aPresetIndexIndex of the Preset in the Array

DisableEqualizerL()

IMPORT_C voidDisableEqualizerL()
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(TIntaPresetIndex)
Retrieves a Preset with the given index from the Central Repository
Since
3.0

Parameters

TInt aPresetIndexIndex of the Preset in the Array

ModifyPresetL(TInt, TDesC &, CAudioEqualizer &)

IMPORT_C voidModifyPresetL(TIntaPresetIndex,
TDesC &aName,
CAudioEqualizer &aAudioEqualizerUI
)
Modify a Preset with the given Name and Equalizer Settings
Since
3.0

Parameters

TInt aPresetIndexArray Index of the Preset
TDesC & aNameName 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 & aUtilityA 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 & aUtilityA 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 & aUtilityA 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 & aUtilityA 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 & aUtilityA 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 & aUtilityA 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 * aUtilityA 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 & aUtilityA 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 TUint32NumberOfPreDefinedPresets()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 voidResetPresetL(TIntaPresetIndex)
Reset a System Defined Preset with the given index in the Array returned from Presets()
Since
3.0

Parameters

TInt aPresetIndexIndex of the Preset in the Array

UpdateFullPresetArrayFromCenRep(RArray< TEfAudioEqualizerUtilityPreset > &)

voidUpdateFullPresetArrayFromCenRep(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 > &)

voidUpdatePresetArray(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.