Collapse all Symbian^3 Product Developer Library

CAudioEffect Class Reference

class CAudioEffect : public CBase

This is the base class for audio effects.

AudioEffectBase.lib

Since: 3.0

Inherits from

CAudioEffect
- CBase

Public Member Functions
	~CAudioEffect()
void	ApplyL()
IMPORT_C void	DisableL()
IMPORT_C void	EnableL()
IMPORT_C void	EnforceL(TBool)
IMPORT_C TBool	HaveUpdateRights()
IMPORT_C TBool	IsEnabled()
IMPORT_C TBool	IsEnforced()
IMPORT_C void	RegisterObserverL(MAudioEffectObserver &)
TUid	Uid()
IMPORT_C void	UnRegisterObserver(MAudioEffectObserver &)

Protected Member Functions
	CAudioEffect()
const TDesC8 &	DoEffectData()
void	SetEffectData(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()

Protected Attributes
TBool	iEnabled
TBool	iEnforced
TBool	iHaveUpdateRights
RPointerArray< MAudioEffectObserver >	iObservers

Constructor & Destructor Documentation

CAudioEffect()

IMPORT_C

CAudioEffect

(

)

[protected]

Private C++ constructor for this class.

Since: 3.0

~CAudioEffect()

IMPORT_C

~CAudioEffect

(

)

[virtual]

Destructor

Member Functions Documentation

ApplyL()

void

ApplyL

(

)

[pure virtual]

Apply effect settings

Since: 3.0

DisableL()

IMPORT_C void

DisableL

(

)

[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

EnableL()

IMPORT_C void

EnableL

(

)

[virtual]

Enable the effect

Since: 3.0

EnforceL(TBool)

IMPORT_C void

EnforceL

(

TBool

aEnforced

)

[virtual]

Enforce the effect.

Since: 3.0

Parameters

TBool aEnforced

Indicate the effect is to be enforced or not. ETrue = Enforced.

HaveUpdateRights()

IMPORT_C TBool

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.

Since: 3.0

IsEnabled()

IMPORT_C TBool

IsEnabled

(

)

const [virtual]

Check if the effect is enabled

Since: 3.0

IsEnforced()

IMPORT_C TBool

IsEnforced

(

)

const [virtual]

Check if the effect is enforced.

Since: 3.0

RegisterObserverL(MAudioEffectObserver &)

IMPORT_C void

RegisterObserverL

(

MAudioEffectObserver &

aObserver

)

Adds the specified observer to the list of observers to be notified when the effect object changes state.

Since: 3.0

Parameters

MAudioEffectObserver & aObserver

Object to be added to notifier list.

SetEffectData(const TDesC8 &)

void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, pure virtual]

Internal function to unpack effect data

Since: 3.0

Parameters

const TDesC8 & aEffectDataBuffer

Descriptor containing packed effect data

Uid()

TUid

Uid

(

)

const [pure virtual]

UnRegisterObserver(MAudioEffectObserver &)

IMPORT_C void

UnRegisterObserver

(

MAudioEffectObserver &

aObserver

)

Removes the specified observer from the list of observers.

Since: 3.0

Parameters

MAudioEffectObserver & aObserver

object to be removed.

Member Data Documentation

TBool iEnabled

TBool

iEnabled

[protected]

TBool iEnforced

TBool

iEnforced

[protected]

TBool iHaveUpdateRights

TBool

iHaveUpdateRights

[protected]

RPointerArray< MAudioEffectObserver > iObservers

RPointerArray< MAudioEffectObserver >

iObservers

[protected]