开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 通讯/手机编程 > Symbian > 查看源码
hxcore.h
资源名称：helix.src.0812.rar　[点击查看]
上传用户：zhongxx05
上传日期：2007-06-06
资源大小：33641k
文件大小：54k
源码类别：

Symbian

开发平台：

C/C++

hxcore.h：源码内容
  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  36. #ifndef _HXCORE_H_
  37. #define _HXCORE_H_
  39. /*
  40.  * Forward declarations of some interfaces defined or used here-in.
  41.  */
  42. typedef _INTERFACE IUnknown IUnknown;
  43. typedef _INTERFACE IHXStream IHXStream;
  44. typedef _INTERFACE IHXStreamSource IHXStreamSource;
  45. typedef _INTERFACE IHXPlayer IHXPlayer;
  46. typedef _INTERFACE IHXClientEngine IHXClientEngine;
  47. typedef _INTERFACE IHXScheduler IHXScheduler;
  48. typedef _INTERFACE IHXClientAdviseSink IHXClientAdviseSink;
  49. typedef _INTERFACE IHXValues       IHXValues;
  50. typedef _INTERFACE IHXBuffer       IHXBuffer;
  51. typedef _INTERFACE IHXPacket IHXPacket;
  52. // $Private:
  53. typedef _INTERFACE IHXPersistenceManager IHXPersistenceManager;
  54. typedef _INTERFACE IHXRendererAdviseSink IHXRendererAdviseSink;
  55. typedef _INTERFACE IHXLayoutSite IHXLayoutSite;
  56. typedef _INTERFACE IHXProtocolValidator IHXProtocolValidator;
  57. typedef _INTERFACE IHXUpdateProperties IHXUpdateProperties;
  58. typedef _INTERFACE IHXPersistentComponentManager IHXPersistentComponentManager;
  59. typedef _INTERFACE IHXPersistentComponent IHXPersistentComponent;
  60. typedef _INTERFACE IHXPersistentRenderer IHXPersistentRenderer;
  61. typedef _INTERFACE IHXCoreMutex IHXCoreMutex;
  62. typedef _INTERFACE IHXMacBlitMutex IHXMacBlitMutex;
  63. // $EndPrivate.
  64. typedef _INTERFACE IHXRenderer IHXRenderer;
  65. typedef _INTERFACE IHXPlayer2 IHXPlayer2;
  66. typedef _INTERFACE IHXRequest IHXrequest;
  67. typedef _INTERFACE IHXPlayerNavigator IHXPlayerNavigator;
  68. typedef _INTERFACE IHXGroupSink IHXGroupSink;
  70. typedef struct _PersistentComponentInfo PersistentComponentInfo;
  71. typedef struct _HXxEvent HXxEvent;
  74. #ifdef _MAC_CFM
  75. #pragma export on
  76. #endif
  78. #if defined _UNIX && !(defined _VXWORKS)
  79. /* Includes needed for select() stuff */
  80. #include <sys/time.h>
  81. #include <sys/types.h>
  82. #include <unistd.h>
  83. #endif
  85. #ifdef _BEOS // fd_set stuff
  86. #include <net/socket.h>
  87. #endif
  89. #include "hxwin.h"
  91. /* Used in renderer and advise sink interface */
  92. enum BUFFERING_REASON
  93. {
  94.     BUFFERING_START_UP = 0,
  95.     BUFFERING_SEEK,
  96.     BUFFERING_CONGESTION,
  97.     BUFFERING_LIVE_PAUSE
  98. };
  100. /****************************************************************************
  101.  * 
  102.  *  Function:
  103.  * 
  104.  * CreateEngine()
  105.  * 
  106.  *  Purpose:
  107.  * 
  108.  * Function implemented by the RMA core to return a pointer to the
  109.  * client engine.  This function would be run by top level clients.
  110.  */
  111. STDAPI CreateEngine
  112. (
  113.     IHXClientEngine**  /*OUT*/ ppEngine
  114. );
  116. /****************************************************************************
  117.  * 
  118.  *  Function:
  119.  * 
  120.  * CloseEngine()
  121.  * 
  122.  *  Purpose:
  123.  * 
  124.  * Function implemented by the RMA core to close the engine which
  125.  * was returned in CreateEngine().
  126.  */
  127. STDAPI CloseEngine
  128. (
  129.     IHXClientEngine*  /*IN*/ pEngine
  130. );
  132. #ifdef _MAC_CFM
  133. #pragma export off
  134. #endif
  136. /*
  137.  * Definitions of Function Pointers to CreateEngine() and Close Engine().
  138.  * These types are provided as a convenince to authors of top level clients.
  139.  */
  140. typedef HX_RESULT (HXEXPORT_PTR FPRMCREATEENGINE)(IHXClientEngine** ppEngine);
  141. typedef HX_RESULT (HXEXPORT_PTR FPRMCLOSEENGINE) (IHXClientEngine*  pEngine);
  144. /****************************************************************************
  145.  * 
  146.  *  Interface:
  147.  *
  148.  * IHXStream
  149.  *
  150.  *  Purpose:
  151.  *
  152.  * Interface provided by the client engine to the renderers. This
  153.  * interface allows access to stream related information and properties.
  154.  *
  155.  *  IID_IHXStream:
  156.  *
  157.  * {00000400-0901-11d1-8B06-00A024406D59}
  158.  *
  159.  */
  160. DEFINE_GUID(IID_IHXStream, 0x00000400, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  161. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  163. #undef  INTERFACE
  164. #define INTERFACE   IHXStream
  166. DECLARE_INTERFACE_(IHXStream, IUnknown)
  167. {
  168.     /*
  169.      * IUnknown methods
  170.      */
  171.     STDMETHOD(QueryInterface) (THIS_
  172. REFIID riid,
  173. void** ppvObj) PURE;
  175.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  177.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  179.     /*
  180.      * IHXStream methods
  181.      */
  183.     /************************************************************************
  184.      * Method:
  185.      *     IHXStream::GetSource
  186.      * Purpose:
  187.      *     Get the interface to the source object of which the stream is
  188.      *     a part of.
  189.      *
  190.      */
  191.     STDMETHOD(GetSource) (THIS_
  192. REF(IHXStreamSource*) pSource) PURE;
  194.     /************************************************************************
  195.      * Method:
  196.      *     IHXStream::GetStreamNumber
  197.      * Purpose:
  198.      *     Get the stream number for this stream relative to the source 
  199.      *     object of which the stream is a part of.
  200.      *
  201.      */
  202.     STDMETHOD_(UINT16,GetStreamNumber)     (THIS) PURE;
  204.     /************************************************************************
  205.      * Method:
  206.      *     IHXStream::GetStreamType
  207.      * Purpose:
  208.      *     Get the MIME type for this stream. NOTE: The returned string is
  209.      *     assumed to be valid for the life of the IHXStream from which it
  210.      *     was returned.
  211.      *
  212.      */
  213.     STDMETHOD_(const char*,GetStreamType)   (THIS) PURE;
  215.     /************************************************************************
  216.      * Method:
  217.      *     IHXStream::GetHeader
  218.      * Purpose:
  219.      *      Get the header for this stream.
  220.      *
  221.      */
  222.     STDMETHOD_(IHXValues*,GetHeader)   (THIS) PURE;
  224.     /************************************************************************
  225.      * Method:
  226.      *     IHXStream::ReportQualityOfService
  227.      * Purpose:
  228.      *     Call this method to report to the playback context that the 
  229.      *     quality of service for this stream has changed. The unQuality
  230.      *     should be on a scale of 0 to 100, where 100 is the best possible
  231.      *     quality for this stream. Although the transport engine can 
  232.      *     determine lost packets and report these through the user
  233.      *     interface, only the renderer of this stream can determine the 
  234.      *     "real" perceived damage associated with this loss.
  235.      *
  236.      *     NOTE: The playback context may use this value to indicate loss
  237.      *     in quality to the user interface. When the effects of a lost
  238.      *     packet are eliminated the renderer should call this method with
  239.      *     a unQuality of 100.
  240.      *
  241.      */
  242.     STDMETHOD(ReportQualityOfService)     (THIS_
  243.     UINT8   unQuality) PURE;
  245.     /************************************************************************
  246.      * Method:
  247.      *     IHXStream::ReportRebufferStatus
  248.      * Purpose:
  249.      *     Call this method to report to the playback context that the
  250.      *     available data has dropped to a critically low level, and that
  251.      *     rebuffering should occur. The renderer should call back into this
  252.      *     interface as it receives additional data packets to indicate the
  253.      *     status of its rebuffering effort.
  254.      *
  255.      *     NOTE: The values of unNeeded and unAvailable are used to indicate
  256.      *     the general status of the rebuffering effort. For example, if a
  257.      *     renderer has "run dry" and needs 5 data packets to play smoothly
  258.      *     again, it should call ReportRebufferStatus() with 5,0 then as
  259.      *     packet arrive it should call again with 5,1; 5,2... and eventually
  260.      *     5,5.
  261.      *
  262.      */
  263.     STDMETHOD(ReportRebufferStatus)     (THIS_
  264.     UINT8   unNeeded,
  265.     UINT8   unAvailable) PURE;
  267.     /************************************************************************
  268.      * Method:
  269.      *     IHXStream::SetGranularity
  270.      * Purpose:
  271.      *     Sets the desired Granularity for this stream. The actual 
  272.      *     granularity will be the lowest granularity of all streams.
  273.      *     Valid to call before stream actually begins. Best to call during
  274.      *     IHXRenderer::OnHeader().
  275.      */
  276.     STDMETHOD(SetGranularity)     (THIS_
  277.     ULONG32 ulGranularity) PURE;
  279.     /************************************************************************
  280.      * Method:
  281.      *     IHXStream::GetRendererCount
  282.      * Purpose:
  283.      *     Returns the current number of renderer instances supported by
  284.      *     this stream instance.
  285.      */
  286.     STDMETHOD_(UINT16, GetRendererCount)(THIS) PURE;
  288.     /************************************************************************
  289.      * Method:
  290.      *     IHXStream::GetRenderer
  291.      * Purpose:
  292.      *     Returns the Nth renderer instance supported by this stream.
  293.      */
  294.     STDMETHOD(GetRenderer) (THIS_
  295. UINT16 nIndex,
  296. REF(IUnknown*) pUnknown) PURE;
  297. };
  300. /****************************************************************************
  301.  * 
  302.  *  Interface:
  303.  *
  304.  * IHXStreamSource
  305.  *
  306.  *  Purpose:
  307.  *
  308.  * Interface provided by the client engine to the renderers. This
  309.  * interface allows access to source related information and properties.
  310.  *
  311.  *  IID_IHXStreamSource:
  312.  *
  313.  * {00000401-0901-11d1-8B06-00A024406D59}
  314.  *
  315.  */
  316. DEFINE_GUID(IID_IHXStreamSource, 0x00000401, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  317. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  319. #undef  INTERFACE
  320. #define INTERFACE   IHXStreamSource
  322. DECLARE_INTERFACE_(IHXStreamSource, IUnknown)
  323. {
  324.     /*
  325.      * IUnknown methods
  326.      */
  327.     STDMETHOD(QueryInterface) (THIS_
  328. REFIID riid,
  329. void** ppvObj) PURE;
  331.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  333.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  335.     /*
  336.      * IHXStreamSource methods
  337.      */
  339.     /************************************************************************
  340.      * Method:
  341.      * IHXStreamSource::IsLive
  342.      * Purpose:
  343.      * Ask the source whether it is live
  344.      *
  345.      */
  346.     STDMETHOD_ (BOOL,IsLive) (THIS) PURE;
  348.     /************************************************************************
  349.      * Method:
  350.      *     IHXStreamSource::GetPlayer
  351.      * Purpose:
  352.      *     Get the interface to the player object of which the source is
  353.      *     a part of.
  354.      *
  355.      */
  356.     STDMETHOD(GetPlayer)     (THIS_
  357.     REF(IHXPlayer*) pPlayer) PURE;
  359.     /************************************************************************
  360.      * Method:
  361.      *     IHXStreamSource::GetURL
  362.      * Purpose:
  363.      *     Get the URL for this source. NOTE: The returned string is
  364.      *     assumed to be valid for the life of the IHXStreamSource from which
  365.      *     it was returned.
  366.      *
  367.      */
  368.     STDMETHOD_(const char*,GetURL)  (THIS) PURE;
  370.     /************************************************************************
  371.      * Method:
  372.      *     IHXStreamSource::GetStreamCount
  373.      * Purpose:
  374.      *     Returns the current number of stream instances supported by
  375.      *     this source instance.
  376.      */
  377.     STDMETHOD_(UINT16, GetStreamCount)(THIS) PURE;
  379.     /************************************************************************
  380.      * Method:
  381.      *     IHXStreamSource::GetStream
  382.      * Purpose:
  383.      *     Returns the Nth stream instance supported by this source.
  384.      */
  385.     STDMETHOD(GetStream) (THIS_
  386. UINT16 nIndex,
  387. REF(IUnknown*) pUnknown) PURE;
  388. };
  391. /****************************************************************************
  392.  * 
  393.  *  Interface:
  394.  *
  395.  *   IHXPlayer
  396.  *
  397.  *  Purpose:
  398.  *
  399.  * Interface provided by the client engine to the renderers. This
  400.  * interface allows access to player related information, properties,
  401.  * and operations.
  402.  *
  403.  *  IID_IHXPlayer:
  404.  *
  405.  * {00000402-0901-11d1-8B06-00A024406D59}
  406.  *
  407.  */
  408. DEFINE_GUID(IID_IHXPlayer, 0x00000402, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  409. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  411. #undef  INTERFACE
  412. #define INTERFACE   IHXPlayer
  414. DECLARE_INTERFACE_(IHXPlayer, IUnknown)
  415. {
  416.     /*
  417.      * IUnknown methods
  418.      */
  419.     STDMETHOD(QueryInterface) (THIS_
  420. REFIID riid,
  421. void** ppvObj) PURE;
  423.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  425.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  427.     /*
  428.      * IHXPlayer methods
  429.      */
  431.     /************************************************************************
  432.      * Method:
  433.      * IHXPlayer::GetClientEngine
  434.      * Purpose:
  435.      * Get the interface to the client engine object of which the
  436.      * player is a part of.
  437.      *
  438.      */
  439.     STDMETHOD(GetClientEngine) (THIS_
  440. REF(IHXClientEngine*) pEngine) PURE;
  442.     /************************************************************************
  443.      * Method:
  444.      * IHXPlayer::IsDone
  445.      * Purpose:
  446.      * Ask the player if it is done with the current presentation
  447.      *
  448.      */
  449.     STDMETHOD_(BOOL,IsDone) (THIS) PURE;
  451.     /************************************************************************
  452.      * Method:
  453.      * IHXPlayer::IsLive
  454.      * Purpose:
  455.      * Ask the player whether it contains the live source
  456.      *
  457.      */
  458.     STDMETHOD_(BOOL,IsLive) (THIS) PURE;
  460.     /************************************************************************
  461.      * Method:
  462.      * IHXPlayer::GetCurrentPlayTime
  463.      * Purpose:
  464.      * Get the current time on the Player timeline
  465.      *
  466.      */
  467.     STDMETHOD_(ULONG32,GetCurrentPlayTime) (THIS) PURE;
  469.     /************************************************************************
  470.      * Method:
  471.      * IHXPlayer::OpenURL
  472.      * Purpose:
  473.      * Tell the player to begin playback of all its sources.
  474.      *
  475.      */
  476.     STDMETHOD(OpenURL) (THIS_
  477.     const char* pURL) PURE;
  479.     /************************************************************************
  480.      * Method:
  481.      * IHXPlayer::Begin
  482.      * Purpose:
  483.      * Tell the player to begin playback of all its sources.
  484.      *
  485.      */
  486.     STDMETHOD(Begin) (THIS) PURE;
  488.     /************************************************************************
  489.      * Method:
  490.      * IHXPlayer::Stop
  491.      * Purpose:
  492.      * Tell the player to stop playback of all its sources.
  493.      *
  494.      */
  495.     STDMETHOD(Stop) (THIS) PURE;
  497.     /************************************************************************
  498.      * Method:
  499.      * IHXPlayer::Pause
  500.      * Purpose:
  501.      * Tell the player to pause playback of all its sources.
  502.      *
  503.      */
  504.     STDMETHOD(Pause) (THIS) PURE;
  506.     /************************************************************************
  507.      * Method:
  508.      * IHXPlayer::Seek
  509.      * Purpose:
  510.      * Tell the player to seek in the playback timeline of all its 
  511.      * sources.
  512.      *
  513.      */
  514.     STDMETHOD(Seek) (THIS_
  515. ULONG32 ulTime) PURE;
  517.     /************************************************************************
  518.      * Method:
  519.      *     IHXPlayer::GetSourceCount
  520.      * Purpose:
  521.      *     Returns the current number of source instances supported by
  522.      *     this player instance.
  523.      */
  524.     STDMETHOD_(UINT16, GetSourceCount)(THIS) PURE;
  526.     /************************************************************************
  527.      * Method:
  528.      *     IHXPlayer::GetSource
  529.      * Purpose:
  530.      *     Returns the Nth source instance supported by this player.
  531.      */
  532.     STDMETHOD(GetSource) (THIS_
  533. UINT16 nIndex,
  534. REF(IUnknown*) pUnknown) PURE;
  536.     /************************************************************************
  537.      * Method:
  538.      *     IHXPlayer::SetClientContext
  539.      * Purpose:
  540.      *     Called by the client to install itself as the provider of client
  541.      *     services to the core. This is traditionally called by the top 
  542.      *     level client application.
  543.      */
  544.     STDMETHOD(SetClientContext) (THIS_
  545. IUnknown* pUnknown) PURE;
  547.     /************************************************************************
  548.      * Method:
  549.      *     IHXPlayer::GetClientContext
  550.      * Purpose:
  551.      *     Called to get the client context for this player. This is
  552.      *     set by the top level client application.
  553.      */
  554.     STDMETHOD(GetClientContext) (THIS_
  555. REF(IUnknown*) pUnknown) PURE;
  557.     /************************************************************************
  558.      * Method:
  559.      *     IHXPlayer::AddAdviseSink
  560.      * Purpose:
  561.      *     Call this method to add a client advise sink.
  562.      *
  563.      */
  564.     STDMETHOD(AddAdviseSink) (THIS_
  565. IHXClientAdviseSink* pAdviseSink) PURE;
  567.     /************************************************************************
  568.      * Method:
  569.      *     IHXPlayer::RemoveAdviseSink
  570.      * Purpose:
  571.      *     Call this method to remove a client advise sink.
  572.      */
  573.     STDMETHOD(RemoveAdviseSink) (THIS_
  574. IHXClientAdviseSink* pAdviseSink) PURE;
  575. };
  578. /****************************************************************************
  579.  * 
  580.  *  Interface:
  581.  *
  582.  * IHXClientEngine
  583.  *
  584.  *  Purpose:
  585.  *
  586.  * Interface to the basic client engine. Provided to the renderers and
  587.  * other client side components.
  588.  *
  589.  *  IID_IHXClientEngine:
  590.  *
  591.  * {00000403-0901-11d1-8B06-00A024406D59}
  592.  */
  593. DEFINE_GUID(IID_IHXClientEngine, 0x00000403, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  594. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  596. #undef  INTERFACE
  597. #define INTERFACE   IHXClientEngine
  599. DECLARE_INTERFACE_(IHXClientEngine, IUnknown)
  600. {
  601.     /*
  602.      * IUnknown methods
  603.      */
  604.     STDMETHOD(QueryInterface) (THIS_
  605. REFIID riid,
  606. void** ppvObj) PURE;
  608.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  610.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  612.     /*
  613.      * IHXClientEngine methods
  614.      */
  616.     /************************************************************************
  617.      * Method:
  618.      *     IHXClientEngine::CreatePlayer
  619.      * Purpose:
  620.      *     Creates a new IHXPlayer instance.
  621.      *
  622.      */
  623.     STDMETHOD(CreatePlayer) (THIS_
  624. REF(IHXPlayer*)    pPlayer) PURE;
  626.     /************************************************************************
  627.      * Method:
  628.      *     IHXClientEngine::ClosePlayer
  629.      * Purpose:
  630.      *     Called by the client when it is done using the player...
  631.      *
  632.      */
  633.     STDMETHOD(ClosePlayer) (THIS_
  634. IHXPlayer*    pPlayer) PURE;
  636.     /************************************************************************
  637.      * Method:
  638.      *     IHXClientEngine::GetPlayerCount
  639.      * Purpose:
  640.      *     Returns the current number of IHXPlayer instances supported by
  641.      *     this client engine instance.
  642.      */
  643.     STDMETHOD_(UINT16, GetPlayerCount)(THIS) PURE;
  645.     /************************************************************************
  646.      * Method:
  647.      *     IHXClientEngine::GetPlayer
  648.      * Purpose:
  649.      *     Returns the Nth IHXPlayer instances supported by this client 
  650.      *     engine instance.
  651.      */
  652.     STDMETHOD(GetPlayer) (THIS_
  653. UINT16 nPlayerNumber,
  654. REF(IUnknown*) pUnknown) PURE;
  656.     /************************************************************************
  657.      * Method:
  658.      *     IHXClientEngine::EventOccurred
  659.      * Purpose:
  660.      *     Clients call this to pass OS events to all players. HXxEvent
  661.      *     defines a cross-platform event.
  662.      */
  663.     STDMETHOD(EventOccurred) (THIS_
  664. HXxEvent* /*IN*/ pEvent) PURE;
  666. };
  668. // $Private:
  669. /****************************************************************************
  670.  * 
  671.  *  Interface:
  672.  *
  673.  * IHXClientEngineMapper
  674.  *
  675.  *  Purpose:
  676.  *
  677.  * Interface to the basic client engine. Provided to the renderers and
  678.  * other client side components.
  679.  *
  680.  *  IID_IHXClientEngineMapper:
  681.  *
  682.  * {0000040A-0901-11d1-8B06-00A024406D59}
  683.  */
  684. DEFINE_GUID(IID_IHXClientEngineMapper, 0x0000040A, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  685. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  687. #undef  INTERFACE
  688. #define INTERFACE   IHXClientEngineMapper
  690. DECLARE_INTERFACE_(IHXClientEngineMapper, IUnknown)
  691. {
  692.     /*
  693.      * IUnknown methods
  694.      */
  695.     STDMETHOD(QueryInterface) (THIS_
  696. REFIID riid,
  697. void** ppvObj) PURE;
  699.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  701.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  703.     /*
  704.      * IHXClientEngineMapper methods
  705.      */
  707.     /************************************************************************
  708.      * Method:
  709.      *     IHXClientEngineMapper::GetPlayerBySite
  710.      * Purpose:
  711.      *     Returns the IHXPlayer instance supported by this client 
  712.      *     engine instance that contains the specified IHXSite.
  713.      */
  714.     STDMETHOD(GetPlayerBySite) (THIS_
  715. IHXSite* pSite,
  716. REF(IUnknown*) pUnknown) PURE;
  717. };
  718. // $EndPrivate:
  720. #if defined _UNIX && !defined (_VXWORKS)
  721. DEFINE_GUID(IID_IHXClientEngineSelector, 0x00000404, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  722. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  724. #undef  INTERFACE
  725. #define INTERFACE   IHXClientEngineSelector
  727. DECLARE_INTERFACE_(IHXClientEngineSelector, IUnknown)
  728. {
  729.     /*
  730.      * IUnknown methods
  731.      */
  732.     STDMETHOD(QueryInterface) (THIS_
  733. REFIID riid,
  734. void** ppvObj) PURE;
  736.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  738.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  740.     /************************************************************************
  741.      * Method:
  742.      *     IHXClientEngine::Select
  743.      * Purpose:
  744.      *      Top level clients under Unix should use this instead of
  745.      *      select() to select for events.
  746.      */
  747.     STDMETHOD_(INT32, Select) (THIS_
  748.        INT32 n,
  749.        fd_set *readfds,
  750.        fd_set *writefds,
  751.        fd_set *exceptfds,
  752.        struct timeval* timeout) PURE;
  753. };
  754. #endif /* _UNIX */
  756. /****************************************************************************
  757.  * 
  758.  *  Interface:
  759.  *
  760.  * IHXClientEngineSetup
  761.  *
  762.  *  Purpose:
  763.  *
  764.  * Interface to the basic client engine. Provided to the renderers and
  765.  * other client side components.
  766.  *
  767.  *  IID_IHXClientEngineSetup:
  768.  *
  769.  * {00000405-0901-11d1-8B06-00A024406D59}
  770.  */
  771. DEFINE_GUID(IID_IHXClientEngineSetup, 0x00000405, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  772. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  774. #undef  INTERFACE
  775. #define INTERFACE   IHXClientEngineSetup
  777. DECLARE_INTERFACE_(IHXClientEngineSetup, IUnknown)
  778. {
  779.     /*
  780.      * IUnknown methods
  781.      */
  782.     STDMETHOD(QueryInterface) (THIS_
  783. REFIID riid,
  784. void** ppvObj) PURE;
  786.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  788.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  790.     /*
  791.      * IHXClientEngineSetup methods
  792.      */
  794.     /************************************************************************
  795.      * Method:
  796.      *     IHXClientEngineSetup::Setup
  797.      * Purpose:
  798.      *      Top level clients use this interface to over-ride certain basic 
  799.      *     interfaces implemented by the core. Current over-ridable 
  800.      *     interfaces are: IHXPreferences, IHXHyperNavigate
  801.      */
  802.     STDMETHOD(Setup) (THIS_
  803. IUnknown* pContext) PURE;
  804. };
  807. /****************************************************************************
  808.  * 
  809.  *  Interface:
  810.  *
  811.  * IHXInfoLogger
  812.  *
  813.  *  Purpose:
  814.  *
  815.  * Interface to send any logging information back to the server.
  816.  * This information will appear in the server's access log.
  817.  *
  818.  *  IID_IHXInfoLogger:
  819.  *
  820.  * {00000409-0901-11d1-8B06-00A024406D59}
  821.  */
  822. DEFINE_GUID(IID_IHXInfoLogger, 0x00000409, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  823. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  825. #undef  INTERFACE
  826. #define INTERFACE   IHXInfoLogger
  828. DECLARE_INTERFACE_(IHXInfoLogger, IUnknown)
  829. {
  830.     /*
  831.      * IUnknown methods
  832.      */
  833.     STDMETHOD(QueryInterface) (THIS_
  834. REFIID riid,
  835. void** ppvObj) PURE;
  837.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  839.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  841.     /*
  842.      * IHXInfoLogger methods
  843.      */
  845.     /************************************************************************
  846.      * Method:
  847.      *     IHXInfoLogger::LogInformation
  848.      * Purpose:
  849.      *     Logs any user defined information in form of action and 
  850.      *     associated data.
  851.      */
  852.     STDMETHOD(LogInformation) (THIS_
  853. const char* /*IN*/ pAction,
  854. const char* /*IN*/ pData) PURE;
  855. };
  858. // $Private:
  859. /****************************************************************************
  860.  * 
  861.  *  Interface:
  862.  *
  863.  * IHXPersistenceManager
  864.  *
  865.  *  Purpose:
  866.  *
  867.  *
  868.  *  IID_IHXPersistenceManager:
  869.  *
  870.  * {0000040B-0901-11d1-8B06-00A024406D59}
  871.  */
  872. DEFINE_GUID(IID_IHXPersistenceManager, 0x0000040B, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  873. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  875. #undef  INTERFACE
  876. #define INTERFACE   IHXPersistenceManager
  878. DECLARE_INTERFACE_(IHXPersistenceManager, IUnknown)
  879. {
  880.    /*
  881.     *  IUnknown methods
  882.     */
  883.    STDMETHOD(QueryInterface)       (THIS_
  884.                    REFIID riid,
  885.                    void** ppvObj) PURE;
  887.    STDMETHOD_(ULONG32,AddRef)      (THIS) PURE;
  889.    STDMETHOD_(ULONG32,Release)     (THIS) PURE;
  891.    /*
  892.     *  IHXPersistenceManager methods
  893.     */
  894.    /************************************************************************
  895.    *  Method:
  896.    *      IHXPersistenceManager::AddPersistentComponent
  897.    *  Purpose:
  898.    *    We currently allow ONLY IHXRenderer to register itself as a 
  899.    *    persistent component.
  900.    *       Renderer registers itself as a persistent renderer if it wants
  901.    *       to live across group boundaries.
  902.    *       It will not be unloaded until
  903.    *           a) Someone opens the next URL.
  904.    *           b) All the groups within the current presentation have been 
  905.    *              played.
  906.    */
  907.    STDMETHOD(AddPersistentComponent)    (THIS_
  908.                                        IUnknown*  /*IN*/ pComponent) PURE;
  910.    /************************************************************************
  911.    *  Method:
  912.    *      IHXPersistenceManager::RemovePersistentComponent
  913.    *  Purpose:
  914.    *       Remove an earlier registered persistent component.
  915.    */
  916.    STDMETHOD(RemovePersistentComponent) (THIS_
  917.                                        IUnknown*  /*IN*/ pComponent) PURE;
  919.    /************************************************************************
  920.    *  Method:
  921.    *      IHXPersistenceManager::GetPersistentComponent
  922.    *  Purpose:
  923.    *       Return an earlier registered persistent component.
  924.    */
  925.    STDMETHOD(GetPersistentComponent) (THIS_
  926.                                      REF(IUnknown*)  /*OUT*/ pComponent) PURE;
  928. };
  930. /****************************************************************************
  931.  * 
  932.  *  Interface:
  933.  *
  934.  * IHXDriverStreamManager
  935.  *
  936.  *  Purpose:
  937.  * Methods to notify/update driver stream renderer
  938.  *
  939.  *
  940.  *  IID_IHXDriverStreamManager
  941.  *
  942.  * {0000040C-0901-11d1-8B06-00A024406D59}
  943.  */
  944. DEFINE_GUID(IID_IHXDriverStreamManager, 0x0000040C, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  945. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  947. #undef  INTERFACE
  948. #define INTERFACE   IHXDriverStreamManager
  950. DECLARE_INTERFACE_(IHXDriverStreamManager, IUnknown)
  951. {
  952.    /*
  953.     *  IUnknown methods
  954.     */
  955.    STDMETHOD(QueryInterface)       (THIS_
  956.                    REFIID riid,
  957.                    void** ppvObj) PURE;
  959.    STDMETHOD_(ULONG32,AddRef)      (THIS) PURE;
  961.    STDMETHOD_(ULONG32,Release)     (THIS) PURE;
  963.    /*
  964.     *  IHXDriverStreamManager methods
  965.     */
  966.    /************************************************************************
  967.    *  Method:
  968.    *      IHXDriverStreamManager::AddRendererAdviseSink
  969.    *  Purpose:
  970.    *   Add a renderer advise sink 
  971.    * 
  972.    */
  973.    STDMETHOD(AddRendererAdviseSink)      (THIS_
  974.                                    IHXRendererAdviseSink* pSink) PURE;
  976.    /************************************************************************
  977.    *  Method:
  978.    *      IHXDriverStreamManager::SetDriverStreamManager
  979.    *  Purpose:
  980.    *   Remove an advise sink
  981.    * 
  982.    */
  983.    STDMETHOD(RemoveRendererAdviseSink)   (THIS_
  984.                                    IHXRendererAdviseSink* pSink) PURE;
  985. };
  988. /****************************************************************************
  989.  * 
  990.  *  Interface:
  991.  * IHXRendererAdviseSink
  992.  *
  993.  *  Purpose:
  994.  * Provides access to notifications of initialization/changes to
  995.  * renderers in the player.
  996.  *
  997.  *  IID_IHXRendererAdviseSink
  998.  *
  999.  * {0000040D-0901-11d1-8B06-00A024406D59}
  1000.  *
  1001.  */
  1002. DEFINE_GUID(IID_IHXRendererAdviseSink, 0x0000040D, 0x901, 
  1003.             0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1005. #undef  INTERFACE
  1006. #define INTERFACE   IHXRendererAdviseSink
  1008. DECLARE_INTERFACE_(IHXRendererAdviseSink, IUnknown)
  1009. {
  1010.     /*
  1011.      * IUnknown methods
  1012.      */
  1013.     STDMETHOD(QueryInterface) (THIS_
  1014. REFIID riid,
  1015. void** ppvObj) PURE;
  1017.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1019.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1021.     /*
  1022.      * IHXRendererAdviseSink methods
  1023.      */
  1025.     STDMETHOD(TrackDurationSet) (THIS_
  1026. UINT32 ulGroupIndex,
  1027. UINT32 ulTrackIndex,
  1028. UINT32 ulDuration,
  1029. UINT32 ulDelay,
  1030. BOOL   bIsLive) PURE;
  1032.     STDMETHOD(RepeatedTrackDurationSet) (THIS_
  1033. const char*  pID,
  1034. UINT32 ulDuration,
  1035.         BOOL   bIsLive) PURE;
  1037.     STDMETHOD(TrackUpdated) (THIS_
  1038. UINT32 ulGroupIndex,
  1039. UINT32 ulTrackIndex,
  1040. IHXValues* pValues) PURE;
  1042.    /************************************************************************
  1043.    *  Method:
  1044.    *      IHXRendererAdviseSink::RendererInitialized
  1045.    *  Purpose:
  1046.    *   Notification of renderer initialization
  1047.    * 
  1048.    */
  1049.     STDMETHOD(RendererInitialized) (THIS_
  1050. IHXRenderer* pRenderer,
  1051. IUnknown* pStream,
  1052. IHXValues* pInfo) PURE;
  1054.    /************************************************************************
  1055.    *  Method:
  1056.    *      IHXRendererAdviseSink::RendererClosed
  1057.    *  Purpose:
  1058.    *   Notification of renderer close
  1059.    * 
  1060.    */
  1061.     STDMETHOD(RendererClosed) (THIS_
  1062. IHXRenderer* pRenderer,
  1063. IHXValues* pInfo) PURE;
  1064. };
  1067. /****************************************************************************
  1068.  * 
  1069.  *  Interface:
  1070.  *
  1071.  * IHXLayoutStream
  1072.  *
  1073.  *  Purpose:
  1074.  *
  1075.  * Interface that allows access/updates to stream properties
  1076.  *
  1077.  *  IID_IHXLayoutStream:
  1078.  *
  1079.  * {0000040E-0901-11d1-8B06-00A024406D59}
  1080.  *
  1081.  */
  1082. DEFINE_GUID(IID_IHXLayoutStream, 0x0000040E, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1083. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1085. #undef  INTERFACE
  1086. #define INTERFACE   IHXLayoutStream
  1088. DECLARE_INTERFACE_(IHXLayoutStream, IUnknown)
  1089. {
  1090.     /*
  1091.      * IUnknown methods
  1092.      */
  1093.     STDMETHOD(QueryInterface) (THIS_
  1094. REFIID riid,
  1095. void** ppvObj) PURE;
  1097.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1099.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1101.     /*
  1102.      * IHXLayoutStream methods
  1103.      */
  1105.     /************************************************************************
  1106.      * Method:
  1107.      *     IHXLayoutStream::GetProperty
  1108.      * Purpose:
  1109.      *     Get layout stream property
  1110.      *     
  1111.      *
  1112.      */
  1113.     STDMETHOD(GetProperties) (THIS_
  1114. REF(IHXValues*) pValue) PURE;
  1116.     /************************************************************************
  1117.      * Method:
  1118.      *     IHXLayoutStream::SetProperty
  1119.      * Purpose:
  1120.      *     Set layout stream property
  1121.      *
  1122.      */
  1123.     STDMETHOD(SetProperties) (THIS_
  1124. IHXValues* pValue) PURE;
  1125. };
  1127. /****************************************************************************
  1128.  * 
  1129.  *  Interface:
  1130.  *
  1131.  * IHXRendererUpgrade
  1132.  *
  1133.  *  Purpose:
  1134.  *
  1135.  * Interface that tells the player to upgrade a particular set of renderers
  1136.  *
  1137.  *  IID_IHXRendererUpgrade:
  1138.  *
  1139.  * {00000410-0901-11d1-8B06-00A024406D59}
  1140.  *
  1141.  */
  1142. DEFINE_GUID(IID_IHXRendererUpgrade, 0x00000410, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1143. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1145. #undef  INTERFACE
  1146. #define INTERFACE   IHXRendererUpgrade
  1148. DECLARE_INTERFACE_(IHXRendererUpgrade, IUnknown)
  1149. {
  1150.     /*
  1151.      * IUnknown methods
  1152.      */
  1153.     STDMETHOD(QueryInterface) (THIS_
  1154. REFIID riid,
  1155. void** ppvObj) PURE;
  1157.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1159.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1161.     /*
  1162.      * IHXRendererUpgrade methods
  1163.      */
  1165.     /************************************************************************
  1166.      * Method:
  1167.      *     IHXRendererUpgrade::IsRendererAvailable
  1168.      * Purpose:
  1169.      *     Find out if the renderer is already loaded
  1170.      *     
  1171.      *
  1172.      */
  1173.     STDMETHOD_(BOOL,IsRendererAvailable) (THIS_
  1174. const char* pMimeType) PURE;
  1176.     /************************************************************************
  1177.      * Method:
  1178.      *     IHXRendererUpgrade::ForceUpgrade
  1179.      * Purpose:
  1180.      *     Force an upgrade for any unloaded renderers
  1181.      *
  1182.      */
  1183.     STDMETHOD(ForceUpgrade) (THIS) PURE;
  1184. };
  1186. /****************************************************************************
  1187.  * 
  1188.  *  Interface:
  1189.  *
  1190.  * IHXValidator
  1191.  *
  1192.  *  Purpose:
  1193.  *
  1194.  * Interface that provides validation
  1195.  *
  1196.  *  IID_IHXValidator:
  1197.  *
  1198.  * {00000412-0901-11d1-8B06-00A024406D59}
  1199.  *
  1200.  */
  1201. DEFINE_GUID(IID_IHXValidator, 0x00000412, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1202. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1204. #undef  INTERFACE
  1205. #define INTERFACE   IHXValidator
  1207. DECLARE_INTERFACE_(IHXValidator, IUnknown)
  1208. {
  1209.     /*
  1210.      * IUnknown methods
  1211.      */
  1212.     STDMETHOD(QueryInterface) (THIS_
  1213. REFIID riid,
  1214. void** ppvObj) PURE;
  1216.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1218.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1220.     /*
  1221.      * IHXValidator methods
  1222.      */
  1224.     /************************************************************************
  1225.      * Method:
  1226.      *     IHXValidator::ValidateProtocol
  1227.      * Purpose:
  1228.      *     Find out if the protocol is valid
  1229.      *     
  1230.      *
  1231.      */
  1232.     STDMETHOD_(BOOL,ValidateProtocol) (THIS_
  1233.  char* pProtocol) PURE;
  1235.     /************************************************************************
  1236.      * Method:
  1237.      *     IHXValidator::ValidateMetaFile
  1238.      * Purpose:
  1239.      *     Find out if it is a meta file
  1240.      *     
  1241.      *
  1242.      */
  1243.     STDMETHOD(ValidateMetaFile) (THIS_
  1244.  IHXRequest* pRequest,
  1245.  IHXBuffer* pContent) PURE;
  1246. };
  1248. /****************************************************************************
  1249.  * 
  1250.  *  Interface:
  1251.  *
  1252.  * IHXPrivateStreamSource
  1253.  *
  1254.  *  Purpose:
  1255.  * This interface is being added for the sole purpose of implementing 
  1256.  * IsSaveAllowed on our stream source objects.  We need to get this in
  1257.  * for alpha-3 of the player, since it would be very bad to put out a 
  1258.  * player version that allowed recording of content that was supposed to
  1259.  * be unrecordable.  This method should be moved into IHXStreamSource
  1260.  * as soon as is convenient.
  1261.  *
  1262.  *  IHXPrivateStreamSource:
  1263.  *
  1264.  *  {57DFD0E2-C76E-11d1-8B5C-006008065552}
  1265.  *
  1266.  */
  1267.  
  1268. DEFINE_GUID(IID_IHXPrivateStreamSource, 0x57dfd0e2, 0xc76e, 0x11d1, 0x8b, 0x5c, 
  1269. 0x0, 0x60, 0x8, 0x6, 0x55, 0x52);
  1271. #undef  INTERFACE
  1272. #define INTERFACE   IHXPrivateStreamSource
  1274. DECLARE_INTERFACE_(IHXPrivateStreamSource, IUnknown)
  1275. {
  1276.     /*
  1277.      * IUnknown methods
  1278.      */
  1279.     STDMETHOD(QueryInterface) (THIS_
  1280. REFIID riid,
  1281. void** ppvObj) PURE;
  1283.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1285.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1287.     /*
  1288.      * IHXPrivateStreamSource methods
  1289.      */
  1292.     STDMETHOD_ (BOOL,IsSaveAllowed) (THIS) PURE;
  1294. };
  1296. // $EndPrivate.
  1298. /****************************************************************************
  1299.  * 
  1300.  *  Interface:
  1301.  *
  1302.  * IHXPlayer2
  1303.  *
  1304.  *  Purpose:
  1305.  *
  1306.  * Extra methods in addition to IHXPlayer
  1307.  *
  1308.  *  IID_IHXPlayer2:
  1309.  *
  1310.  * {00000411-0901-11d1-8B06-00A024406D59}
  1311.  *
  1312.  */
  1313. DEFINE_GUID(IID_IHXPlayer2, 0x00000411, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1314. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1316. #undef  INTERFACE
  1317. #define INTERFACE   IHXPlayer2
  1319. DECLARE_INTERFACE_(IHXPlayer2, IUnknown)
  1320. {
  1321.     /*
  1322.      * IUnknown methods
  1323.      */
  1324.     STDMETHOD(QueryInterface) (THIS_
  1325. REFIID riid,
  1326. void** ppvObj) PURE;
  1328.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1330.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1332.     /************************************************************************
  1333.      * Method:
  1334.      *     IID_IHXPlayer2::SetMinimumPreroll
  1335.      * Purpose:
  1336.      *     Call this method to set the minimum preroll of this clip
  1337.      */
  1338.     STDMETHOD(SetMinimumPreroll) (THIS_
  1339. UINT32 ulMinPreroll) PURE;
  1341.     /************************************************************************
  1342.      * Method:
  1343.      *     IID_IHXPlayer2::GetMinimumPreroll
  1344.      * Purpose:
  1345.      *     Call this method to get the minimum preroll of this clip
  1346.      */
  1347.     STDMETHOD(GetMinimumPreroll) (THIS_
  1348. REF(UINT32) ulMinPreroll) PURE;
  1350.     /************************************************************************
  1351.      * Method:
  1352.      *     IID_IHXPlayer2::OpenRequest
  1353.      * Purpose:
  1354.      *     Call this method to open the IHXRequest
  1355.      */
  1356.     STDMETHOD(OpenRequest) (THIS_
  1357.     IHXRequest* pRequest) PURE;
  1359.     /************************************************************************
  1360.      * Method:
  1361.      *     IID_IHXPlayer2::GetRequest
  1362.      * Purpose:
  1363.      *     Call this method to get the IHXRequest
  1364.      */
  1365.     STDMETHOD(GetRequest) (THIS_
  1366.    REF(IHXRequest*) pRequest) PURE;
  1367. };
  1369. // $Private:
  1370. /****************************************************************************
  1371.  * 
  1372.  *  Interface:
  1373.  *
  1374.  * IHXUpdateProperties
  1375.  *
  1376.  *  Purpose:
  1377.  *
  1378.  * update any offset related stuff
  1379.  *
  1380.  *  IID_IHXUpdateProperties:
  1381.  *
  1382.  * {00000413-0901-11d1-8B06-00A024406D59}
  1383.  *
  1384.  */
  1385. DEFINE_GUID(IID_IHXUpdateProperties, 0x00000413, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1386. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1388. #undef  INTERFACE
  1389. #define INTERFACE   IHXUpdateProperties
  1391. DECLARE_INTERFACE_(IHXUpdateProperties, IUnknown)
  1392. {
  1393.     /*
  1394.      * IUnknown methods
  1395.      */
  1396.     STDMETHOD(QueryInterface) (THIS_
  1397. REFIID riid,
  1398. void** ppvObj) PURE;
  1400.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1402.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1404.     /************************************************************************
  1405.      * Method:
  1406.      *     IHXUpdateProperties::UpdatePacketTimeOffset
  1407.      * Purpose:
  1408.      *     Call this method to update the timestamp offset of cached packets
  1409.      */
  1410.     STDMETHOD(UpdatePacketTimeOffset) (THIS_
  1411.        INT32 lTimeOffset) PURE;
  1413.     /************************************************************************
  1414.      * Method:
  1415.      *     IHXUpdateProperties::UpdatePlayTimes
  1416.      * Purpose:
  1417.      *     Call this method to update properties
  1418.      */
  1419.     STDMETHOD(UpdatePlayTimes)       (THIS_
  1420.        IHXValues* pProps) PURE;
  1421. };
  1422. // $EndPrivate.
  1424. /****************************************************************************
  1425.  * 
  1426.  *  Interface:
  1427.  *
  1428.  * IHXPlayerNavigator
  1429.  *
  1430.  *  Purpose:
  1431.  *
  1432.  * navigate player objects
  1433.  *
  1434.  *  IID_IHXPlayerNavigator:
  1435.  *
  1436.  * {00000414-0901-11d1-8B06-00A024406D59}
  1437.  *
  1438.  */
  1439. DEFINE_GUID(IID_IHXPlayerNavigator, 0x00000414, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1440. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1442. #undef  INTERFACE
  1443. #define INTERFACE   IHXPlayerNavigator
  1445. DECLARE_INTERFACE_(IHXPlayerNavigator, IUnknown)
  1446. {
  1447.     /*
  1448.      * IUnknown methods
  1449.      */
  1450.     STDMETHOD(QueryInterface) (THIS_
  1451. REFIID riid,
  1452. void** ppvObj) PURE;
  1454.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1456.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1458.     /************************************************************************
  1459.      * Method:
  1460.      *     IHXPlayerNavigator::AddChildPlayer
  1461.      * Purpose:
  1462.      *     Add child player to the current player
  1463.      */
  1464.     STDMETHOD(AddChildPlayer)     (THIS_
  1465.     IHXPlayer* pPlayer) PURE;
  1467.     /************************************************************************
  1468.      * Method:
  1469.      *     IHXPlayerNavigator::RemoveChildPlayer
  1470.      * Purpose:
  1471.      *     Remove child player from the current player
  1472.      */
  1473.     STDMETHOD(RemoveChildPlayer)    (THIS_
  1474.     IHXPlayer* pPlayer) PURE;
  1476.     /************************************************************************
  1477.      * Method:
  1478.      *     IHXPlayerNavigator::GetNumChildPlayer
  1479.      * Purpose:
  1480.      *     Get number of the child players
  1481.      */
  1482.     STDMETHOD_(UINT16, GetNumChildPlayer)    (THIS) PURE;
  1484.     /************************************************************************
  1485.      * Method:
  1486.      *     IHXPlayerNavigator::GetChildPlayer
  1487.      * Purpose:
  1488.      *     Get Nth child player
  1489.      */
  1490.     STDMETHOD(GetChildPlayer)     (THIS_
  1491.     UINT16 uPlayerIndex,
  1492.     REF(IHXPlayer*) pPlayer) PURE;
  1494.     /************************************************************************
  1495.      * Method:
  1496.      *     IHXPlayerNavigator::SetParentPlayer
  1497.      * Purpose:
  1498.      *     Set the parent player
  1499.      */
  1500.     STDMETHOD(SetParentPlayer)     (THIS_
  1501.     IHXPlayer* pPlayer) PURE;
  1503.     /************************************************************************
  1504.      * Method:
  1505.      *     IHXPlayerNavigator::RemoveParentPlayer
  1506.      * Purpose:
  1507.      *     Remove the parent player
  1508.      */
  1509.     STDMETHOD(RemoveParentPlayer)   (THIS_
  1510.     IHXPlayer* pPlayer) PURE;
  1512.     /************************************************************************
  1513.      * Method:
  1514.      *     IHXPlayerNavigator::GetParentPlayer
  1515.      * Purpose:
  1516.      *     Get the parent player
  1517.      */
  1518.     STDMETHOD(GetParentPlayer)     (THIS_
  1519.     REF(IHXPlayer*) pPlayer) PURE;
  1520. };
  1522. // $Private:
  1523. /****************************************************************************
  1524.  * 
  1525.  *  Interface:
  1526.  *
  1527.  * IHXPersistentComponentManager
  1528.  *
  1529.  *  Purpose:
  1530.  *
  1531.  * persistent component manager
  1532.  *
  1533.  *  IID_IHXPersistentComponentManager
  1534.  *
  1535.  * {00000415-0901-11d1-8B06-00A024406D59}
  1536.  *
  1537.  */
  1538. DEFINE_GUID(IID_IHXPersistentComponentManager, 0x00000415, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1539. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1541. #undef  INTERFACE
  1542. #define INTERFACE   IHXPersistentComponentManager
  1544. DECLARE_INTERFACE_(IHXPersistentComponentManager, IUnknown)
  1545. {
  1546.     /*
  1547.      * IUnknown methods
  1548.      */
  1549.     STDMETHOD(QueryInterface) (THIS_
  1550. REFIID riid,
  1551. void** ppvObj) PURE;
  1553.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1555.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1557.     /************************************************************************
  1558.      * Method:
  1559.      *     IHXPersistentComponentManager::CreatePersistentComponent
  1560.      * Purpose:
  1561.      *     create persistent component
  1562.      */
  1563.     STDMETHOD(CreatePersistentComponent)    (THIS_
  1564.     REF(IHXPersistentComponent*)   pPersistentComponent) PURE;
  1567.     /************************************************************************
  1568.      * Method:
  1569.      *     IHXPersistentComponentManager::AddPersistentComponent
  1570.      * Purpose:
  1571.      *     add persistent component
  1572.      */
  1573.     STDMETHOD(AddPersistentComponent)     (THIS_
  1574.     IHXPersistentComponent* pPersistentComponent) PURE;
  1576.     /************************************************************************
  1577.      * Method:
  1578.      *     IHXPersistentComponentManager::RemovePersistentComponent
  1579.      * Purpose:
  1580.      *     remove persistent component
  1581.      */
  1582.     STDMETHOD(RemovePersistentComponent)    (THIS_
  1583.     UINT32 ulPersistentComponentID) PURE;
  1585.     /************************************************************************
  1586.      * Method:
  1587.      *     IHXPersistentComponentManager::GetPersistentComponentInfo
  1588.      * Purpose:
  1589.      *     get persistent component information
  1590.      */
  1591.     STDMETHOD(GetPersistentComponent)     (THIS_
  1592.     UINT32     ulPersistentComponentID,
  1593.     REF(IHXPersistentComponent*)   pPersistentComponent) PURE;
  1595.     /************************************************************************
  1596.      * Method:
  1597.      *     IHXPersistentComponentManager::AttachPersistentComponentLayout
  1598.      * Purpose:
  1599.      *     get persistent component information
  1600.      */
  1601.     STDMETHOD(AttachPersistentComponentLayout) (THIS_
  1602. IUnknown*   pLSG,
  1603. IHXValues* pProps) PURE;
  1604. };
  1606. /****************************************************************************
  1607.  * 
  1608.  *  Interface:
  1609.  *
  1610.  * IHXPersistentComponent
  1611.  *
  1612.  *  Purpose:
  1613.  *
  1614.  * persistent component
  1615.  *
  1616.  *  IID_IHXPersistentComponent
  1617.  *
  1618.  * {00000416-0901-11d1-8B06-00A024406D59}
  1619.  *
  1620.  */
  1621. DEFINE_GUID(IID_IHXPersistentComponent, 0x00000416, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1622. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1624. #undef  INTERFACE
  1625. #define INTERFACE   IHXPersistentComponent
  1627. DECLARE_INTERFACE_(IHXPersistentComponent, IUnknown)
  1628. {
  1629.     /*
  1630.      * IUnknown methods
  1631.      */
  1632.     STDMETHOD(QueryInterface) (THIS_
  1633. REFIID riid,
  1634. void** ppvObj) PURE;
  1636.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1638.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1640.     /************************************************************************
  1641.      * Method:
  1642.      *     IHXPersistentComponent::Init
  1643.      * Purpose:
  1644.      *     initialize persistent component
  1645.      */
  1646.     STDMETHOD(Init) (THIS_
  1647.                                 IHXPersistentRenderer* pPersistentRenderer) PURE;
  1649.     /************************************************************************
  1650.      * Method:
  1651.      *     IHXPersistentComponent::AddRendererAdviseSink
  1652.      * Purpose:
  1653.      *     add renderer advise sink
  1654.      */
  1655.     STDMETHOD(AddRendererAdviseSink) (THIS_
  1656.                                 IHXRendererAdviseSink* pSink) PURE;
  1658.     /************************************************************************
  1659.      * Method:
  1660.      *     IHXPersistentComponent::RemoveRendererAdviseSink
  1661.      * Purpose:
  1662.      *     remove renderer advise sink
  1663.      */
  1664.     STDMETHOD(RemoveRendererAdviseSink) (THIS_
  1665.                                 IHXRendererAdviseSink* pSink) PURE;
  1667.     /************************************************************************
  1668.      * Method:
  1669.      *     IHXPersistentComponent::AddGroupSink
  1670.      * Purpose:
  1671.      *     add renderer advise sink
  1672.      */
  1673.     STDMETHOD(AddGroupSink) (THIS_
  1674.                                 IHXGroupSink* pSink) PURE;
  1676.     /************************************************************************
  1677.      * Method:
  1678.      *     IHXPersistentComponent::RemoveGroupSink
  1679.      * Purpose:
  1680.      *     remove renderer advise sink
  1681.      */
  1682.     STDMETHOD(RemoveGroupSink) (THIS_
  1683.                                 IHXGroupSink* pSink) PURE;
  1685.     /************************************************************************
  1686.      * Method:
  1687.      *     IHXPersistentComponent::GetPersistentRenderer
  1688.      * Purpose:
  1689.      *     get persistent renderer
  1690.      */
  1691.     STDMETHOD(GetPersistentRenderer) (THIS_
  1692.                                 REF(IHXPersistentRenderer*) pPersistentRenderer) PURE;
  1694.     /************************************************************************
  1695.      * Method:
  1696.      *     IHXPersistentComponent::GetPersistentProperties
  1697.      * Purpose:
  1698.      *     get persistent component properties
  1699.      */
  1700.     STDMETHOD(GetPersistentProperties) (THIS_
  1701.                                 REF(IHXValues*) pProperties) PURE;
  1702. };
  1704. /****************************************************************************
  1705.  * 
  1706.  *  Interface:
  1707.  *
  1708.  * IID_IHXClientStatisticsGranularity
  1709.  *
  1710.  *  Purpose:
  1711.  *
  1712.  * Enables users to set the Granularity at which statistics are 
  1713.  * gathered. This allows machines under high load to still run
  1714.  * efficiently.
  1715.  *
  1716.  *
  1717.  *  IID_IHXClientStatisticsGranularity
  1718.  *
  1719.  * {00000416-0901-11d1-8B06-00A024406D59}
  1720.  *
  1721.  */
  1722. DEFINE_GUID(IID_IHXClientStatisticsGranularity, 0x00000417, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1723. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1725. #undef  INTERFACE
  1726. #define INTERFACE   IHXClientStatisticsGranularity
  1728. DECLARE_INTERFACE_(IHXClientStatisticsGranularity, IUnknown)
  1729. {
  1730.     /*
  1731.      * IUnknown methods
  1732.      */
  1733.     STDMETHOD(QueryInterface) (THIS_
  1734. REFIID riid,
  1735. void** ppvObj) PURE;
  1737.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1739.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1741.     /************************************************************************
  1742.      * Method:
  1743.      *     IHXClientStatisticsGranularity::SetStatsGranularity
  1744.      * Purpose:
  1745.      *     Set the granularity
  1746.      */
  1747.     STDMETHOD(SetStatsGranularity) (THIS_ ULONG32 ulGranularity) PURE;
  1748. };
  1750. // $EndPrivate.
  1752. // $Private:
  1754. /****************************************************************************
  1755.  * 
  1756.  *  Interface:
  1757.  *
  1758.  * IID_IHXSourceBufferingStats
  1759.  *
  1760.  *  Purpose:
  1761.  *
  1762.  * Enables users to get the current buffering status of the 
  1763.  * given source. 
  1764.  *
  1765.  *
  1766.  *      IID_IHXSourceBufferingStats
  1767.  *
  1768.  * {00000418-0901-11d1-8B06-00A024406D59}
  1769.  *
  1770.  */
  1771. DEFINE_GUID(IID_IHXSourceBufferingStats, 0x00000418, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1772. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1774. #undef  INTERFACE
  1775. #define INTERFACE   IHXSourceBufferingStats
  1777. DECLARE_INTERFACE_(IHXSourceBufferingStats, IUnknown)
  1778. {
  1779.     /************************************************************************
  1780.      * Method:
  1781.      *     IHXSourceBufferingStats::GetCurrentBuffering
  1782.      * Purpose:
  1783.      *     Get the current buffering information
  1784.      */
  1786.     STDMETHOD(GetCurrentBuffering)  (THIS_ UINT16  uStreamNumber,
  1787.      REF(INT64)  llLowestTimestamp, 
  1788.      REF(INT64)  llHighestTimestamp,
  1789.      REF(UINT32) ulNumBytes,
  1790.      REF(BOOL)   bDone) PURE;
  1791. };
  1794. /****************************************************************************
  1795.  * 
  1796.  *  Interface:
  1797.  *
  1798.  * IID_IHXSourceBufferingStats2
  1799.  *
  1800.  *  Purpose:
  1801.  *
  1802.  * Enables users to get the current buffering status of the 
  1803.  * given source. 
  1804.  *
  1805.  *
  1806.  *      IID_IHXSourceBufferingStats2
  1807.  *
  1808.  * {00000418-0901-11d1-8B06-00A024406D5A}
  1809.  *
  1810.  */
  1811. DEFINE_GUID(IID_IHXSourceBufferingStats2, 0x00000418, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1812. 0xa0, 0x24, 0x40, 0x6d, 0x5a);
  1814. #undef  INTERFACE
  1815. #define INTERFACE   IHXSourceBufferingStats2
  1817. DECLARE_INTERFACE_(IHXSourceBufferingStats2, IHXSourceBufferingStats)
  1818. {
  1819.     /************************************************************************
  1820.      * Method:
  1821.      *     IHXSourceBufferingStats2::GetCurrentBuffering
  1822.      * Purpose:
  1823.      *     Get the amount of buffering in the transport
  1824.      */
  1825.     STDMETHOD(GetCurrentBuffering)  (THIS_ UINT16  uStreamNumber,
  1826.      REF(INT64)  llLowestTimestamp, 
  1827.      REF(INT64)  llHighestTimestamp,
  1828.      REF(UINT32) ulNumBytes,
  1829.      REF(BOOL)   bDone) PURE;
  1831.     /************************************************************************
  1832.      * Method:
  1833.      *     IHXSourceBufferingStats2::GetTotalBuffering
  1834.      * Purpose:
  1835.      *     Get the total amount of data buffered for a stream.
  1836.      *      This includes what is in the transport buffer and in
  1837.      *      the renderer
  1838.      */
  1840.     STDMETHOD(GetTotalBuffering)  (THIS_ UINT16  uStreamNumber,
  1841.    REF(INT64)  llLowestTimestamp, 
  1842.    REF(INT64)  llHighestTimestamp,
  1843.    REF(UINT32) ulNumBytes,
  1844.    REF(BOOL)   bDone) PURE;
  1845. };
  1847. // $EndPrivate.
  1849. // $Private:
  1851. /****************************************************************************
  1852.  * 
  1853.  *  Interface:
  1854.  *
  1855.  * IID_IHXPlayerPresentation
  1856.  *
  1857.  *  Purpose:
  1858.  *
  1859.  * Control over the player's current presentation
  1860.  *
  1861.  *      IID_IHXPlayerPresentation
  1862.  *
  1863.  * {6DE011A7-EF05-417b-9367-6FE0E54302D3}
  1864.  *
  1865.  */
  1866. DEFINE_GUID(IID_IHXPlayerPresentation, 0x6de011a7, 0xef05, 0x417b, 0x93, 0x67, 0x6f, 0xe0, 0xe5, 0x43, 0x2, 0xd3);
  1868. #undef  INTERFACE
  1869. #define INTERFACE   IHXPlayerPresentation
  1871. DECLARE_INTERFACE_(IHXPlayerPresentation, IUnknown)
  1872. {
  1873.     /************************************************************************
  1874.      * Method:
  1875.      *     IHXPlayerPresentation::ClosePresentation
  1876.      * Purpose:
  1877.      *     Call this method to close the player's current presentation.  This will free
  1878.      *     all resources associated with the current presentation.
  1879.      */
  1880.     STDMETHOD(ClosePresentation)    (THIS) PURE;
  1881. };
  1883. // $EndPrivate.
  1887. // $Private:
  1889. /****************************************************************************
  1890.  * 
  1891.  *  Interface:
  1892.  *
  1893.  * IID_IHXCoreMutex
  1894.  *
  1895.  *  Purpose:
  1896.  *
  1897.  * Access the core mutex
  1898.  *
  1899.  *      IID_IHXCoreMutex
  1900.  *
  1901.  * {6DE011A7-EF05-417b-9367-6FE0E44404D4}
  1902.  *
  1903.  */
  1904. DEFINE_GUID(IID_IHXCoreMutex, 0x6de011a7, 0xef05, 0x417b, 0x93, 0x67, 0x6f, 0xe0, 0xe4, 0x44, 0x4, 0xd4);
  1906. #undef  INTERFACE
  1907. #define INTERFACE   IHXCoreMutex
  1909. DECLARE_INTERFACE_(IHXCoreMutex, IUnknown)
  1910. {
  1911.     /************************************************************************
  1912.      * Method:
  1913.      *     IHXCoreMutex::LockCoreMutex
  1914.      * Purpose:
  1915.      *      Call this method to lock the client engine's core mutex.
  1916.      */
  1917.     STDMETHOD(LockCoreMutex)    (THIS) PURE;
  1919.     /************************************************************************
  1920.      * Method:
  1921.      *     IHXCoreMutex::UnlockCoreMutex
  1922.      * Purpose:
  1923.      *      Call this method to unlock the client engine's core mutex.
  1924.      */
  1925.     STDMETHOD(UnlockCoreMutex)    (THIS) PURE;
  1926. };
  1929. /****************************************************************************
  1930.  * 
  1931.  *  Interface:
  1932.  *
  1933.  * IID_IHXMacBlitMutex
  1934.  *
  1935.  *  Purpose:
  1936.  *
  1937.  * Access the Mac blitting mutex
  1938.  *
  1939.  * Used for all Mac drawing, in both the core and the tlc. This
  1940.  * mutex prevents quickdraw (and/or the image compression manager)
  1941.  * from re-entering which causes crashes on OS X.
  1942.  *
  1943.  *      IID_IHXCoreMutex
  1944.  *
  1945.  * {294e6de4-fbc6-4c06-bb94-95a969373b4d}
  1946.  *
  1947.  */
  1948. DEFINE_GUID(IID_IHXMacBlitMutex, 0x294e6de4,  0xfbc6,  0x4c06,  0xbb,  0x94,  0x95, 0xa9,  0x69,  0x37,  0x3b,  0x4d);
  1950. #undef  INTERFACE
  1951. #define INTERFACE   IHXMacBlitMutex
  1953. DECLARE_INTERFACE_(IHXMacBlitMutex, IUnknown)
  1954. {
  1955.     /************************************************************************
  1956.      * Method:
  1957.      *     IHXMacBlitMutex::LockMacBlitMutex
  1958.      * Purpose:
  1959.      *      Call this method to lock the client engine's core mutex.
  1960.      */
  1961.     STDMETHOD(LockMacBlitMutex)    (THIS) PURE;
  1963.     /************************************************************************
  1964.      * Method:
  1965.      *     IHXMacBlitMutex::UnlockMacBlitMutex
  1966.      * Purpose:
  1967.      *      Call this method to unlock the client engine's core mutex.
  1968.      */
  1969.     STDMETHOD(UnlockMacBlitMutex)    (THIS) PURE;
  1970. };
  1972. // $EndPrivate.
  1976. #endif /* _HXCORE_H_ */