epoc32/include/mw/absolutevolumeapicontrollerobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file
    20  @publishedAll
    21  @released
    22 */
    23 
    24 
    25 #ifndef REMCONABSOLUTEVOLUMEAPICONTROLLEROBSERVER_H_
    26 #define REMCONABSOLUTEVOLUMEAPICONTROLLEROBSERVER_H_
    27 
    28 #include <e32base.h>
    29 
    30 /**
    31 Clients must implement this interface in order to instantiate objects of type 
    32 CRemConAbsoluteVolumeController. This interface passes incoming responses 
    33 from RemCon to the client.
    34 */
    35 class MRemConAbsoluteVolumeControllerObserver
    36 	{
    37 public:
    38 	/** 
    39 	The current volume has been received.
    40 	 
    41 	@param aVolume The current relative volume on the target device.
    42 	@param aMaxVolume The maximum volume against which aVolume is relative.
    43 	@param aError The response error.
    44 	*/
    45 	virtual void MrcavcoCurrentVolume(TUint32 aVolume, 
    46 			TUint32 aMaxVolume, 
    47 			TInt aError)=0;
    48 
    49 	/**
    50 	The response for setting absolute volume.
    51 	
    52 	@param aVolume The relative volume that has been set on the target device.
    53 	@param aMaxVolume The maximum volume against which aVolume is relative.
    54 	@param aError The response error.
    55 	*/
    56 	virtual void MrcavcoSetAbsoluteVolumeResponse(TUint32 aVolume, 
    57 			TUint32 aMaxVolume, 
    58 			TInt aError)=0;
    59 	
    60 	/**
    61 	The error occurs for absolute volume notification. 
    62 	
    63 	When this is called, the client must call
    64 	RegisterAbsoluteVolumeNotification() to register again if the client 
    65 	wants to receive the notification.
    66 	*/
    67 	virtual void MrcavcoAbsoluteVolumeNotificationError() = 0;
    68 
    69 	};
    70 
    71 #endif /*REMCONABSOLUTEVOLUMEAPICONTROLLEROBSERVER_H_*/