CAudioEqualizerUtility Class Reference

#include <AudioEqualizerUtility.h>

Link against: AudioEqualizerUtility.lib

class CAudioEqualizerUtility : public CBase

Inherits from

  • CAudioEqualizerUtility
    Public Member Functions
    virtual ~CAudioEqualizerUtility()
    IMPORT_C voidApplyPresetL(TInt)
    IMPORT_C CBassBoost &BassBoost()
    IMPORT_C voidCreatePresetL(TDesC &, CAudioEqualizer &)
    IMPORT_C voidDeletePresetL(TInt)
    IMPORT_C voidDisableEqualizerL()
    IMPORT_C CAudioEqualizer &Equalizer()
    IMPORT_C const TDesC &GetPresetL(TInt)
    IMPORT_C voidModifyPresetL(TInt, TDesC &, CAudioEqualizer &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMMFDevSound &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioConvertUtility &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioInputStream &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioOutputStream &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioPlayerUtility &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioRecorderUtility &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioToneUtility &)
    IMPORT_C CAudioEqualizerUtility *NewL(CCustomCommandUtility *)
    IMPORT_C CAudioEqualizerUtility *NewL(MCustomInterface &)
    IMPORT_C CAudioEqualizerUtility *NewL(CMidiClientUtility &)
    IMPORT_C CAudioEqualizerUtility *NewL(CDrmPlayerUtility &)
    IMPORT_C CAudioEqualizerUtility *NewL(CVideoPlayerUtility &)
    IMPORT_C TUint32NumberOfPreDefinedPresets()
    IMPORT_C TArray< TEfAudioEqualizerUtilityPreset >Presets()
    IMPORT_C voidResetPresetL(TInt)
    Inherited Functions
    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 Utility class for managing audio equalizer presets.

    Since
    3.0

    Constructor & Destructor Documentation

    ~CAudioEqualizerUtility ( )

    ~CAudioEqualizerUtility()[virtual]

    Destructor.

    Member Function Documentation

    ApplyPresetL ( TInt )

    IMPORT_C voidApplyPresetL(TIntaPreset)
    Apply the Preset Index value
    Since
    3.0
    ParameterDescription
    aPresetPreset Value

    BassBoost ( )

    IMPORT_C CBassBoost &BassBoost()
    Get the reference to the BassBoost Object
    Since
    3.0

    Returns: Reference to the CBassBoost Object.

    CreatePresetL ( TDesC &, CAudioEqualizer & )

    IMPORT_C voidCreatePresetL(TDesC &aName,
    CAudioEqualizer &aAudioEqualizerUI
    )
    Create a Preset with the given Name and Equalizer Settings
    Since
    3.0
    ParameterDescription
    aNameName of the Preset

    DeletePresetL ( TInt )

    IMPORT_C voidDeletePresetL(TIntaPresetIndex)
    Delete a Preset with the given index in the Central Repository
    Since
    3.0
    ParameterDescription
    aPresetIndexIndex of the Preset in the Array

    DisableEqualizerL ( )

    IMPORT_C voidDisableEqualizerL()
    Disable the Equalizer
    Since
    3.0

    Equalizer ( )

    IMPORT_C CAudioEqualizer &Equalizer()
    Get the reference to the Equalizer Object
    Since
    3.0

    Returns: Reference to the Equalizer Object.

    GetPresetL ( TInt )

    IMPORT_C const TDesC &GetPresetL(TIntaPresetIndex)
    Retrieves a Preset with the given index from the Central Repository
    Since
    3.0
    ParameterDescription
    aPresetIndexIndex of the Preset in the Array

    ModifyPresetL ( TInt, TDesC &, CAudioEqualizer & )

    IMPORT_C voidModifyPresetL(TIntaPresetIndex,
    TDesC &aName,
    CAudioEqualizer &aAudioEqualizerUI
    )
    Modify a Preset with the given Name and Equalizer Settings
    Since
    3.0
    ParameterDescription
    aPresetIndexArray Index of the Preset
    aNameName of the Preset

    NewL ( CMMFDevSound & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMMFDevSound &aDevSound)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CMdaAudioConvertUtility & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioConvertUtility &aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to a convert utility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CMdaAudioInputStream & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioInputStream &aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to a audio input stream utility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CMdaAudioOutputStream & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioOutputStream &aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to a audio output stream utility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CMdaAudioPlayerUtility & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioPlayerUtility &aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to a audio player utility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CMdaAudioRecorderUtility & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioRecorderUtility &aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to a audio recorder utility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CMdaAudioToneUtility & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMdaAudioToneUtility &aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to a audio tone utility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CCustomCommandUtility * )

    IMPORT_C CAudioEqualizerUtility *NewL(CCustomCommandUtility *aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to custom command utility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( MCustomInterface & )

    IMPORT_C CAudioEqualizerUtility *NewL(MCustomInterface &aCustomInterface)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CMidiClientUtility & )

    IMPORT_C CAudioEqualizerUtility *NewL(CMidiClientUtility &aUtility)[static]
    Factory function for creating the audio equalizer utility object.
    Since
    3.0
    ParameterDescription
    aUtilityA reference to CMidiClientUtility

    Returns: pointer to CAudioEqualizerUtility object

    NewL ( CDrmPlayerUtility & )

    IMPORT_C CAudioEqualizerUtility *NewL(CDrmPlayerUtility &aUtility)[static]
    Factory function for creating the audio equalizer object.
    Since
    3.0

    Returns: pointer to CAudioEqualizer object

    NewL ( CVideoPlayerUtility & )

    IMPORT_C CAudioEqualizerUtility *NewL(CVideoPlayerUtility &aUtility)[static]
    Factory function for creating the audio equalizer object.
    Since
    3.2

    Returns: pointer to CAudioEqualizer object

    NumberOfPreDefinedPresets ( )

    IMPORT_C TUint32NumberOfPreDefinedPresets()const
    Get the number of Pre Defined Presets
    Since
    3.0

    Returns: Number of Pre Defined Presets

    Presets ( )

    IMPORT_C TArray< TEfAudioEqualizerUtilityPreset >Presets()
    Get all the Presets defined in the Central Repository
    Since
    3.0

    Returns: Array of all Presets.

    ResetPresetL ( TInt )

    IMPORT_C voidResetPresetL(TIntaPresetIndex)
    Reset a System Defined Preset with the given index in the Array returned from Presets()
    Since
    3.0
    ParameterDescription
    aPresetIndexIndex of the Preset in the Array
    © Nokia 2011.