1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/devsound/devsoundapi/inc/MmfDevSoundCustomInterfaceSupport.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,92 @@
     1.4 +
     1.5 +// MmfDevSoundCustomInterfaceSupport.h
     1.6 +
     1.7 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.8 +// All rights reserved.
     1.9 +// This component and the accompanying materials are made available
    1.10 +// under the terms of "Eclipse Public License v1.0"
    1.11 +// which accompanies this distribution, and is available
    1.12 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.13 +//
    1.14 +// Initial Contributors:
    1.15 +// Nokia Corporation - initial contribution.
    1.16 +//
    1.17 +// Contributors:
    1.18 +//
    1.19 +// Description:
    1.20 +//
    1.21 +
    1.22 +/**
    1.23 + @publishedAll
    1.24 + @released
    1.25 + @file
    1.26 +*/
    1.27 +
    1.28 +#ifndef MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H
    1.29 +#define MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H
    1.30 +
    1.31 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    1.32 +#include <mmf/server/mmfdevsoundcustominterfaceobserver.h>
    1.33 +#include <mmf/server/mmfdevsoundcustominterfacesupportclasses.h>
    1.34 +#endif
    1.35 +
    1.36 +/**
    1.37 +@publishedAll
    1.38 +@released
    1.39 +
    1.40 +Custom Interface providing support for AutoPauseResume Register, Cancel, GetResourceNotificationData and WillResumePlay.
    1.41 +*/
    1.42 +
    1.43 +class MAutoPauseResumeSupport
    1.44 +	{
    1.45 +public:
    1.46 +	/**
    1.47 +	Registers the event for notification when resource is avaliable.
    1.48 +
    1.49 +	@param aEventType
    1.50 +		The event which the client is notified of.
    1.51 +		
    1.52 +	@param aNotificationRegistrationData
    1.53 +		Notification registration specific data, which has been reserved for future use.
    1.54 +
    1.55 +	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
    1.56 +	        another of the system-wide error codes.
    1.57 +	*/
    1.58 +	virtual TInt RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData = KNullDesC8)=0;
    1.59 +	
    1.60 +	/**
    1.61 +	Cancels the registered notification event.
    1.62 +
    1.63 +	@param  aEventType
    1.64 +		The event to notify the client.
    1.65 +
    1.66 +	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
    1.67 +	        another of the system-wide error codes.
    1.68 +	*/
    1.69 +	virtual TInt CancelRegisterAsClient(TUid aEventType)=0;
    1.70 +	/**
    1.71 +	Gets the notification data for the event.
    1.72 +	
    1.73 +	@param  aEventType
    1.74 +		The event which the client is notified of.
    1.75 +		
    1.76 +	@param aNotificationData
    1.77 +		The notification data for the client to resume playing. The actual data depends on the event type.
    1.78 +		Note that for the event type 'KMMFEventCategoryAudioResourceAvailable' the package buffer returned
    1.79 +		is TMMFTimeIntervalMicroSecondsPckg, but the contents should be converted to an integer and
    1.80 +		interpreted as the data returned is samples played, but not as a microsecond value.
    1.81 +
    1.82 +	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
    1.83 +	        another of the system-wide error codes.
    1.84 +	*/
    1.85 +	virtual TInt GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData)=0;
    1.86 +	/**
    1.87 +	Waits for the client to resume the play even after the default timer expires.
    1.88 +
    1.89 +	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
    1.90 +	        another of the system-wide error codes.
    1.91 +	*/
    1.92 +	virtual TInt WillResumePlay()=0;
    1.93 +	};
    1.94 +
    1.95 +#endif // MMFDEVSOUNDCUSTOMINTERFACESUPPORT_H