sl@0: 
sl@0: // MmfDevSoundCustomInterfaceSupport.h
sl@0: 
sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @publishedAll
sl@0:  @released
sl@0:  @file
sl@0: */
sl@0: 
sl@0: #ifndef MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H
sl@0: #define MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H
sl@0: 
sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <mmf/server/mmfdevsoundcustominterfaceobserver.h>
sl@0: #include <mmf/server/mmfdevsoundcustominterfacesupportclasses.h>
sl@0: #endif
sl@0: 
sl@0: /**
sl@0: @publishedAll
sl@0: @released
sl@0: 
sl@0: Custom Interface providing support for AutoPauseResume Register, Cancel, GetResourceNotificationData and WillResumePlay.
sl@0: */
sl@0: 
sl@0: class MAutoPauseResumeSupport
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 	Registers the event for notification when resource is avaliable.
sl@0: 
sl@0: 	@param aEventType
sl@0: 		The event which the client is notified of.
sl@0: 		
sl@0: 	@param aNotificationRegistrationData
sl@0: 		Notification registration specific data, which has been reserved for future use.
sl@0: 
sl@0: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
sl@0: 	        another of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual TInt RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData = KNullDesC8)=0;
sl@0: 	
sl@0: 	/**
sl@0: 	Cancels the registered notification event.
sl@0: 
sl@0: 	@param  aEventType
sl@0: 		The event to notify the client.
sl@0: 
sl@0: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
sl@0: 	        another of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual TInt CancelRegisterAsClient(TUid aEventType)=0;
sl@0: 	/**
sl@0: 	Gets the notification data for the event.
sl@0: 	
sl@0: 	@param  aEventType
sl@0: 		The event which the client is notified of.
sl@0: 		
sl@0: 	@param aNotificationData
sl@0: 		The notification data for the client to resume playing. The actual data depends on the event type.
sl@0: 		Note that for the event type 'KMMFEventCategoryAudioResourceAvailable' the package buffer returned
sl@0: 		is TMMFTimeIntervalMicroSecondsPckg, but the contents should be converted to an integer and
sl@0: 		interpreted as the data returned is samples played, but not as a microsecond value.
sl@0: 
sl@0: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
sl@0: 	        another of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual TInt GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData)=0;
sl@0: 	/**
sl@0: 	Waits for the client to resume the play even after the default timer expires.
sl@0: 
sl@0: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
sl@0: 	        another of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual TInt WillResumePlay()=0;
sl@0: 	};
sl@0: 
sl@0: #endif // MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H