include/realmedia/rmaallow.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmaallow.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  *  Interfaces related to allowance plugins.
  14  *
  15  */
  16
  17 #ifndef _RMAALLOW_H_
  18 #define _RMAALLOW_H_
  19
  20 /*
  21  * Forward declarations of some interfaces defined or used here-in.
  22  */
  23 typedef _INTERFACE  IRMAValues                      IRMAValues;
  24 typedef _INTERFACE  IRMABuffer                      IRMABuffer;
  25 typedef _INTERFACE  IRMARequest                     IRMARequest;
  26 typedef _INTERFACE  IRMAPlayerConnectionAdviseSinkManager  IRMAPlayerConnectionAdviseSinkManager;
  27 typedef _INTERFACE  IRMAPlayerConnectionAdviseSink  IRMAPlayerConnectionAdviseSink;
  28 typedef _INTERFACE  IRMAPlayerConnectionResponse    IRMAPlayerConnectionResponse;
  29 typedef _INTERFACE  IRMAPlayerController            IRMAPlayerController;
  30 typedef _INTERFACE  IRMAPlayerControllerProxyRedirect IRMAPlayerControllerProxyRedirect;
  31
  32 /****************************************************************************
  33  *
  34  *  Interface:
  35  *
  36  *      IRMAPlayerConnectionAdviseSink
  37  *
  38  *  Purpose:
  39  *
  40  *      Advise Sink which receives notification whenever a new player
  41  *      connects to the server.
  42  *
  43  *  IID_IRMAPlayerConnectionAdviseSink:
  44  *
  45  *      {00002600-0901-11d1-8B06-00A024406D59}
  46  *
  47  */
  48
  49 DEFINE_GUID(IID_IRMAPlayerConnectionAdviseSink, 0x00002600, 0x901, 0x11d1,
  50             0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  51
  52 #undef  INTERFACE
  53 #define INTERFACE IRMAPlayerConnectionAdviseSink
  54
  55 DECLARE_INTERFACE_(IRMAPlayerConnectionAdviseSink, IUnknown)
  56 {
  57     STDMETHOD(QueryInterface)           (THIS_
  58                                         REFIID riid,
  59                                         void** ppvObj) PURE;
  60
  61     STDMETHOD_(ULONG,AddRef)          (THIS) PURE;
  62
  63     STDMETHOD_(ULONG,Release)         (THIS) PURE;
  64
  65     /* OnConnection is called when a new player has connected to the
  66      * server.  If the result is PNR_OK, then the plugin will be notified
  67      * when certain events occur in the player's life cycle.
  68      */
  69     STDMETHOD(OnConnection) (THIS_
  70                                 IRMAPlayerConnectionResponse* pResponse) PURE;
  71
  72     /* SetPlayerController is called by the server core to provide us with
  73      * an interface which can stop, alert, redirect or otherwise control
  74      * the player we are receiving notifications about.
  75      */
  76     STDMETHOD(SetPlayerController)  (THIS_
  77                                 IRMAPlayerController* pPlayerController) PURE;
  78
  79     /* SetRegistryID is called by the server core to provide us with the
  80      * ID for this Player in the server registry. The plugin can use this
  81      * registry ID to find out various information about the connected player.
  82      */
  83     STDMETHOD(SetRegistryID)        (THIS_ UINT32 ulPlayerRegistryID) PURE;
  84
  85     STDMETHOD(OnURL)                (THIS_ IRMARequest* pRequest) PURE;
  86     STDMETHOD(OnBegin)              (THIS) PURE;
  87     STDMETHOD(OnStop)               (THIS) PURE;
  88     STDMETHOD(OnPause)              (THIS) PURE;
  89     STDMETHOD(OnDone)               (THIS) PURE;
  90 };
  91
  92 /****************************************************************************
  93  *
  94  *  Interface:
  95  *
  96  *      IRMAPlayerConnectionResponse
  97  *
  98  *  Purpose:
  99  *
 100  *      Response object for the PlayerConnectionAdviseSink.
 101  *
 102  *  IID_IRMAPlayerConnectionResponse:
 103  *
 104  *      {00002601-0901-11d1-8B06-00A024406D59}
 105  *
 106  */
 107
 108 DEFINE_GUID(IID_IRMAPlayerConnectionResponse, 0x00002601, 0x901, 0x11d1,
 109             0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 110
 111 #undef  INTERFACE
 112 #define INTERFACE IRMAPlayerConnectionResponse
 113
 114 DECLARE_INTERFACE_(IRMAPlayerConnectionResponse, IUnknown)
 115 {
 116     STDMETHOD(QueryInterface)           (THIS_
 117                                         REFIID riid,
 118                                         void** ppvObj) PURE;
 119
 120     STDMETHOD_(ULONG,AddRef)          (THIS) PURE;
 121
 122     STDMETHOD_(ULONG,Release)         (THIS) PURE;
 123
 124     STDMETHOD(OnConnectionDone)         (THIS_ PN_RESULT status) PURE;
 125     STDMETHOD(OnURLDone)                (THIS_ PN_RESULT status) PURE;
 126     STDMETHOD(OnBeginDone)              (THIS_ PN_RESULT status) PURE;
 127     STDMETHOD(OnStopDone)               (THIS_ PN_RESULT status) PURE;
 128     STDMETHOD(OnPauseDone)              (THIS_ PN_RESULT status) PURE;
 129 };
 130
 131 /****************************************************************************
 132  *
 133  *  Interface:
 134  *
 135  *      IRMAPlayerController
 136  *
 137  *  Purpose:
 138  *
 139  *      Object created by the server core and given to the
 140  *      IRMAPlayerConnectionResponse object so that the response object
 141  *      can control the connected player.
 142  *
 143  *  IID_IRMAPlayerController:
 144  *
 145  *      {00002602-0901-11d1-8B06-00A024406D59}
 146  *
 147  */
 148
 149 DEFINE_GUID(IID_IRMAPlayerController, 0x00002602, 0x901, 0x11d1,
 150             0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 151
 152 #undef  INTERFACE
 153 #define INTERFACE IRMAPlayerController
 154
 155 DECLARE_INTERFACE_(IRMAPlayerController, IUnknown)
 156 {
 157     STDMETHOD(QueryInterface)           (THIS_
 158                                         REFIID riid,
 159                                         void** ppvObj) PURE;
 160
 161     STDMETHOD_(ULONG,AddRef)          (THIS) PURE;
 162
 163     STDMETHOD_(ULONG,Release)         (THIS) PURE;
 164
 165     STDMETHOD(Pause)                    (THIS) PURE;
 166     STDMETHOD(Resume)                   (THIS) PURE;
 167     STDMETHOD(Disconnect)               (THIS) PURE;
 168     STDMETHOD(AlertAndDisconnect)       (THIS_ IRMABuffer* pAlert) PURE;
 169
 170     /* HostRedirect is called by a PlayerConnectionAdviseSink to redirect
 171      * this player to another host and/or port, for the same URL. This
 172      * method works with both RTSP and PNA protocols.
 173      */
 174     STDMETHOD(HostRedirect)             (THIS_ IRMABuffer* pHost,
 175                                         UINT16 nPort) PURE;
 176
 177     /* NetworkRedirect is called by a PlayerConnectionAdviseSink to redirect
 178      * this player to another URL. Note: This method is only available for
 179      * redirecting an RTSP player connection to another RTSP URL.
 180      */
 181     STDMETHOD(NetworkRedirect)          (THIS_ IRMABuffer* pURL,
 182                                         UINT32 ulSecsFromNow) PURE;
 183
 184     /* Redirect is called by a PlayerConnectionAdviseSink to redirect
 185      * this player to another URL on the same server. For example, if
 186      * pPartialURL were set to "welcome.rm", the player would be redirected
 187      * to "current_protocol://current_host:current_port/welcome.rm". This
 188      * method works with both RTSP and PNA protocols.
 189      */
 190     STDMETHOD(Redirect)                 (THIS_ IRMABuffer* pPartialURL) PURE;
 191 };
 192
 193 /****************************************************************************
 194  *
 195  *  Interface:
 196  *
 197  *      IRMAPlayerConnectionAdviseSinkManager
 198  *
 199  *  Purpose:
 200  *
 201  *      Manages the creation of IRMAPlayerConnectionAdviseSink objects
 202  *
 203  *  IID_IRMAPlayerConnectionAdviseSinkManager:
 204  *
 205  *      {00002603-0901-11d1-8B06-00A024406D59}
 206  *
 207  */
 208
 209 DEFINE_GUID(IID_IRMAPlayerConnectionAdviseSinkManager, 0x00002603, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 210
 211 #undef  INTERFACE
 212 #define INTERFACE IRMAPlayerConnectionAdviseSinkManager
 213
 214 DECLARE_INTERFACE_(IRMAPlayerConnectionAdviseSinkManager, IUnknown)
 215 {
 216     STDMETHOD(QueryInterface)           (THIS_
 217                                         REFIID riid,
 218                                         void** ppvObj) PURE;
 219
 220     STDMETHOD_(ULONG,AddRef)          (THIS) PURE;
 221
 222     STDMETHOD_(ULONG,Release)         (THIS) PURE;
 223
 224     STDMETHOD(CreatePlayerConnectionAdviseSink)
 225                 (THIS_
 226                 REF(IRMAPlayerConnectionAdviseSink*) pPCAdviseSink) PURE;
 227 };
 228
 229 /****************************************************************************
 230  *
 231  *  Interface:
 232  *
 233  *      IRMAPlayerControllerProxyRedirect
 234  *
 235  *  Purpose:
 236  *
 237  *      QueryInterfaced from IRMAPlayerController.  Allows 305 proxy redirect
 238  *      to be issued (as per RTSP spec).
 239  *
 240  *  IID_IRMAPlayerControllerProxyRedirect:
 241  *
 242  *      {00002607-0901-11d1-8B06-00A024406D59}
 243  *
 244  */
 245
 246 DEFINE_GUID(IID_IRMAPlayerControllerProxyRedirect, 0x00002607, 0x901, 0x11d1,
 247             0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 248
 249 #undef  INTERFACE
 250 #define INTERFACE IRMAPlayerControllerProxyRedirect
 251
 252 DECLARE_INTERFACE_(IRMAPlayerControllerProxyRedirect, IUnknown)
 253 {
 254     STDMETHOD(QueryInterface)           (THIS_
 255                                         REFIID riid,
 256                                         void** ppvObj) PURE;
 257
 258     STDMETHOD_(ULONG,AddRef)          (THIS) PURE;
 259
 260     STDMETHOD_(ULONG,Release)         (THIS) PURE;
 261
 262     /*
 263      * This URL is just a hostname / port.  It must be formatted like this:
 264      * "rtsp://audio.real.com:554/".
 265      *
 266      * NOTE:  You can *only* call this method between OnURL() and OnURLDone().
 267      * NOTE:  This method only works on RTSP connections.
 268      */
 269     STDMETHOD(NetworkProxyRedirect)          (THIS_ IRMABuffer* pURL) PURE;
 270 };
 271
 272 #endif /* _RMAALLOW_H_ */