CAudioEqualizer Class Reference

API published in: S60 3rd Ed

Link against: audioequalizereffect.lib

Capability Information

Required Capabilities

None

#include <audioequalizerbase.h>

Inherits CAudioEffect.

Detailed Description

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


Public Member Functions
virtual IMPORT_C	~CAudioEqualizer ()
	Destructor.
IMPORT_C TInt32	BandLevel (TUint8 aBand) const
	Get the band level in mB for the specified band.
IMPORT_C TInt32	BandWidth (TUint8 aBand) const
	Get the band width in Hz for the specified band.
IMPORT_C TInt32	CenterFrequency (TUint8 aBand) const
	Get the center frequency in Hz for a given band.
IMPORT_C TInt32	CrossoverFrequency (TUint8 aBand) const
	Get the cross-over frequency between the given frequency band (aBand) and the next band.
IMPORT_C void	DbLevelLimits (TInt32 &aMin, TInt32 &aMax)
	Get the dB range in mB for the equalizer.
IMPORT_C TUint8	NumberOfBands () const
	Get number of equalizer bands.
IMPORT_C void	SetBandLevelL (TInt8 aBand, TInt32 aLevel)
	Sets the equalizer band level value in mB, ranging from Min to Max.
IMPORT_C TUid	Uid () const
Static Public Member Functions
static IMPORT_C CAudioEqualizer *	NewL ()
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMdaAudioConvertUtility &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMdaAudioInputStream &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMdaAudioOutputStream &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMdaAudioPlayerUtility &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMdaAudioRecorderUtility &aUtility, TBool aRecordStream)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMdaAudioToneUtility &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMMFDevSound &aDevSound)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CCustomCommandUtility *aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (MCustomInterface &aCustomInterface)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CMidiClientUtility &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CDrmPlayerUtility &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizer *	NewL (CVideoPlayerUtility &aUtility)
	Factory function for creating the audio equalizer object.
Protected Member Functions
IMPORT_C const TDesC8 &	DoEffectData ()
	From CAudioEffect Create a package of the effect data.
IMPORT_C void	SetEffectData (const TDesC8 &aEffectDataBuffer)
	From CAudioEffect Internal function to unpack effect data.
IMPORT_C	CAudioEqualizer ()
	Private C++ constructor for this class.
IMPORT_C const TDesC8 &	DoBandDataL (TUint8 aBand, TBool aAllBands)
	Create a descriptor containing data for the specified band(s).
IMPORT_C void	SetBandDataL (TInt aNumberOfBands, const TDesC8 &aBandDataBuffer)
	Unpack band data from the specified descriptor.
Protected Attributes
TEfAudioEqualizer	iAudioEqualizerData
RArray< TEfAudioEqualizerBand >	iBandsData
TEfAudioEqualizerDataPckg	iDataPckgTo
TEfAudioEqualizerBandDataPckg	iBandDataPckgTo
TUint32	iBandChange
HBufC8 *	iBandDataBuf
Friends
class	CAudioEqualizerMessageHandler
class	CAudioEqualizerUtility

Constructor & Destructor Documentation

virtual IMPORT_C CAudioEqualizer::~CAudioEqualizer ( ) [virtual]

Destructor.

IMPORT_C CAudioEqualizer::CAudioEqualizer ( ) [protected]

Private C++ constructor for this class.

Returns:: -

Member Function Documentation

IMPORT_C TInt32 CAudioEqualizer::BandLevel

(

TUint8

aBand

)

const

Get the band level in mB for the specified band.

Parameters:

aBand

Frequency Band

Returns:: Returns the band level in mB for the specified band

IMPORT_C TInt32 CAudioEqualizer::BandWidth

(

TUint8

aBand

)

const

Get the band width in Hz for the specified band.

Parameters:

aBand

Frequency Band

Returns:: The band width in Hz for the specified band

IMPORT_C TInt32 CAudioEqualizer::CenterFrequency

(

TUint8

aBand

)

const

Get the center frequency in Hz for a given band.

Parameters:

aBand

Frequency Band

Returns:: The center frequency in Hz for a given band.

IMPORT_C TInt32 CAudioEqualizer::CrossoverFrequency

(

TUint8

aBand

)

const

Get the cross-over frequency between the given frequency band (aBand) and the next band.

Parameters:

aBand

Frequency Band

Returns:: Crossover frequency.

IMPORT_C void CAudioEqualizer::DbLevelLimits	(	TInt32 &	aMin,
		TInt32 &	aMax
	)

Get the dB range in mB for the equalizer.

Parameters:

	aMin	Minimum level in dB
	aMin	Maximum level in dB

IMPORT_C const TDesC8& CAudioEqualizer::DoBandDataL	(	TUint8	aBand,
		TBool	aAllBands
	)	`[protected]`

Create a descriptor containing data for the specified band(s).

Parameters:

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

Returns:: A descriptor containing data for specified band.

IMPORT_C const TDesC8& CAudioEqualizer::DoEffectData ( ) [protected, virtual]

From CAudioEffect Create a package of the effect data.

Returns:: A descriptor containing the effect data.

Implements CAudioEffect.

static IMPORT_C CAudioEqualizer* CAudioEqualizer::NewL ( CVideoPlayerUtility & aUtility ) [static]