Home | History | Annotate | Download | only in pvauthor_html
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
      3 <title>MPVPluginBase class Reference</title>
      4 <link href="doxygen.css" rel="stylesheet" type="text/css">
      5 </head><body>
      6 <!-- Generated by Doxygen 1.2.18 -->
      7 <center>
      8 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
      9 <hr><h1>MPVPluginBase Class Reference</h1><code>#include &lt;<a class="el" href="pv__plugin__interfaces_8h-source.html">pv_plugin_interfaces.h</a>&gt;</code>
     10 <p>
     11 <p>Inheritance diagram for MPVPluginBase:
     12 <p><center><img src="classMPVPluginBase.png" usemap="#MPVPluginBase_map" border="0" alt=""></center>
     13 <map name="MPVPluginBase_map">
     14 <area href="classMPVDataSink.html" alt="MPVDataSink" shape="rect" coords="0,56,154,80">
     15 <area href="classMPVDataSource.html" alt="MPVDataSource" shape="rect" coords="164,56,318,80">
     16 <area href="classMPVDataSourceAndSink.html" alt="MPVDataSourceAndSink" shape="rect" coords="328,56,482,80">
     17 </map>
     18 <table border=0 cellpadding=0 cellspacing=0>
     19 <tr><td></td></tr>
     20 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     21 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classMPVPluginBase.html#a0">~MPVPluginBase</a> ()</td></tr>
     22 <tr><td nowrap align=right valign=top>virtual IMPORT_C const RArray&lt;<br>
     23  TPVMIMEType * &gt; &amp;&nbsp;</td><td valign=bottom><a class="el" href="classMPVPluginBase.html#a1">GetMultimediaTypesL</a> () const=0</td></tr>
     24 <tr><td nowrap align=right valign=top>virtual IMPORT_C void&nbsp;</td><td valign=bottom><a class="el" href="classMPVPluginBase.html#a2">QueryUUID</a> (const TPVMIMEType &amp;aMimeType, RArray&lt; TPVUuid &gt; &amp;aUuids, bool aExactUuidsOnly=false)=0</td></tr>
     25 <tr><td nowrap align=right valign=top>virtual IMPORT_C void&nbsp;</td><td valign=bottom><a class="el" href="classMPVPluginBase.html#a3">QueryInterface</a> (const TPVUuid &amp;aUuid, TPVInterfacePtr &amp;aInterfacePtr)=0</td></tr>
     26 </table>
     27 <hr><a name="_details"></a><h2>Detailed Description</h2>
     28 MPVPluginBase Class
     29 <p>
     30 Base class for all supported plugins 
     31 <p>
     32 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     33 <a name="a0" doxytag="MPVPluginBase::~MPVPluginBase"></a><p>
     34 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     35   <tr>
     36     <td class="md">
     37       <table cellpadding="0" cellspacing="0" border="0">
     38         <tr>
     39           <td class="md" nowrap valign="top"> virtual MPVPluginBase::~MPVPluginBase </td>
     40           <td class="md" valign="top">(&nbsp;</td>
     41           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     42           <td class="md" valign="top">)&nbsp;</td>
     43           <td class="md" nowrap><code> [inline, virtual]</code></td>
     44         </tr>
     45 
     46       </table>
     47     </td>
     48   </tr>
     49 </table>
     50 <table cellspacing=5 cellpadding=0 border=0>
     51   <tr>
     52     <td>
     53       &nbsp;
     54     </td>
     55     <td>
     56 
     57 <p>
     58     </td>
     59   </tr>
     60 </table>
     61 <hr><h2>Member Function Documentation</h2>
     62 <a name="a1" doxytag="MPVPluginBase::GetMultimediaTypesL"></a><p>
     63 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     64   <tr>
     65     <td class="md">
     66       <table cellpadding="0" cellspacing="0" border="0">
     67         <tr>
     68           <td class="md" nowrap valign="top"> virtual IMPORT_C const RArray&lt;TPVMIMEType *&gt;&amp; MPVPluginBase::GetMultimediaTypesL </td>
     69           <td class="md" valign="top">(&nbsp;</td>
     70           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     71           <td class="md" valign="top">)&nbsp;</td>
     72           <td class="md" nowrap><code> [pure virtual]</code></td>
     73         </tr>
     74 
     75       </table>
     76     </td>
     77   </tr>
     78 </table>
     79 <table cellspacing=5 cellpadding=0 border=0>
     80   <tr>
     81     <td>
     82       &nbsp;
     83     </td>
     84     <td>
     85 
     86 <p>
     87 This API returns multimedias type supported by the data source/sink - Audio, Video, Data etc. Each supported type is indicated by a MIME type structure. <dl compact><dt><b>Returns: </b></dt><dd>
     88 Multimedia types supported by the data source/sink. The reference is valid until the MPVPluginBase derived object is destroyed. </dl>    </td>
     89   </tr>
     90 </table>
     91 <a name="a3" doxytag="MPVPluginBase::QueryInterface"></a><p>
     92 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     93   <tr>
     94     <td class="md">
     95       <table cellpadding="0" cellspacing="0" border="0">
     96         <tr>
     97           <td class="md" nowrap valign="top"> virtual IMPORT_C void MPVPluginBase::QueryInterface </td>
     98           <td class="md" valign="top">(&nbsp;</td>
     99           <td class="md" nowrap valign="top">const TPVUuid &amp;&nbsp;</td>
    100           <td class="mdname" nowrap>&nbsp; <em>aUuid</em>, </td>
    101         </tr>
    102         <tr>
    103           <td></td>
    104           <td></td>
    105           <td class="md" nowrap>TPVInterfacePtr &amp;&nbsp;</td>
    106           <td class="mdname" nowrap>&nbsp; <em>aInterfacePtr</em></td>
    107         </tr>
    108         <tr>
    109           <td></td>
    110           <td class="md">)&nbsp;</td>
    111           <td class="md" colspan="2"><code> [pure virtual]</code></td>
    112         </tr>
    113 
    114       </table>
    115     </td>
    116   </tr>
    117 </table>
    118 <table cellspacing=5 cellpadding=0 border=0>
    119   <tr>
    120     <td>
    121       &nbsp;
    122     </td>
    123     <td>
    124 
    125 <p>
    126 This API is to allow for extensibility of the plugin interface. It allows a caller to ask for an instance of a particular interface object to be returned. The mechanism is analogous to the COM IUnknown method. The interfaces are identified with an interface ID that is a UUID as in DCE and a pointer to the interface object is returned if it is supported. Otherwise the returned pointer is NULL. TBD: Define the UIID, InterfacePtr structures <dl compact><dt><b>Parameters: </b></dt><dd>
    127 <table border=0 cellspacing=2 cellpadding=0>
    128 <tr><td valign=top><em>aUuid</em>&nbsp;</td><td>
    129 The UUID of the desired interface </td></tr>
    130 <tr><td valign=top><em>aInterfacePtr</em>&nbsp;</td><td>
    131 The output pointer to the desired interface </td></tr>
    132 </table>
    133 </dl>    </td>
    134   </tr>
    135 </table>
    136 <a name="a2" doxytag="MPVPluginBase::QueryUUID"></a><p>
    137 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    138   <tr>
    139     <td class="md">
    140       <table cellpadding="0" cellspacing="0" border="0">
    141         <tr>
    142           <td class="md" nowrap valign="top"> virtual IMPORT_C void MPVPluginBase::QueryUUID </td>
    143           <td class="md" valign="top">(&nbsp;</td>
    144           <td class="md" nowrap valign="top">const TPVMIMEType &amp;&nbsp;</td>
    145           <td class="mdname" nowrap>&nbsp; <em>aMimeType</em>, </td>
    146         </tr>
    147         <tr>
    148           <td></td>
    149           <td></td>
    150           <td class="md" nowrap>RArray&lt; TPVUuid &gt; &amp;&nbsp;</td>
    151           <td class="mdname" nowrap>&nbsp; <em>aUuids</em>, </td>
    152         </tr>
    153         <tr>
    154           <td></td>
    155           <td></td>
    156           <td class="md" nowrap>bool&nbsp;</td>
    157           <td class="mdname" nowrap>&nbsp; <em>aExactUuidsOnly</em> = false</td>
    158         </tr>
    159         <tr>
    160           <td></td>
    161           <td class="md">)&nbsp;</td>
    162           <td class="md" colspan="2"><code> [pure virtual]</code></td>
    163         </tr>
    164 
    165       </table>
    166     </td>
    167   </tr>
    168 </table>
    169 <table cellspacing=5 cellpadding=0 border=0>
    170   <tr>
    171     <td>
    172       &nbsp;
    173     </td>
    174     <td>
    175 
    176 <p>
    177 This API is to allow for extensibility of the plugin interface. It allows a caller to ask for all UUIDs associated with a particular MIME type. If interfaces of the requested MIME type are found within the plugin, they are added to the UUIDs array.
    178 <p>
    179 Also added to the UUIDs array will be all interfaces which have the requested MIME type as a base MIME type. This functionality can be turned off.<dl compact><dt><b>Parameters: </b></dt><dd>
    180 <table border=0 cellspacing=2 cellpadding=0>
    181 <tr><td valign=top><em>aMimeType</em>&nbsp;</td><td>
    182 The MIME type of the desired interfaces </td></tr>
    183 <tr><td valign=top><em>aUuids</em>&nbsp;</td><td>
    184 An array to hold the discovered UUIDs </td></tr>
    185 <tr><td valign=top><em>aExactUuidsOnly</em>&nbsp;</td><td>
    186 Turns on/off the retrival of UUIDs with aMimeType as a base type </td></tr>
    187 </table>
    188 </dl>    </td>
    189   </tr>
    190 </table>
    191 <hr>The documentation for this class was generated from the following file:<ul>
    192 <li><a class="el" href="pv__plugin__interfaces_8h-source.html">pv_plugin_interfaces.h</a></ul>
    193 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
    194 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    195 </small></address>
    196 </body>
    197 </html>
    198