include/realmedia/rmagroup.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmagroup.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  *
  14  *  Group Interface.
  15  *
  16  */
  17
  18 #ifndef _IRMAGROUP_H_
  19 #define _IRMAGROUP_H_
  20
  21 /****************************************************************************
  22  *
  23  * Forward declarations of some interfaces defined/used here-in.
  24  */
  25 typedef _INTERFACE   IRMAGroup                      IRMAGroup;
  26 typedef _INTERFACE   IRMAGroupManager               IRMAGroupManager;
  27 typedef _INTERFACE   IRMAGroupSink                  IRMAGroupSink;
  28 typedef _INTERFACE   IRMAValues                     IRMAValues;
  29
  30
  31 /****************************************************************************
  32  *
  33  *  Interface:
  34  *
  35  *  IRMAGroup
  36  *
  37  *  Purpose:
  38  *
  39  *
  40  *  IID_IRMAGroup:
  41  *
  42  *  {0x00002400-0901-11d1-8B06-00A024406D59}
  43  *
  44  */
  45 DEFINE_GUID(IID_IRMAGroup, 0x00002400, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  46             0xa0, 0x24, 0x40, 0x6d, 0x59);
  47
  48
  49 #undef  INTERFACE
  50 #define INTERFACE   IRMAGroup
  51
  52 DECLARE_INTERFACE_(IRMAGroup, IUnknown)
  53 {
  54     /*
  55      *  IUnknown methods
  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     /*
  66      *  IRMAGroup methods
  67      */
  68     /************************************************************************
  69     *  Method:
  70     *      IRMAGroup::SetGroupProperties
  71     *  Purpose:
  72     *           Set any group specific information like Title Author
  73     *           Copyright etc.
  74     */
  75     STDMETHOD(SetGroupProperties)   (THIS_
  76                                      IRMAValues*  /*IN*/ pProperties) PURE;
  77
  78     /************************************************************************
  79     *  Method:
  80     *      IRMAGroup::GetGroupProperties
  81     *  Purpose:
  82     *           Get any group specific information. May return NULL.
  83     */
  84     STDMETHOD_(IRMAValues*, GetGroupProperties)   (THIS) PURE;
  85     /************************************************************************
  86     *  Method:
  87     *      IRMAGroup::GetTrackCount
  88     *  Purpose:
  89     *           Get the number of tracks within this group.
  90     */
  91     STDMETHOD_(UINT16,GetTrackCount)    (THIS) PURE;
  92
  93     /************************************************************************
  94     *  Method:
  95     *      IRMAGroup::GetTrack
  96     *  Purpose:
  97     *           Get ith track in this group
  98     */
  99     STDMETHOD(GetTrack) (THIS_
 100                         UINT16      /*IN*/ uTrackIndex,
 101                         REF(IRMAValues*)  /*OUT*/ pTrack) PURE;
 102
 103     /************************************************************************
 104     *  Method:
 105     *      IRMAGroup::AddTrack
 106     *  Purpose:
 107     *           Add Tracks to the group.
 108     */
 109     STDMETHOD(AddTrack) (THIS_
 110                         IRMAValues*     /*IN*/ pTrack) PURE;
 111
 112     /************************************************************************
 113     *  Method:
 114     *      IRMAGroup::RemoveTrack
 115     *  Purpose:
 116     *           Remove an already added track
 117     */
 118     STDMETHOD(RemoveTrack)  (THIS_
 119                             UINT16      /*IN*/ uTrackIndex) PURE;
 120 };
 121
 122
 123 /****************************************************************************
 124  *
 125  *  Interface:
 126  *
 127  *  IRMAGroupManager
 128  *
 129  *  Purpose:
 130  *
 131  *
 132  *  IID_IRMAGroupManager:
 133  *
 134  *  {0x00002401-0901-11d1-8B06-00A024406D59}
 135  *
 136  */
 137 DEFINE_GUID(IID_IRMAGroupManager, 0x00002401, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 138             0xa0, 0x24, 0x40, 0x6d, 0x59);
 139
 140
 141 #undef  INTERFACE
 142 #define INTERFACE   IRMAGroupManager
 143
 144 DECLARE_INTERFACE_(IRMAGroupManager, IUnknown)
 145 {
 146     /*
 147      *  IUnknown methods
 148      */
 149     STDMETHOD(QueryInterface)       (THIS_
 150                     REFIID riid,
 151                     void** ppvObj) PURE;
 152
 153     STDMETHOD_(ULONG,AddRef)      (THIS) PURE;
 154
 155     STDMETHOD_(ULONG,Release)     (THIS) PURE;
 156
 157     /*
 158      *  IRMAGroupManager methods
 159      */
 160
 161     /************************************************************************
 162     *  Method:
 163     *      IRMAGroupManager::CreateGroup
 164     *  Purpose:
 165     *           Create a group
 166     */
 167     STDMETHOD(CreateGroup)    (REF(IRMAGroup*) pGroup) PURE;
 168
 169     /************************************************************************
 170     *  Method:
 171     *      IRMAGroupManager::GetGroupCount
 172     *  Purpose:
 173     *           Get the number of groups within the presentation.
 174     */
 175     STDMETHOD_(UINT16,GetGroupCount)    (THIS) PURE;
 176
 177     /************************************************************************
 178     *  Method:
 179     *      IRMAGroupManager::GetGroup
 180     *  Purpose:
 181     *           Get ith group in the presentation
 182     */
 183     STDMETHOD(GetGroup) (THIS_
 184                         UINT16            /*IN*/  uGroupIndex,
 185                         REF(IRMAGroup*)  /*OUT*/ pGroup) PURE;
 186
 187     /************************************************************************
 188     *  Method:
 189     *      IRMAGroupManager::SetCurrentGroup
 190     *  Purpose:
 191     *           Play this group in the presentation.
 192     */
 193     STDMETHOD(SetCurrentGroup)  (THIS_
 194                                 UINT16      /*IN*/ uGroupIndex) PURE;
 195
 196     /************************************************************************
 197     *  Method:
 198     *      IRMAGroupMgr::GetCurrentGroup
 199     *  Purpose:
 200     *           Get the current group index
 201     */
 202     STDMETHOD(GetCurrentGroup)  (THIS_
 203                                 REF(UINT16) /*OUT*/ uGroupIndex) PURE;
 204
 205     /************************************************************************
 206     *  Method:
 207     *      IRMAGroupManager::AddGroup
 208     *  Purpose:
 209     *           Add a group to the presentation.
 210     */
 211     STDMETHOD(AddGroup) (THIS_
 212                         IRMAGroup*          /*IN*/ pGroup) PURE;
 213
 214     /************************************************************************
 215     *  Method:
 216     *      IRMAGroupManager::RemoveGroup
 217     *  Purpose:
 218     *           Remove an already added group
 219     */
 220     STDMETHOD(RemoveGroup)  (THIS_
 221                             UINT16      /*IN*/ uGroupIndex) PURE;
 222
 223
 224     /************************************************************************
 225     *  Method:
 226     *      IRMAGroupManager::AddSink
 227     *  Purpose:
 228     *           Add a sink to get notifications about any tracks or groups
 229     *           being added to the presentation.
 230     */
 231     STDMETHOD(AddSink)  (THIS_
 232                         IRMAGroupSink* /*IN*/ pGroupSink) PURE;
 233
 234
 235     /************************************************************************
 236     *  Method:
 237     *      IRMAGroupManager::RemoveSink
 238     *  Purpose:
 239     *           Remove Sink
 240     */
 241     STDMETHOD(RemoveSink)   (THIS_
 242                             IRMAGroupSink* /*IN*/ pGroupSink) PURE;
 243
 244     /************************************************************************
 245     *  Method:
 246     *      IRMAGroup::GetPresentationProperties
 247     *  Purpose:
 248     *           Get any presentation information. May return NULL.
 249     */
 250     STDMETHOD_(IRMAValues*, GetPresentationProperties)   (THIS) PURE;
 251
 252     /************************************************************************
 253     *  Method:
 254     *      IRMAGroup::SetPresentationProperties
 255     *  Purpose:
 256     *           Set any presentation information like Title Author
 257     *           Copyright etc.
 258     */
 259     STDMETHOD(SetPresentationProperties)   (THIS_
 260                                             IRMAValues*  /*IN*/ pProperties) PURE;
 261
 262 };
 263
 264
 265 /****************************************************************************
 266  *
 267  *  Interface:
 268  *
 269  *  IRMAGroupSink
 270  *
 271  *  Purpose:
 272  *
 273  *
 274  *  IID_IRMAGroupSink:
 275  *
 276  *  {0x00002402-0901-11d1-8B06-00A024406D59}
 277  *
 278  */
 279 DEFINE_GUID(IID_IRMAGroupSink, 0x00002402, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 280             0xa0, 0x24, 0x40, 0x6d, 0x59);
 281
 282
 283 #undef  INTERFACE
 284 #define INTERFACE   IRMAGroupSink
 285
 286 DECLARE_INTERFACE_(IRMAGroupSink, IUnknown)
 287 {
 288     /*
 289      *  IUnknown methods
 290      */
 291     STDMETHOD(QueryInterface)       (THIS_
 292                     REFIID riid,
 293                     void** ppvObj) PURE;
 294
 295     STDMETHOD_(ULONG,AddRef)      (THIS) PURE;
 296
 297     STDMETHOD_(ULONG,Release)     (THIS) PURE;
 298
 299     /*
 300      *  IRMAGroupSink methods
 301      */
 302     /************************************************************************
 303     *  Method:
 304     *      IRMAGroupSink::GroupAdded
 305     *  Purpose:
 306     *           Notification of a new group being added to the presentation.
 307     */
 308     STDMETHOD(GroupAdded)    (THIS_
 309                             UINT16          /*IN*/ uGroupIndex,
 310                             IRMAGroup*      /*IN*/ pGroup) PURE;
 311
 312     /************************************************************************
 313     *  Method:
 314     *      IRMAGroupSink::GroupRemoved
 315     *  Purpose:
 316     *           Notification of a group being removed from the presentation.
 317     */
 318     STDMETHOD(GroupRemoved)    (THIS_
 319                                 UINT16      /*IN*/ uGroupIndex,
 320                                 IRMAGroup*  /*IN*/ pGroup) PURE;
 321
 322     /************************************************************************
 323     *  Method:
 324     *      IRMAGroupSink::AllGroupsRemoved
 325     *  Purpose:
 326     *           Notification that all groups have been removed from the
 327     *           current presentation.
 328     */
 329     STDMETHOD(AllGroupsRemoved)  (THIS) PURE;
 330
 331     /************************************************************************
 332     *  Method:
 333     *      IRMAGroupSink::TrackAdded
 334     *  Purpose:
 335     *           Notification of a new track being added to a group.
 336     */
 337     STDMETHOD(TrackAdded)  (THIS_
 338                             UINT16          /*IN*/ uGroupIndex,
 339                             UINT16          /*IN*/ uTrackIndex,
 340                             IRMAValues*     /*IN*/ pTrack) PURE;
 341
 342     /************************************************************************
 343     *  Method:
 344     *      IRMAGroupSink::TrackRemoved
 345     *  Purpose:
 346     *           Notification of a track being removed from a group.
 347     */
 348     STDMETHOD(TrackRemoved)    (THIS_
 349                                 UINT16          /*IN*/ uGroupIndex,
 350                                 UINT16          /*IN*/ uTrackIndex,
 351                                 IRMAValues*     /*IN*/ pTrack) PURE;
 352
 353     /************************************************************************
 354     *  Method:
 355     *      IRMAGroupSink::TrackStarted
 356     *  Purpose:
 357     *           Notification of a track being started (to get duration, for
 358     *           instance...)
 359     */
 360     STDMETHOD(TrackStarted)     (THIS_
 361                                 UINT16      /*IN*/ uGroupIndex,
 362                                 UINT16      /*IN*/ uTrackIndex,
 363                                 IRMAValues* /*IN*/ pTrack) PURE;
 364
 365     /************************************************************************
 366     *  Method:
 367     *      IRMAGroupSink::TrackStopped
 368     *  Purpose:
 369     *           Notification of a track being stopped
 370     *
 371     */
 372     STDMETHOD(TrackStopped)     (THIS_
 373                                 UINT16      /*IN*/ uGroupIndex,
 374                                 UINT16      /*IN*/ uTrackIndex,
 375                                 IRMAValues* /*IN*/ pTrack) PURE;
 376
 377     /************************************************************************
 378     *  Method:
 379     *      IRMAGroupSink::CurrentGroupSet
 380     *  Purpose:
 381     *           This group is being currently played in the presentation.
 382     */
 383     STDMETHOD(CurrentGroupSet)  (THIS_
 384                                 UINT16      /*IN*/ uGroupIndex,
 385                                 IRMAGroup*  /*IN*/ pGroup) PURE;
 386 };
 387
 388
 389
 390
 391 #endif /*_IRMAGROUP_H_*/