MAutoPauseResumeSupport Class Reference

#include <mmf/server/mmfdevsoundcustominterfacesupport.h>

class MAutoPauseResumeSupport
Public Member Functions
pure virtual TInt CancelRegisterAsClient(TUid)
pure virtual TInt GetResourceNotificationData(TUid, TDes8 &)
pure virtual TInt RegisterAsClient(TUid, const TDesC8 &)
pure virtual TInt WillResumePlay()

Detailed Description

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

Member Function Documentation

CancelRegisterAsClient ( TUid )

TInt CancelRegisterAsClient(TUidaEventType)[pure virtual]

Cancels the registered notification event.

ParameterDescription
aEventTypeThe event to notify the client.

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

GetResourceNotificationData ( TUid, TDes8 & )

TInt GetResourceNotificationData(TUidaEventType,
TDes8 &aNotificationData
)[pure virtual]

Gets the notification data for the event.

ParameterDescription
aEventTypeThe event which the client is notified of.
aNotificationDataThe 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.

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

RegisterAsClient ( TUid, const TDesC8 & )

TInt RegisterAsClient(TUidaEventType,
const TDesC8 &aNotificationRegistrationData =  KNullDesC8
)[pure virtual]

Registers the event for notification when resource is avaliable.

ParameterDescription
aEventTypeThe event which the client is notified of.
aNotificationRegistrationDataNotification registration specific data, which has been reserved for future use.

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

WillResumePlay ( )

TInt WillResumePlay()[pure virtual]

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

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