Symbian^3 Application Developer Library >

CAudioEqualizer Class Reference

class CAudioEqualizer : public CAudioEffect

This is the Equalizer effect class for managing audio equalizer settings.

AudioEqualizerEffect.lib
Since
3.0

Inherits from

Public Member Functions
~CAudioEqualizer ()
IMPORT_C TInt32 BandLevel ( TUint8 )
IMPORT_C TInt32 BandWidth ( TUint8 )
IMPORT_C TInt32 CenterFrequency ( TUint8 )
IMPORT_C TInt32 CrossoverFrequency ( TUint8 )
IMPORT_C void DbLevelLimits ( TInt32 &, TInt32 &)
IMPORT_C CAudioEqualizer * NewL ()
IMPORT_C CAudioEqualizer * NewL (CMdaAudioConvertUtility &)
IMPORT_C CAudioEqualizer * NewL ( CMdaAudioInputStream &)
IMPORT_C CAudioEqualizer * NewL ( CMdaAudioOutputStream &)
IMPORT_C CAudioEqualizer * NewL ( CMdaAudioPlayerUtility &)
IMPORT_C CAudioEqualizer * NewL (CMdaAudioRecorderUtility &, TBool )
IMPORT_C CAudioEqualizer * NewL ( CMdaAudioToneUtility &)
IMPORT_C CAudioEqualizer * NewL ( CMMFDevSound &)
IMPORT_C CAudioEqualizer * NewL ( CCustomCommandUtility *)
IMPORT_C CAudioEqualizer * NewL ( MCustomInterface &)
IMPORT_C CAudioEqualizer * NewL (CMidiClientUtility &)
IMPORT_C CAudioEqualizer * NewL ( CDrmPlayerUtility &)
IMPORT_C CAudioEqualizer * NewL (CVideoPlayerUtility &)
IMPORT_C TUint8 NumberOfBands ()
IMPORT_C void SetBandLevelL ( TInt8 , TInt32 )
IMPORT_C TUid Uid ()
Protected Member Functions
CAudioEqualizer ()
IMPORT_C const TDesC8 & DoBandDataL ( TUint8 , TBool )
IMPORT_C const TDesC8 & DoEffectData ()
IMPORT_C void SetBandDataL ( TInt , const TDesC8 &)
IMPORT_C void SetEffectData (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
TEfAudioEqualizer iAudioEqualizerData
TUint32 iBandChange
HBufC8 * iBandDataBuf
TEfAudioEqualizerBandDataPckg iBandDataPckgTo
RArray < TEfAudioEqualizerBand > iBandsData
TEfAudioEqualizerDataPckg iDataPckgTo
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers

Constructor & Destructor Documentation

CAudioEqualizer()

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

~CAudioEqualizer()

IMPORT_C ~CAudioEqualizer ( ) [virtual]

Destructor

Member Functions Documentation

BandLevel(TUint8)

IMPORT_C TInt32 BandLevel ( TUint8 aBand ) const
Get the band level in mB for the specified band
Since
3.0

Parameters

TUint8 aBand Frequency Band

BandWidth(TUint8)

IMPORT_C TInt32 BandWidth ( TUint8 aBand ) const
Get the band width in Hz for the specified band.
Since
3.0

Parameters

TUint8 aBand Frequency Band

CenterFrequency(TUint8)

IMPORT_C TInt32 CenterFrequency ( TUint8 aBand ) const
Get the center frequency in Hz for a given band
Since
3.0

Parameters

TUint8 aBand Frequency Band

CrossoverFrequency(TUint8)

IMPORT_C TInt32 CrossoverFrequency ( TUint8 aBand ) const
Get the cross-over frequency between the given frequency band (aBand) and the next band
Since
3.0

Parameters

TUint8 aBand Frequency Band

DbLevelLimits(TInt32 &, TInt32 &)

IMPORT_C void DbLevelLimits ( TInt32 & aMin,
TInt32 & aMax
)
Get the dB range in mB for the equalizer
Since
3.0

Parameters

TInt32 & aMin Maximum level in dB
TInt32 & aMax

DoBandDataL(TUint8, TBool)

IMPORT_C const TDesC8 & DoBandDataL ( TUint8 aBand,
TBool aAllBands
) [protected]
Create a descriptor containing data for the specified band(s).
Since
3.0

Parameters

TUint8 aBand The frequency band data to package. Valid if aAllBands = EFalse.
TBool aAllBands Indicate if data for all bands is requested.

DoEffectData()

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

NewL()

IMPORT_C CAudioEqualizer * NewL ( ) [static]
Factory function for creating the audio equalizer object.
Since
3.0

NewL(CMdaAudioConvertUtility &)

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

Parameters

CMdaAudioConvertUtility & aUtility A reference to a convert utility

NewL(CMdaAudioInputStream &)

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

Parameters

CMdaAudioInputStream & aUtility A reference to an audio input stream utility

NewL(CMdaAudioOutputStream &)

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

Parameters

CMdaAudioOutputStream & aUtility A reference to an audio output stream utility

NewL(CMdaAudioPlayerUtility &)

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

Parameters

CMdaAudioPlayerUtility & aUtility A reference to an audio player utility

NewL(CMdaAudioRecorderUtility &, TBool)

IMPORT_C CAudioEqualizer * NewL ( CMdaAudioRecorderUtility & aUtility,
TBool aRecordStream
) [static]
Factory function for creating the audio equalizer object.
Since
3.0

Parameters

CMdaAudioRecorderUtility & aUtility A reference to an audio record utility
TBool aRecordStream ETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback

NewL(CMdaAudioToneUtility &)

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

Parameters

CMdaAudioToneUtility & aUtility A reference to an audio tone utility

NewL(CMMFDevSound &)

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

Parameters

CMMFDevSound & aDevSound A reference to a DevSound instance

NewL(CCustomCommandUtility *)

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

Parameters

CCustomCommandUtility * aUtility A reference to a custom command utility

NewL(MCustomInterface &)

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

Parameters

MCustomInterface & aCustomInterface A reference to a custom interface

NewL(CMidiClientUtility &)

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

Parameters

CMidiClientUtility & aUtility

NewL(CDrmPlayerUtility &)

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

Parameters

CDrmPlayerUtility & aUtility

NewL(CVideoPlayerUtility &)

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

Parameters

CVideoPlayerUtility & aUtility

NumberOfBands()

IMPORT_C TUint8 NumberOfBands ( ) const
Get number of equalizer bands.
Since
3.0

SetBandDataL(TInt, const TDesC8 &)

IMPORT_C void SetBandDataL ( TInt aNumberOfBands,
const TDesC8 & aBandDataBuffer
) [protected]
Unpack band data from the specified descriptor.
Since
3.0

Parameters

TInt aNumberOfBands Number of bands contained in the descriptor.
const TDesC8 & aBandDataBuffer Descriptor containing band data

SetBandLevelL(TInt8, TInt32)

IMPORT_C void SetBandLevelL ( TInt8 aBand,
TInt32 aLevel
)
Sets the equalizer band level value in mB, ranging from Min to Max
Since
3.0

Parameters

TInt8 aBand Frequency Band
TInt32 aLevel band level in dB, ranges from DbLevelLimits()

SetEffectData(const TDesC8 &)

IMPORT_C void SetEffectData ( const TDesC8 & aEffectDataBuffer ) [protected, virtual]
From CAudioEffect Internal function to unpack effect data
Since
3.0

Parameters

const TDesC8 & aEffectDataBuffer Descriptor containing packed effect data

Uid()

IMPORT_C TUid Uid ( ) const [virtual]

Member Data Documentation

TEfAudioEqualizer iAudioEqualizerData

TEfAudioEqualizer iAudioEqualizerData [protected]

TUint32 iBandChange

TUint32 iBandChange [protected]

HBufC8 * iBandDataBuf

HBufC8 * iBandDataBuf [protected]

TEfAudioEqualizerBandDataPckg iBandDataPckgTo

TEfAudioEqualizerBandDataPckg iBandDataPckgTo [protected]

RArray< TEfAudioEqualizerBand > iBandsData

RArray < TEfAudioEqualizerBand > iBandsData [protected]

TEfAudioEqualizerDataPckg iDataPckgTo

TEfAudioEqualizerDataPckg iDataPckgTo [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.