CAudioEqualizer Class Reference

Link against: AudioEqualizerEffect.lib BassBoostEffect.lib DistanceAttenuationEffect.lib DopplerBase.lib EffectBase.lib EnvironmentalReverbEffect.lib ListenerDopplerEffect.lib ListenerLocationEffect.lib ListenerOrientationEffect.lib LocationBase.lib LoudnessEffect.lib OrientationBase.lib RoomLevelEffect.lib SourceDopplerEffect.lib SourceLocationEffect.lib SourceOrientationEffect.lib StereoWideningEffect.lib

Capability Information

Required Capabilities

None

#include <AudioEqualizerBase.h>

Inherits CAudioEffect.

Detailed Description

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

Dll AudioEqualizerEffect.lib

Since:: 3.0


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.

Since:: 3.0

Returns:: -

Member Function Documentation

IMPORT_C TInt32 CAudioEqualizer::BandLevel

(

TUint8

aBand

)

const

Get the band level in mB for the specified band.

Since:: 3.0

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.

Since:: 3.0

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.

Since:: 3.0

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.

Since:: 3.0

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.

Since:: 3.0

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).

Since:: 3.0

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.

Since:: 3.0

Returns:: A descriptor containing the effect data.

Implements CAudioEffect.

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

Factory function for creating the audio equalizer object.

Since:: 3.2

Parameters:

CVideoPlayerUtility

A reference to a CVideoPlayerUtility object

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

CDrmPlayerUtility

A reference to a CDrmPlayerUtility object

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

CMidiClientUtility

A reference to a CMidiClientUtility object

Returns:: pointer to CAudioEqualizer object

static IMPORT_C CAudioEqualizer* CAudioEqualizer::NewL ( MCustomInterface & aCustomInterface ) [static]

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aCustomInterface

A reference to a custom interface

Returns:: pointer to CAudioEqualizer object

static IMPORT_C CAudioEqualizer* CAudioEqualizer::NewL ( CCustomCommandUtility * aUtility ) [static]

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aUtility

A reference to a custom command utility

Returns:: pointer to CAudioEqualizer object

static IMPORT_C CAudioEqualizer* CAudioEqualizer::NewL ( CMMFDevSound & aDevSound ) [static]

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aDevSound

A reference to a DevSound instance

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aUtility

A reference to an audio tone utility

Returns:: pointer to CAudioEqualizer object

static IMPORT_C CAudioEqualizer* CAudioEqualizer::NewL	(	CMdaAudioRecorderUtility &	aUtility,
		TBool	aRecordStream
	)	`[static]`

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

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

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aUtility

A reference to an audio player utility

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aUtility

A reference to an audio output stream utility

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aUtility

A reference to an audio input stream utility

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Since:: 3.0

Parameters:

aUtility

A reference to a convert utility

Returns:: pointer to CAudioEqualizer object

static IMPORT_C CAudioEqualizer* CAudioEqualizer::NewL ( ) [static]

Factory function for creating the audio equalizer object.

Since:: 3.0

Returns:: pointer to CAudioEqualizer object

IMPORT_C TUint8 CAudioEqualizer::NumberOfBands

(

)

const

Get number of equalizer bands.

Since:: 3.0

Parameters:

Returns:: The number of equalizer bands.

IMPORT_C void CAudioEqualizer::SetBandDataL	(	TInt	aNumberOfBands,
		const TDesC8 &	aBandDataBuffer
	)	`[protected]`

Unpack band data from the specified descriptor.

Since:: 3.0

Parameters:

	aNumberOfBands	Number of bands contained in the descriptor.
	aBandDataBuffer	Descriptor containing band data

IMPORT_C void CAudioEqualizer::SetBandLevelL	(	TInt8	aBand,
		TInt32	aLevel
	)

Sets the equalizer band level value in mB, ranging from Min to Max.

Since:: 3.0

Parameters:

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

Returns:: -

IMPORT_C void CAudioEqualizer::SetEffectData ( const TDesC8 & aEffectDataBuffer ) [protected, virtual]

From CAudioEffect Internal function to unpack effect data.

Since:: 3.0

Parameters:

aEffectDataBuffer

Descriptor containing packed effect data

Returns:: -

Implements CAudioEffect.

IMPORT_C TUid CAudioEqualizer::Uid ( ) const [virtual]

Implements CAudioEffect.

Friends And Related Function Documentation

friend class CAudioEqualizerMessageHandler [friend]

friend class CAudioEqualizerUtility [friend]

Field Documentation

TEfAudioEqualizer CAudioEqualizer::iAudioEqualizerData [protected]

TUint32 CAudioEqualizer::iBandChange [protected]

HBufC8* CAudioEqualizer::iBandDataBuf [protected]

TEfAudioEqualizerBandDataPckg CAudioEqualizer::iBandDataPckgTo [protected]

RArray<TEfAudioEqualizerBand> CAudioEqualizer::iBandsData [protected]

TEfAudioEqualizerDataPckg CAudioEqualizer::iDataPckgTo [protected]

The documentation for this class was generated from the following file:

AudioEqualizerBase.h

CAudioEqualizer Class Reference

Capability Information

Required Capabilities

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation