vtprotocolsstub/inc/caudioconfighandler.h
changeset 0 ed9695c8bcbe
equal deleted inserted replaced
-1:000000000000 0:ed9695c8bcbe
       
     1 /*
       
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Audio configuration interface
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef CAUDIOCONFIGHANDLER_H
       
    19 #define CAUDIOCONFIGHANDLER_H
       
    20 NONSHARABLE_CLASS( TAudioConfigHandler )
       
    21     {
       
    22     public:
       
    23         /**
       
    24          * Constructor.
       
    25          */
       
    26         TAudioConfigHandler( MVtProtocolHandler* aProtocolHandler);
       
    27     private:
       
    28         MVtProtocolHandler* iProtocolHandler;
       
    29     };
       
    30     
       
    31 NONSHARABLE_CLASS( CAudioConfigCommand ) : public CBase,
       
    32                             public MVtAudioConfigCommand
       
    33     {
       
    34     public:
       
    35         
       
    36         /**
       
    37          * Constructor.
       
    38          */
       
    39         CAudioConfigCommand();
       
    40         
       
    41         /**
       
    42          * Destructor.
       
    43          */
       
    44         ~CAudioConfigCommand();
       
    45 
       
    46         /**
       
    47          * Method to set the playback volume to the specified value.
       
    48          *
       
    49          * This is a pure virtual function that each derived class must implement.
       
    50          * It is also an asynchronous function which will be answered with a callback.
       
    51          * 
       
    52          * @param aNewVolume
       
    53          *        An input parameter to hold the value for the requested playback volume.  
       
    54          *
       
    55          * @returns   TInt
       
    56          *            Returns a command ID that can be used to identify a command completion result with corresponding request.
       
    57          */
       
    58         virtual TInt SetAudioVolumeL(TInt aVolume);
       
    59 
       
    60         /**
       
    61          * Method to get the maximum valid value for the playback volume.
       
    62          *
       
    63          * This is a pure virtual function that each derived class must implement.
       
    64          * It is also an asynchronous function which will be answered with a callback.
       
    65          * 
       
    66          * @param aMaxVolume
       
    67          *        An output parameter to hold the value for the maximum valid playback volume.  
       
    68          *            Note that the parameter should not be used until the callback indicates that the 
       
    69          *            method has completed.
       
    70          *
       
    71          * @returns   TInt
       
    72          *            Returns a command ID that can be used to identify a command completion result with corresponding request.
       
    73          */
       
    74         virtual TInt GetMaxAudioVolumeL(TInt& aMaxVolume);
       
    75 
       
    76         /**
       
    77          * This API allows the user to specify observers for the 324m interface.
       
    78          *
       
    79          * @param aHandler     
       
    80          **/
       
    81         virtual void SetObserverL(MVtProtocolHandler* aHandler);
       
    82     private:
       
    83         TAudioConfigHandler* iAudioConfigHandler;
       
    84     };
       
    85 #endif
       
    86 //  End of File