CAudioEqualizerUtility Class Reference

API published in: S60 3rd Ed

Link against: audioequalizerutility.lib

Capability Information

Required Capabilities

None

#include <audioequalizerutility.h>

Detailed Description

This is the Equalizer Utility class for managing audio equalizer presets.


Public Member Functions
virtual	~CAudioEqualizerUtility ()
	Destructor.
IMPORT_C void	ApplyPresetL (TInt aPreset)
	Apply the Preset Index value.
IMPORT_C void	DisableEqualizerL ()
	Disable the Equalizer.
IMPORT_C void	CreatePresetL (TDesC &aName, CAudioEqualizer &aAudioEqualizerUI)
	Create a Preset with the given Name and Equalizer Settings.
IMPORT_C void	DeletePresetL (TInt aPresetIndex)
	Delete a Preset with the given index in the Central Repository.
IMPORT_C const TDesC &	GetPresetL (TInt aPresetIndex)
	Retrieves a Preset with the given index from the Central Repository.
IMPORT_C CAudioEqualizer &	Equalizer ()
	Get the reference to the Equalizer Object.
IMPORT_C CBassBoost &	BassBoost ()
	Get the reference to the BassBoost Object.
IMPORT_C void	ModifyPresetL (TInt aPresetIndex, TDesC &aName, CAudioEqualizer &aAudioEqualizerUI)
	Modify a Preset with the given Name and Equalizer Settings.
IMPORT_C TUint32	NumberOfPreDefinedPresets () const
	Get the number of Pre Defined Presets.
IMPORT_C TArray< TEfAudioEqualizerUtilityPreset >	Presets ()
	Get all the Presets defined in the Central Repository.
IMPORT_C void	ResetPresetL (TInt aPresetIndex)
	Reset a System Defined Preset with the given index in the Array returned from Presets().
Static Public Member Functions
static IMPORT_C CAudioEqualizerUtility *	NewL (CMMFDevSound &aDevSound)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CMdaAudioConvertUtility &aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CMdaAudioInputStream &aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CMdaAudioOutputStream &aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CMdaAudioPlayerUtility &aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CMdaAudioRecorderUtility &aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CMdaAudioToneUtility &aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CCustomCommandUtility *aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (MCustomInterface &aCustomInterface)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CMidiClientUtility &aUtility)
	Factory function for creating the audio equalizer utility object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CDrmPlayerUtility &aUtility)
	Factory function for creating the audio equalizer object.
static IMPORT_C CAudioEqualizerUtility *	NewL (CVideoPlayerUtility &aUtility)
	Factory function for creating the audio equalizer object.

Constructor & Destructor Documentation

virtual CAudioEqualizerUtility::~CAudioEqualizerUtility ( ) [virtual]

Destructor.

Member Function Documentation

IMPORT_C void CAudioEqualizerUtility::ApplyPresetL

Apply the Preset Index value.

Parameters:

aPreset

Preset Value

IMPORT_C CBassBoost& CAudioEqualizerUtility::BassBoost

(

)

Get the reference to the BassBoost Object.

Returns:: Reference to the CBassBoost Object.

IMPORT_C void CAudioEqualizerUtility::CreatePresetL	(	TDesC &	aName,
		CAudioEqualizer &	aAudioEqualizerUI
	)

Create a Preset with the given Name and Equalizer Settings.

Parameters:

	aName	Name of the Preset
	aAudioEqualizer	Equalizer Settings for the Preset

IMPORT_C void CAudioEqualizerUtility::DeletePresetL

Delete a Preset with the given index in the Central Repository.

Parameters:

aPresetIndex

Index of the Preset in the Array

IMPORT_C void CAudioEqualizerUtility::DisableEqualizerL

(

)

Disable the Equalizer.

IMPORT_C CAudioEqualizer& CAudioEqualizerUtility::Equalizer

(

)

Get the reference to the Equalizer Object.

Returns:: Reference to the Equalizer Object.

IMPORT_C const TDesC& CAudioEqualizerUtility::GetPresetL

Retrieves a Preset with the given index from the Central Repository.

Parameters:

aPresetIndex

Index of the Preset in the Array

IMPORT_C void CAudioEqualizerUtility::ModifyPresetL	(	TInt	aPresetIndex,
		TDesC &	aName,
		CAudioEqualizer &	aAudioEqualizerUI
	)

Modify a Preset with the given Name and Equalizer Settings.

Parameters:

	aPresetIndex	Array Index of the Preset
	aName	Name of the Preset
	aAudioEqualizer	Equalizer Settings for the Preset

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

Factory function for creating the audio equalizer object.

Parameters:

CVideoPlayerUtility

A reference to a CVideoPlayerUtility object

Returns:: pointer to CAudioEqualizer object

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

Factory function for creating the audio equalizer object.

Parameters:

CDrmPlayerUtility

A reference to a CDrmPlayerUtility object

Returns:: pointer to CAudioEqualizer object

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