os/mm/mmlibs/mmfw/inc/mmf/PLUGIN/mmfmediaclientextdisplayinterface.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     1 // Copyright (c) 2009-2010 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  @file
    18  @internalTechnology
    19 */
    20 
    21 #ifndef MMFMEDIACLIENTEXTDISPLAYINTERFACE_H_
    22 #define MMFMEDIACLIENTEXTDISPLAYINTERFACE_H_
    23 
    24 #include <e32base.h>
    25 
    26 #define MMF_MEDIA_CLIENT_EXT_DISPLAY_INTERFACE_V3
    27 
    28 /**
    29 
    30 Enumeration used to indicate external display current connection status
    31 
    32 **/
    33 enum TExtDisplayConnectionProviderConnType
    34     {
    35     EExtDisplayConnectionProviderConnTypeDisconnected,
    36     EExtDisplayConnectionProviderConnTypeHdmi,
    37     EExtDisplayConnectionProviderConnTypeAnalog
    38     };
    39 
    40 /**
    41 
    42 Mixin class capable of handling events from provider
    43 
    44 */
    45 class MExtDisplayConnectionProviderCallback
    46     {
    47 public:
    48     virtual void MedcpcExtDisplayNotifyConnected(TExtDisplayConnectionProviderConnType aExtDisplayConnType) = 0;
    49     };
    50 
    51 /**
    52 
    53 Mixin class for external display connection provider plugins.
    54 
    55 */
    56 class CExtDisplayConnectionProviderInterface : public CBase
    57 	{
    58 public:
    59 
    60     /**
    61     Allocates and constructs a new provider plugin.
    62 
    63     Uses ECOM to instantiate a new provider plugin. Can leave with any of the system-wide error codes.
    64 
    65     @leave  KErrNotSupported There is no support for external displays.
    66     @return A pointer to the new provider plugin.
    67 
    68     */
    69     static CExtDisplayConnectionProviderInterface* NewL();
    70 
    71     /**
    72     Function to be implemented by connection provider that allows the callback to be set.
    73     
    74     @param  aCallback
    75         A reference to an object that can be used by the provider to send events back to the client.
    76     */
    77     virtual void SetExtDisplayConnectionProviderCallback(MExtDisplayConnectionProviderCallback& aCallback) = 0;
    78 
    79     /**
    80     Function to be implemented by connection provider that indicates the external display connection type 
    81     
    82     @return One of values defined in TExtDisplayConnectionProviderConnType
    83     */
    84     virtual TExtDisplayConnectionProviderConnType ExtDisplayConnType() = 0;
    85 	
    86     /**
    87     Function to be implemented by connection provider that indicates the display id that should
    88     be used for the external display port.
    89     
    90     @return TInt the display id for the external display port
    91     */
    92     virtual TInt ExtDisplayId() = 0;
    93 
    94     /**
    95     Default destructor.
    96     */
    97     IMPORT_C virtual ~CExtDisplayConnectionProviderInterface();
    98 
    99 protected:
   100     /**
   101     Constructor.
   102     */
   103     IMPORT_C CExtDisplayConnectionProviderInterface();
   104     
   105 private:
   106     /**
   107     Required by ECOM.
   108     */
   109     TUid iInstanceKey;
   110 	};
   111 
   112 #endif /* MMFMEDIACLIENTEXTDISPLAYINTERFACE_H_ */