S60 3rd Edition API Reference: CAudioEffect Class Reference CAudioEffect Class Reference API published in: S60 3rd Ed
Link against: effectbase.lib
#include <audioeffectbase.h >
Inherited by CAudioEqualizer , CBassBoost , CDistanceAttenuation , CDoppler , CEnvironmentalReverb , CLocation , CLoudness , COrientation , and CStereoWidening .
Detailed Description
This is the base class for audio effects.
Public Member Functions virtual IMPORT_C ~CAudioEffect () Destructor. virtual void ApplyL ()=0 Apply effect settings. virtual IMPORT_C void DisableL () Disable the effect. virtual IMPORT_C void EnableL () Enable the effect. virtual IMPORT_C void EnforceL (TBool aEnforced) Enforce the effect. virtual IMPORT_C TBool HaveUpdateRights () const Check if this effect object currently has update rights. virtual IMPORT_C TBool IsEnabled () const Check if the effect is enabled. virtual IMPORT_C TBool IsEnforced () const Check if the effect is enforced. IMPORT_C void RegisterObserverL (MAudioEffectObserver &aObserver) Adds the specified observer to the list of observers to be notified when the effect object changes state. virtual TUid Uid () const =0IMPORT_C void UnRegisterObserver (MAudioEffectObserver &aObserver) Removes the specified observer from the list of observers. Protected Member Functions IMPORT_C CAudioEffect () Private C++ constructor for this class. virtual const TDesC8 & DoEffectData ()=0 Internal function to package data into a descriptor. virtual void SetEffectData (const TDesC8 &aEffectDataBuffer)=0 Internal function to unpack effect data. Protected Attributes TBool iEnabled TBool iEnforced TBool iHaveUpdateRights RPointerArray< MAudioEffectObserver > iObservers
Constructor & Destructor Documentation
virtual IMPORT_C CAudioEffect::~CAudioEffect ( ) [virtual]
IMPORT_C CAudioEffect::CAudioEffect ( ) [protected]
Private C++ constructor for this class.
Parameters:
aEffectObserver reference to event observer object
Returns: -
Member Function Documentation
virtual void CAudioEffect::ApplyL ( ) [pure virtual]
virtual IMPORT_C void CAudioEffect::DisableL ( ) [virtual]
virtual const TDesC8& CAudioEffect::DoEffectData ( ) [protected, pure virtual]
virtual IMPORT_C void CAudioEffect::EnableL ( ) [virtual]
virtual IMPORT_C void CAudioEffect::EnforceL ( TBool aEnforced ) [virtual]
Enforce the effect.
Parameters:
aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.
virtual IMPORT_C TBool CAudioEffect::HaveUpdateRights ( ) 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.
Returns: ETrue if this object currently has rights to update the settings of this effect, EFalse otherwise.
virtual IMPORT_C TBool CAudioEffect::IsEnabled ( ) const [virtual]
Check if the effect is enabled.
Returns: ETrue if the effect is enabled, EFalse if the effect is disabled.
virtual IMPORT_C TBool CAudioEffect::IsEnforced ( ) const [virtual]
Check if the effect is enforced.
Returns: ETrue if the effect is enforced, EFalse if the effect isn ot enforced.
Adds the specified observer to the list of observers to be notified when the effect object changes state.
Parameters:
aObserver Object to be added to notifier list.
virtual void CAudioEffect::SetEffectData ( const TDesC8 & aEffectDataBuffer ) [protected, pure virtual]
virtual TUid CAudioEffect::Uid ( ) const [pure virtual]
Implemented in CAudioEqualizer , CBassBoost , CDistanceAttenuation , CEnvironmentalReverb , CListenerDoppler , CListenerLocation , CListenerOrientation , CLoudness , CSourceDoppler , CSourceLocation , CSourceOrientation , and CStereoWidening .
Removes the specified observer from the list of observers.
Parameters:
aObserver object to be removed.
Field Documentation
