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