S60 3rd Edition API Reference: CAudioEqualizerUtility Class Reference

CAudioEqualizerUtility Class Reference

API published in: S60 3rd Ed

Link against: audioequalizerutility.lib

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

Constructor & Destructor Documentation

virtual CAudioEqualizerUtility::~CAudioEqualizerUtility (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C void CAudioEqualizerUtility::ApplyPresetL ( TInt  aPreset  ) 
 

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

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

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 ( CMidiClientUtility &  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Public since 3rd Ed FP1

Parameters:
aUtility A reference to CMidiClientUtility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( MCustomInterface &  aCustomInterface  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to custom interface utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CCustomCommandUtility *  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to custom command utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CMdaAudioToneUtility &  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to a audio tone utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CMdaAudioRecorderUtility &  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to a audio recorder utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CMdaAudioPlayerUtility &  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to a audio player utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CMdaAudioOutputStream &  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to a audio output stream utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CMdaAudioInputStream &  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to a audio input stream utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CMdaAudioConvertUtility &  aUtility  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to a convert utility
Returns:
pointer to CAudioEqualizerUtility object
static IMPORT_C CAudioEqualizerUtility* CAudioEqualizerUtility::NewL ( CMMFDevSound &  aDevSound  )  [static]
 

Factory function for creating the audio equalizer utility object.

Parameters:
aUtility A reference to a Devsound Instance
Returns:
pointer to CAudioEqualizerUtility object
IMPORT_C TUint32 CAudioEqualizerUtility::NumberOfPreDefinedPresets (   )  const
 

Get the number of Pre Defined Presets.

Returns:
Number of Pre Defined Presets
IMPORT_C TArray<TEfAudioEqualizerUtilityPreset> CAudioEqualizerUtility::Presets (   ) 
 

Get all the Presets defined in the Central Repository.

Returns:
Array of all Presets.
IMPORT_C void CAudioEqualizerUtility::ResetPresetL ( TInt  aPresetIndex  ) 
 

Reset a System Defined Preset with the given index in the Array returned from Presets().

Parameters:
aPresetIndex Index of the Preset in the Array
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top