Symbian^3 Product Developer Library >

CATAudioEventAPI Class Reference

class CATAudioEventAPI : public CBase

Implements client side API for Audio Theme sound server.

ATSoundServerClient.lib
Since
Series 60 release 3.0

Inherits from

Public Member Functions
~CATAudioEventAPI()
voidMessageComplete(TInt, CATMessageHelper *)
IMPORT_C CATAudioEventAPI *NewL(MATEventCompleteObserver &)
IMPORT_C CATAudioEventAPI *NewLC(MATEventCompleteObserver &)
voidSendAudioEventL(TAudioThemeEvent, TBool)
voidStopAudio(TAudioThemeEvent)
Private Member Functions
CATAudioEventAPI(MATEventCompleteObserver &)
voidConstructL()
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()
Private Attributes
MATEventCompleteObserver &iClient
RPointerArray< CATMessageHelper >iMessageHelperArray
RATSoundServerSession *iSession

Constructor & Destructor Documentation

CATAudioEventAPI(MATEventCompleteObserver &)

CATAudioEventAPI(MATEventCompleteObserver &aClient)[private]
C++ default constructor.
Since
3.0

Parameters

MATEventCompleteObserver & aClientreference to client object

~CATAudioEventAPI()

~CATAudioEventAPI()

Destructor

Member Functions Documentation

ConstructL()

voidConstructL()[private]

Symbian 2nd phase constructor.

MessageComplete(TInt, CATMessageHelper *)

voidMessageComplete(TIntaError,
CATMessageHelper *aHelper
)
This methods is called by message helper when sent messages completes. Client will be called for completion in this method as well.
Since
3.0

Parameters

TInt aErrorerror code
CATMessageHelper * aHelpermessagehelper that received completion from the server.

NewL(MATEventCompleteObserver &)

IMPORT_C CATAudioEventAPI *NewL(MATEventCompleteObserver &aClient)[static]
Two-phased constructor.
Since
3.0

Parameters

MATEventCompleteObserver & aClientreference to client object

NewLC(MATEventCompleteObserver &)

IMPORT_C CATAudioEventAPI *NewLC(MATEventCompleteObserver &aClient)[static]
Two-phased constructor. Leaves pointer to object to cleanup stack.
Since
3.0

Parameters

MATEventCompleteObserver & aClientreference to client object

SendAudioEventL(TAudioThemeEvent, TBool)

voidSendAudioEventL(TAudioThemeEventaEvent,
TBoolaDemoPlay
)[virtual]
Send event to the server. UI Settings uses demoplay as true, so that server will play "profile" events as well.
Since
3.0

Parameters

TAudioThemeEvent aEventevent number aDemoPlay ETrue if called from UI settings application, EFalse from observer and keysoundserver
TBool aDemoPlay

StopAudio(TAudioThemeEvent)

voidStopAudio(TAudioThemeEventaEvent)[virtual]
Stop playing of earlier sent playing request.
Since
3.0

Parameters

TAudioThemeEvent aEventevent number

Member Data Documentation

MATEventCompleteObserver & iClient

MATEventCompleteObserver &iClient[private]

RPointerArray< CATMessageHelper > iMessageHelperArray

RPointerArray< CATMessageHelper >iMessageHelperArray[private]

RATSoundServerSession * iSession

RATSoundServerSession *iSession[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.