include/realmedia/rmaupgrd.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmaupgrd.h 7 2003-05-30 02:18:02Z gabest $
   4  *
   5  *  Copyright (C) 1995-1999 RealNetworks, Inc. All rights reserved.
   6  *
   7  *  http://www.real.com/devzone
   8  *
   9  *  This program contains proprietary
  10  *  information of Progressive Networks, Inc, and is licensed
  11  *  subject to restrictions on use and distribution.
  12  *
  13  *  Auto Upgrade Interfaces
  14  *
  15  */
  16
  17 #ifndef _RMAUPGRD_H
  18 #define _RMAUPGRD_H
  19
  20
  21 typedef _INTERFACE IRMABuffer IRMABuffer;
  22
  23
  24 /* Enumeration for the upgrade types */
  25 typedef enum _RMAUpgradeType
  26 {
  27     eUT_Required,
  28     eUT_Recommended,
  29     eUT_Optional
  30 } RMAUpgradeType;
  31
  32
  33 /****************************************************************************
  34  *
  35  *  Interface:
  36  *
  37  *      IRMAUpgradeCollection
  38  *
  39  *  Purpose:
  40  *
  41  *      Interface provided by the Context. This interface allows collection
  42  *      of upgrade components by the client core and it's delegates
  43  *      (i.e. renderer plugins etc.)
  44  *
  45  *  IID_IRMAUpgradeCollection
  46  *
  47  *      {00002500-0901-11d1-8B06-00A024406D59}
  48  *
  49  */
  50
  51 DEFINE_GUID(IID_IRMAUpgradeCollection,
  52             0x00002500, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  53
  54 #undef  INTERFACE
  55 #define INTERFACE   IRMAUpgradeCollection
  56
  57 DECLARE_INTERFACE_(IRMAUpgradeCollection, IUnknown)
  58 {
  59     /*
  60      * IRMAUpgradeCollection methods
  61      */
  62
  63     /************************************************************************
  64      *  Method:
  65      *          IRMAUpgradeCollection::Add
  66      *  Purpose:
  67      *          Adds the specified upgrade information to the collection
  68      *
  69      */
  70     STDMETHOD_(UINT32, Add)     (THIS_
  71                                 RMAUpgradeType upgradeType,
  72                                 IRMABuffer* pPluginId,
  73                                 UINT32 majorVersion,
  74                                 UINT32 minorVersion) PURE;
  75
  76     /************************************************************************
  77      *  Method:
  78      *          IRMAUpgradeCollection::Remove
  79      *  Purpose:
  80      *          Remove the specified item from the collection
  81      *
  82      */
  83     STDMETHOD(Remove)           (THIS_
  84                                 UINT32 index) PURE;
  85
  86     /************************************************************************
  87      *  Method:
  88      *          IRMAUpgradeCollection::RemoveAll
  89      *  Purpose:
  90      *          Remove all items from the collection
  91      *
  92      */
  93     STDMETHOD(RemoveAll)        (THIS) PURE;
  94
  95     /************************************************************************
  96      *  Method:
  97      *          IRMAUpgradeCollection::GetCount
  98      *  Purpose:
  99      *          get the count of the collection
 100      *
 101      */
 102     STDMETHOD_(UINT32, GetCount)(THIS) PURE;
 103
 104     /************************************************************************
 105      *  Method:
 106      *          IRMAUpgradeCollection::GetAt
 107      *  Purpose:
 108      *          get the specified items upgrade information
 109      *
 110      */
 111     STDMETHOD(GetAt)            (THIS_
 112                                 UINT32 index,
 113                                 REF(RMAUpgradeType) upgradeType,
 114                                 IRMABuffer* pPluginId,
 115                                 REF(UINT32) majorVersion,
 116                                 REF(UINT32) minorVersion) PURE;
 117 };
 118
 119
 120 /****************************************************************************
 121  *
 122  *  Interface:
 123  *
 124  *      IRMAUpgradeHandler
 125  *
 126  *  Purpose:
 127  *
 128  *      Interface provided by the top-level client application.  This
 129  *      interface allows the client core to request an upgrade.
 130  *
 131  *  IID_IRMAUpgradeHandler:
 132  *
 133  *      {00002501-0901-11d1-8B06-00A024406D59}
 134  *
 135  */
 136
 137 DEFINE_GUID(IID_IRMAUpgradeHandler,
 138                         0x00002501, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 139
 140 #undef  INTERFACE
 141 #define INTERFACE   IRMAUpgradeHandler
 142
 143 DECLARE_INTERFACE_(IRMAUpgradeHandler, IUnknown)
 144 {
 145     /*
 146      * IRMAUpgradeHandler methods
 147      */
 148
 149     /************************************************************************
 150      *  Method:
 151      *          IRMAUpgradeHandler::RequestUpgrade
 152      *  Purpose:
 153      *          Ask if user wants to do an upgrade and start an upgrade
 154      *
 155      */
 156     STDMETHOD(RequestUpgrade) (THIS_ IRMAUpgradeCollection* pComponents,
 157                                      BOOL bBlocking) PURE;
 158
 159     /************************************************************************
 160      *  Method:
 161      *          IRMAUpgradeHandler::HasComponents
 162      *  Purpose:
 163      *          Check if required components are present on the system.
 164      *  Returns:
 165      *          PNR_OK - components are here, no upgrade required;
 166      *                   all components are removed from pComponents.
 167      *          PNR_FAIL - some components are missing;
 168      *                   pComponents contains only those components
 169      *                   that need upgrade.
 170      *
 171      */
 172     STDMETHOD(HasComponents)  (THIS_ IRMAUpgradeCollection* pComponents) PURE;
 173 };
 174
 175
 176
 177 #endif /* _RMAUPGRD_H */
 178