CAudioEffect Class Reference

#include <AudioEffectBase.h>

Link against: AudioEffectBase.lib

class CAudioEffect : public CBase

Inherits from

  • CAudioEffect
    Protected Attributes
    TBool iEnabled
    TBool iEnforced
    TBool iHaveUpdateRights
    RPointerArray< MAudioEffectObserver >iObservers
    Public Member Functions
    virtual ~CAudioEffect()
    pure virtual voidApplyL()
    virtual IMPORT_C voidDisableL()
    virtual IMPORT_C voidEnableL()
    virtual IMPORT_C voidEnforceL(TBool)
    virtual IMPORT_C TBoolHaveUpdateRights()
    virtual IMPORT_C TBoolIsEnabled()
    virtual IMPORT_C TBoolIsEnforced()
    IMPORT_C voidRegisterObserverL(MAudioEffectObserver &)
    pure virtual TUid Uid()
    IMPORT_C voidUnRegisterObserver(MAudioEffectObserver &)
    Protected Member Functions
    CAudioEffect()
    pure virtual const TDesC8 &DoEffectData()
    pure virtual voidSetEffectData(const TDesC8 &)
    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 base class for audio effects.

    Since
    3.0

    Member Attribute Documentation

    iEnabled

    TBool iEnabled[protected]

    iEnforced

    TBool iEnforced[protected]

    iHaveUpdateRights

    TBool iHaveUpdateRights[protected]

    iObservers

    RPointerArray< MAudioEffectObserver >iObservers[protected]

    Constructor & Destructor Documentation

    CAudioEffect ( )

    IMPORT_CCAudioEffect()[protected]
    Private C++ constructor for this class.
    Since
    3.0

    Returns: -

    ~CAudioEffect ( )

    IMPORT_C~CAudioEffect()[virtual]

    Destructor

    Member Function Documentation

    ApplyL ( )

    voidApplyL()[pure virtual]
    Apply effect settings
    Since
    3.0

    DisableL ( )

    IMPORT_C voidDisableL()[virtual]
    Disable the effect
    Since
    3.0

    DoEffectData ( )

    const TDesC8 &DoEffectData()[protected, pure virtual]
    Internal function to package data into a descriptor.
    Since
    3.0

    Returns: A descriptor containing the effect data.

    EnableL ( )

    IMPORT_C voidEnableL()[virtual]
    Enable the effect
    Since
    3.0

    EnforceL ( TBool )

    IMPORT_C voidEnforceL(TBoolaEnforced)[virtual]
    Enforce the effect.
    Since
    3.0
    ParameterDescription
    aEnforcedIndicate the effect is to be enforced or not. ETrue = Enforced.

    HaveUpdateRights ( )

    IMPORT_C TBoolHaveUpdateRights()const [virtual]
    Check if this effect object currently has update rights. A client can lose update rights in some hardware platforms where there are a limited number of instances of an effect that can exist at the same time. When an effect instance has lost update rights the user can still change settings, but any calls to Apply the settings will be deferred until update rights are regained.
    Since
    3.0

    Returns: ETrue if this object currently has rights to update the settings of this effect, EFalse otherwise.

    IsEnabled ( )

    IMPORT_C TBoolIsEnabled()const [virtual]
    Check if the effect is enabled
    Since
    3.0

    Returns: ETrue if the effect is enabled, EFalse if the effect is disabled.

    IsEnforced ( )

    IMPORT_C TBoolIsEnforced()const [virtual]
    Check if the effect is enforced.
    Since
    3.0

    Returns: ETrue if the effect is enforced, EFalse if the effect isn ot enforced.

    RegisterObserverL ( MAudioEffectObserver & )

    IMPORT_C voidRegisterObserverL(MAudioEffectObserver &aObserver)
    Adds the specified observer to the list of observers to be notified when the effect object changes state.
    Since
    3.0
    ParameterDescription
    aObserverObject to be added to notifier list.

    SetEffectData ( const TDesC8 & )

    voidSetEffectData(const TDesC8 &aEffectDataBuffer)[protected, pure virtual]
    Internal function to unpack effect data
    Since
    3.0
    ParameterDescription
    aEffectDataBufferDescriptor containing packed effect data

    Uid ( )

    TUid Uid()const [pure virtual]

    UnRegisterObserver ( MAudioEffectObserver & )

    IMPORT_C voidUnRegisterObserver(MAudioEffectObserver &aObserver)
    Removes the specified observer from the list of observers.
    Since
    3.0
    ParameterDescription
    aObserverobject to be removed.
    © Nokia 2011.