Class RMMFResourceNotificationCustomCommands

class RMMFResourceNotificationCustomCommands : public RMMFCustomCommandsBase;

Description

Client class to allow the client to register notification .

The class uses the custom command function of the controller plugin, and removes the necessity for the client to formulate the custom commands.

Derivation

• RMMFCustomCommandsBase - Base class for client-side custom command classes.

• RMMFResourceNotificationCustomCommands - Client class to allow the client to register notification .

Members

Defined in RMMFResourceNotificationCustomCommands:

• CancelRegisterAsClient(TUid)Cancels the registered notification event.
• GetResourceNotificationData(TUid,TDes8 &)Gets the notification data for the event.
• RMMFResourceNotificationCustomCommands(RMMFController &)Constructor.
• RegisterAsClient(TUid,const TDesC8 &)Registers the Event for Notification when resource is avaliable.
• WillResumePlay()Waits for the client to resume the play even after the default timer expires.

Inherited from RMMFCustomCommandsBase:

• RMMFCustomCommandsBase(RMMFController &,TUid)Constructor.
• iControllerThe controller.
• iDestinationPckgThe destination package.

IMPORT_C RMMFResourceNotificationCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters

RMMFController &aController The client side controller object to be used by this custom command interface.

IMPORT_C TInt RegisterAsClient(TUid aEventType, const TDesC8 &aNotificationRegistrationData);

Description

Registers the Event for Notification when resource is avaliable.

Parameters

TUid aEventType The Event to notify the client. const TDesC8 &aNotificationRegistrationData Notification registration specific data.

Return value

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

IMPORT_C TInt CancelRegisterAsClient(TUid aEventType);

Description

Cancels the registered notification event.

Parameters

TUid aEventType The Event to notify the client.

Return value

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

IMPORT_C TInt GetResourceNotificationData(TUid aEventType, TDes8 &aNotificationData);

Description

Gets the notification data for the event.

Parameters

TUid aEventType The Event to notify the client. TDes8 &aNotificationData The Notification data for the client to resume the play.

Return value

TInt An error code indicating if the get notification data was successful. KErrNone on success, otherwise another of the system-wide error codes.

IMPORT_C TInt WillResumePlay();

Description

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

Return value

TInt An error code indicating if the registration was successful. KErrNone on success, otherwise any of the system-wide error codes.