musicplayer_plat/mpx_music_player_media_key_handler_api/inc/mpxmediakeyhandler.h
changeset 0 ff3acec5bc43
equal deleted inserted replaced
-1:000000000000 0:ff3acec5bc43
       
     1 /*
       
     2 * Copyright (c) 2006 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:  MPX media key handler interface definition
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef C_MMPXMEDIAKEYHANDLER_H
       
    21 #define C_MMPXMEDIAKEYHANDLER_H
       
    22 
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32base.h>
       
    26 #include <mpxmediakeyhandlerobserver.h>
       
    27 #include <mpxmediakeyhandlerdefs.h>
       
    28 
       
    29 // DATA TYPES
       
    30 typedef TInt TMPXMediaKeyPopupFlags;
       
    31 
       
    32 // CONSTANTS
       
    33 /**
       
    34  * Constants for media key feature flags
       
    35  */
       
    36 #define EDisplayVolumePopup 0x0001
       
    37 #define EDisplayMediaPopup  0x0002
       
    38 
       
    39 // CLASS DECLARATION
       
    40 
       
    41 /**
       
    42  *  MPX media key handler interface.
       
    43  *
       
    44  *  @lib mpxmediakeyhandler.lib
       
    45  *  @since S60 3.2.3
       
    46  */
       
    47 NONSHARABLE_CLASS( MMPXMediaKeyHandler )
       
    48     {
       
    49 public:
       
    50 
       
    51     /**
       
    52      * Two-phased constructor.
       
    53      *
       
    54      * @since S60 5.0
       
    55      * @param aFlags Flags for creating popups.
       
    56      * @param aObserver Media key command observer
       
    57      * @return Pointer to newly created object.
       
    58      */
       
    59     IMPORT_C static MMPXMediaKeyHandler* NewL(
       
    60         TMPXMediaKeyPopupFlags aFlags,
       
    61         MMPXMediaKeyHandlerObserver* aObserver );
       
    62 
       
    63     /**
       
    64      * Destructor.
       
    65      */
       
    66     virtual ~MMPXMediaKeyHandler();
       
    67 
       
    68     /**
       
    69      * Show playback popup
       
    70      *
       
    71      * @since S60 3.2.3
       
    72      * @param aMode Playback popup behaviour mode
       
    73      */
       
    74     virtual void ShowPlaybackPopupL( TMPXPlaybackPopupModes aMode ) = 0;
       
    75 
       
    76     /**
       
    77      * Show Volume popup
       
    78      *
       
    79      * @since S60 5.0
       
    80      */
       
    81     virtual void ShowVolumePopupL() = 0;
       
    82 
       
    83     /**
       
    84      * Dismiss notifier popup.
       
    85      *
       
    86      * @since S60 3.2.3
       
    87      * @param aFlags Popup flag to determine which popup(s) should
       
    88      *               be dismissed.
       
    89      */
       
    90     virtual void DismissNotifier( TMPXMediaKeyPopupFlags aFlags ) = 0;
       
    91 
       
    92 
       
    93     /**
       
    94      * Enable or disable Media Key behavior
       
    95      * @since S60 3.2.3
       
    96      * @param aEnable, ETrue, media keys are sent to observers
       
    97      *                 EFalse, media keys are ignored
       
    98      */
       
    99     virtual void SetEnableMediaKeys( TBool aEnable ) = 0;
       
   100     
       
   101     /**
       
   102      * Gets called when orientation change begins
       
   103      */    
       
   104     virtual void NotifyOrientationChangeBegin() = 0;
       
   105     };
       
   106 
       
   107 #endif  // C_MMPXMEDIAKEYHANDLER_H
       
   108 
       
   109 // End of File