blob: d029ae4daede75d31a0aa6f9ac533b98a52e6a92 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>MPVPluginBase class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<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>
<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>
<p>
<p>Inheritance diagram for MPVPluginBase:
<p><center><img src="classMPVPluginBase.png" usemap="#MPVPluginBase_map" border="0" alt=""></center>
<map name="MPVPluginBase_map">
<area href="classMPVDataSink.html" alt="MPVDataSink" shape="rect" coords="0,56,154,80">
<area href="classMPVDataSource.html" alt="MPVDataSource" shape="rect" coords="164,56,318,80">
<area href="classMPVDataSourceAndSink.html" alt="MPVDataSourceAndSink" shape="rect" coords="328,56,482,80">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classMPVPluginBase.html#a0">~MPVPluginBase</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual IMPORT_C const RArray&lt;<br>
TPVMIMEType * &gt; &amp;&nbsp;</td><td valign=bottom><a class="el" href="classMPVPluginBase.html#a1">GetMultimediaTypesL</a> () const=0</td></tr>
<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>
<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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
MPVPluginBase Class
<p>
Base class for all supported plugins
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="MPVPluginBase::~MPVPluginBase"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual MPVPluginBase::~MPVPluginBase </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a1" doxytag="MPVPluginBase::GetMultimediaTypesL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual IMPORT_C const RArray&lt;TPVMIMEType *&gt;&amp; MPVPluginBase::GetMultimediaTypesL </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>
Multimedia types supported by the data source/sink. The reference is valid until the MPVPluginBase derived object is destroyed. </dl> </td>
</tr>
</table>
<a name="a3" doxytag="MPVPluginBase::QueryInterface"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual IMPORT_C void MPVPluginBase::QueryInterface </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TPVUuid &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aUuid</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>TPVInterfacePtr &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aInterfacePtr</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aUuid</em>&nbsp;</td><td>
The UUID of the desired interface </td></tr>
<tr><td valign=top><em>aInterfacePtr</em>&nbsp;</td><td>
The output pointer to the desired interface </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="MPVPluginBase::QueryUUID"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual IMPORT_C void MPVPluginBase::QueryUUID </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TPVMIMEType &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aMimeType</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>RArray&lt; TPVUuid &gt; &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aUuids</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aExactUuidsOnly</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
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.
<p>
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>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aMimeType</em>&nbsp;</td><td>
The MIME type of the desired interfaces </td></tr>
<tr><td valign=top><em>aUuids</em>&nbsp;</td><td>
An array to hold the discovered UUIDs </td></tr>
<tr><td valign=top><em>aExactUuidsOnly</em>&nbsp;</td><td>
Turns on/off the retrival of UUIDs with aMimeType as a base type </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__plugin__interfaces_8h-source.html">pv_plugin_interfaces.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>