os/mm/mmlibs/mmfw/inc/mmf/PLUGIN/mmfmediaclientextdisplayinterface.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
/**
sl@0
    17
 @file
sl@0
    18
 @internalTechnology
sl@0
    19
*/
sl@0
    20
sl@0
    21
#ifndef MMFMEDIACLIENTEXTDISPLAYINTERFACE_H_
sl@0
    22
#define MMFMEDIACLIENTEXTDISPLAYINTERFACE_H_
sl@0
    23
sl@0
    24
#include <e32base.h>
sl@0
    25
sl@0
    26
#define MMF_MEDIA_CLIENT_EXT_DISPLAY_INTERFACE_V3
sl@0
    27
sl@0
    28
/**
sl@0
    29
sl@0
    30
Enumeration used to indicate external display current connection status
sl@0
    31
sl@0
    32
**/
sl@0
    33
enum TExtDisplayConnectionProviderConnType
sl@0
    34
    {
sl@0
    35
    EExtDisplayConnectionProviderConnTypeDisconnected,
sl@0
    36
    EExtDisplayConnectionProviderConnTypeHdmi,
sl@0
    37
    EExtDisplayConnectionProviderConnTypeAnalog
sl@0
    38
    };
sl@0
    39
sl@0
    40
/**
sl@0
    41
sl@0
    42
Mixin class capable of handling events from provider
sl@0
    43
sl@0
    44
*/
sl@0
    45
class MExtDisplayConnectionProviderCallback
sl@0
    46
    {
sl@0
    47
public:
sl@0
    48
    virtual void MedcpcExtDisplayNotifyConnected(TExtDisplayConnectionProviderConnType aExtDisplayConnType) = 0;
sl@0
    49
    };
sl@0
    50
sl@0
    51
/**
sl@0
    52
sl@0
    53
Mixin class for external display connection provider plugins.
sl@0
    54
sl@0
    55
*/
sl@0
    56
class CExtDisplayConnectionProviderInterface : public CBase
sl@0
    57
	{
sl@0
    58
public:
sl@0
    59
sl@0
    60
    /**
sl@0
    61
    Allocates and constructs a new provider plugin.
sl@0
    62
sl@0
    63
    Uses ECOM to instantiate a new provider plugin. Can leave with any of the system-wide error codes.
sl@0
    64
sl@0
    65
    @leave  KErrNotSupported There is no support for external displays.
sl@0
    66
    @return A pointer to the new provider plugin.
sl@0
    67
sl@0
    68
    */
sl@0
    69
    static CExtDisplayConnectionProviderInterface* NewL();
sl@0
    70
sl@0
    71
    /**
sl@0
    72
    Function to be implemented by connection provider that allows the callback to be set.
sl@0
    73
    
sl@0
    74
    @param  aCallback
sl@0
    75
        A reference to an object that can be used by the provider to send events back to the client.
sl@0
    76
    */
sl@0
    77
    virtual void SetExtDisplayConnectionProviderCallback(MExtDisplayConnectionProviderCallback& aCallback) = 0;
sl@0
    78
sl@0
    79
    /**
sl@0
    80
    Function to be implemented by connection provider that indicates the external display connection type 
sl@0
    81
    
sl@0
    82
    @return One of values defined in TExtDisplayConnectionProviderConnType
sl@0
    83
    */
sl@0
    84
    virtual TExtDisplayConnectionProviderConnType ExtDisplayConnType() = 0;
sl@0
    85
	
sl@0
    86
    /**
sl@0
    87
    Function to be implemented by connection provider that indicates the display id that should
sl@0
    88
    be used for the external display port.
sl@0
    89
    
sl@0
    90
    @return TInt the display id for the external display port
sl@0
    91
    */
sl@0
    92
    virtual TInt ExtDisplayId() = 0;
sl@0
    93
sl@0
    94
    /**
sl@0
    95
    Default destructor.
sl@0
    96
    */
sl@0
    97
    IMPORT_C virtual ~CExtDisplayConnectionProviderInterface();
sl@0
    98
sl@0
    99
protected:
sl@0
   100
    /**
sl@0
   101
    Constructor.
sl@0
   102
    */
sl@0
   103
    IMPORT_C CExtDisplayConnectionProviderInterface();
sl@0
   104
    
sl@0
   105
private:
sl@0
   106
    /**
sl@0
   107
    Required by ECOM.
sl@0
   108
    */
sl@0
   109
    TUid iInstanceKey;
sl@0
   110
	};
sl@0
   111
sl@0
   112
#endif /* MMFMEDIACLIENTEXTDISPLAYINTERFACE_H_ */