CAudioEqualizer Class Reference

#include <AudioEqualizerBase.h>

Link against: AudioEqualizerEffect.lib

class CAudioEqualizer : public CAudioEffect

Inherits from

CAudioEqualizer
- CAudioEffect

Protected Attributes
TEfAudioEqualizer	iAudioEqualizerData
TUint32	iBandChange
HBufC8 *	iBandDataBuf
TEfAudioEqualizerBandDataPckg	iBandDataPckgTo
RArray< TEfAudioEqualizerBand >	iBandsData
TEfAudioEqualizerDataPckg	iDataPckgTo

Public Member Functions
virtual	~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)
virtual IMPORT_C TUid	Uid()

Protected Member Functions
	CAudioEqualizer()
IMPORT_C const TDesC8 &	DoBandDataL(TUint8, TBool)
virtual IMPORT_C const TDesC8 &	DoEffectData()
IMPORT_C void	SetBandDataL(TInt, const TDesC8 &)
virtual IMPORT_C void	SetEffectData(const TDesC8 &)

Inherited Attributes
	CAudioEffect::iEnabled
	CAudioEffect::iEnforced
	CAudioEffect::iHaveUpdateRights
	CAudioEffect::iObservers

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

Detailed Description

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

Since: 3.0

Member Attribute Documentation

iAudioEqualizerData

TEfAudioEqualizer

iAudioEqualizerData

[protected]

iBandChange

TUint32

iBandChange

[protected]

iBandDataBuf

HBufC8 *

iBandDataBuf

[protected]

iBandDataPckgTo

TEfAudioEqualizerBandDataPckg

iBandDataPckgTo

[protected]

iBandsData

RArray< TEfAudioEqualizerBand >

iBandsData

[protected]

iDataPckgTo

TEfAudioEqualizerDataPckg

iDataPckgTo

[protected]

Constructor & Destructor Documentation

CAudioEqualizer ( )

IMPORT_C

CAudioEqualizer

(

)

[protected]

Private C++ constructor for this class.

Since: 3.0

Returns: -

~CAudioEqualizer ( )

IMPORT_C

~CAudioEqualizer

(

)

[virtual]

Destructor

Member Function Documentation

BandLevel ( TUint8 )

IMPORT_C TInt32

BandLevel

(

TUint8

aBand

)

const

Get the band level in mB for the specified band

Since: 3.0

Parameter	Description
aBand	Frequency Band

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

BandWidth ( TUint8 )

IMPORT_C TInt32

BandWidth

(

TUint8

aBand

)

const

Get the band width in Hz for the specified band.

Since: 3.0

Parameter	Description
aBand	Frequency Band

Returns: The band width in Hz for the specified band

CenterFrequency ( TUint8 )

IMPORT_C TInt32

CenterFrequency

(

TUint8

aBand

)

const

Get the center frequency in Hz for a given band

Since: 3.0

Parameter	Description
aBand	Frequency Band

Returns: The center frequency in Hz for a given 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

Parameter	Description
aBand	Frequency Band

Returns: Crossover frequency.

DbLevelLimits ( TInt32 &, TInt32 & )

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

Get the dB range in mB for the equalizer

Since: 3.0

Parameter	Description
aMin	Maximum level in dB

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

Parameter	Description
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.

DoEffectData ( )

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data

Since: 3.0

Returns: A descriptor containing the effect data.

NewL ( )

IMPORT_C CAudioEqualizer *

NewL

(

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Returns: pointer to CAudioEqualizer object

NewL ( CMdaAudioConvertUtility & )

IMPORT_C CAudioEqualizer *

NewL

(

CMdaAudioConvertUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aUtility	A reference to a convert utility

Returns: pointer to CAudioEqualizer object

NewL ( CMdaAudioInputStream & )

IMPORT_C CAudioEqualizer *

NewL

(

CMdaAudioInputStream &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio input stream utility

Returns: pointer to CAudioEqualizer object

NewL ( CMdaAudioOutputStream & )

IMPORT_C CAudioEqualizer *

NewL

(

CMdaAudioOutputStream &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio output stream utility

Returns: pointer to CAudioEqualizer object

NewL ( CMdaAudioPlayerUtility & )

IMPORT_C CAudioEqualizer *

NewL

(

CMdaAudioPlayerUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio player utility

Returns: pointer to CAudioEqualizer object

NewL ( CMdaAudioRecorderUtility &, TBool )

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

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
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

NewL ( CMdaAudioToneUtility & )

IMPORT_C CAudioEqualizer *

NewL

(

CMdaAudioToneUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio tone utility

Returns: pointer to CAudioEqualizer object

NewL ( CMMFDevSound & )

IMPORT_C CAudioEqualizer *

NewL

(

CMMFDevSound &

aDevSound

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aDevSound	A reference to a DevSound instance

Returns: pointer to CAudioEqualizer object

NewL ( CCustomCommandUtility * )

IMPORT_C CAudioEqualizer *

NewL

(

CCustomCommandUtility *

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aUtility	A reference to a custom command utility

Returns: pointer to CAudioEqualizer object

NewL ( MCustomInterface & )

IMPORT_C CAudioEqualizer *

NewL

(

MCustomInterface &

aCustomInterface

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Parameter	Description
aCustomInterface	A reference to a custom interface

Returns: pointer to CAudioEqualizer object

NewL ( CMidiClientUtility & )

IMPORT_C CAudioEqualizer *

NewL

(

CMidiClientUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Returns: pointer to CAudioEqualizer object

NewL ( CDrmPlayerUtility & )

IMPORT_C CAudioEqualizer *

NewL

(

CDrmPlayerUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.0

Returns: pointer to CAudioEqualizer object

NewL ( CVideoPlayerUtility & )

IMPORT_C CAudioEqualizer *

NewL

(

CVideoPlayerUtility &

aUtility

)

[static]

Factory function for creating the audio equalizer object.

Since: 3.2

Returns: pointer to CAudioEqualizer object

NumberOfBands ( )

IMPORT_C TUint8

NumberOfBands

(

)

const

Get number of equalizer bands.

Since: 3.0

Returns: The number of equalizer bands.

SetBandDataL ( TInt, const TDesC8 & )

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

Unpack band data from the specified descriptor.

Since: 3.0

Parameter	Description
aNumberOfBands	Number of bands contained in the descriptor.
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

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

Returns: -

SetEffectData ( const TDesC8 & )

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

Reimplemented from CAudioEffect::SetEffectData(const TDesC8 &)

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameter	Description
aEffectDataBuffer	Descriptor containing packed effect data

Returns: -

Uid ( )

IMPORT_C TUid

Uid

(

)

const [virtual]

Reimplemented from CAudioEffect::Uid()const