Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]

Location: mmfdevsoundcustominterfacesupport.h

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class MAutoPauseResumeSupport

class MAutoPauseResumeSupport;

Description

Custom Interface providing support for AutoPauseResume Register, Cancel, GetResourceNotificationData and WillResumePlay.

Members

Defined in MAutoPauseResumeSupport:
CancelRegisterAsClient(), GetResourceNotificationData(), RegisterAsClient(), WillResumePlay()

Member functions

RegisterAsClient()

virtual TInt RegisterAsClient(TUid aEventType, const TDesC8 &aNotificationRegistrationData=KNullDesC8)=0;

Description

Registers the event for notification when resource is avaliable.

Parameters

TUid aEventType

The event which the client is notified of.
const TDesC8 &aNotificationRegistrationData

Notification registration specific data, which has been reserved for future use.

Return value

TInt

An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

CancelRegisterAsClient()

virtual TInt CancelRegisterAsClient(TUid aEventType)=0;

Description

Cancels the registered notification event.

Parameters

TUid aEventType

The event to notify the client.

Return value

TInt

An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

GetResourceNotificationData()

virtual TInt GetResourceNotificationData(TUid aEventType, TDes8 &aNotificationData)=0;

Description

Gets the notification data for the event.

Parameters

TUid aEventType

The event which the client is notified of.
TDes8 &aNotificationData

The notification data for the client to resume playing. The actual data depends on the event type. Note that for the event type 'KMMFEventCategoryAudioResourceAvailable' the package buffer returned is TMMFTimeIntervalMicroSecondsPckg, but the contents should be converted to an integer and interpreted as the data returned is samples played, but not as a microsecond value.

Return value

TInt

An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

WillResumePlay()

virtual TInt WillResumePlay()=0;

Description

Waits for the client to resume the play even after the default timer expires.

Return value

TInt

An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

[Previous] [Top] [Next]