Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1HostExt_1_1PluginLoader.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children cc0be37dc9d3
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Vamp::HostExt::PluginLoader Class Reference</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@0 7 <!-- Generated by Doxygen 1.5.5 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@0 29 <h1>Vamp::HostExt::PluginLoader Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginLoader" --><code>#include &lt;<a class="el" href="PluginLoader_8h-source.html">vamp-sdk/hostext/PluginLoader.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31
cannam@0 32 <p>
cannam@0 33 <a href="classVamp_1_1HostExt_1_1PluginLoader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 34 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> SDK documentation.
cannam@0 35 <p>
cannam@0 36 This class is intended to greatly simplify the task of becoming a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin host for any C++ application.<p>
cannam@0 37 Hosts are not required by the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> specification to use the same plugin search path and naming conventions as implemented by this class, and are certainly not required to use this actual class. But we do strongly recommend it.<p>
cannam@0 38 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin SDK. </dd></dl>
cannam@0 39
cannam@0 40 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00069">69</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
cannam@0 41 <table border="0" cellpadding="0" cellspacing="0">
cannam@0 42 <tr><td></td></tr>
cannam@0 43 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
cannam@0 44 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">AdapterFlags</a> { <br>
cannam@0 45 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">ADAPT_INPUT_DOMAIN</a> = 0x01,
cannam@0 46 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139">ADAPT_CHANNEL_COUNT</a> = 0x02,
cannam@0 47 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1">ADAPT_BUFFER_SIZE</a> = 0x04,
cannam@0 48 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08">ADAPT_ALL_SAFE</a> = 0x03,
cannam@0 49 <br>
cannam@0 50 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0">ADAPT_ALL</a> = 0xff
cannam@0 51 <br>
cannam@0 52 }</td></tr>
cannam@0 53
cannam@0 54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">AdapterFlags contains a set of values that may be OR'd together to indicate in which circumstances <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> should use a plugin adapter to make a plugin easier to use for a host that does not want to cater for complex features. <a href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">More...</a><br></td></tr>
cannam@0 55 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a></td></tr>
cannam@0 56
cannam@0 57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". <a href="#473645bbb3ac5c1a0da2f0f482947c4d"></a><br></td></tr>
cannam@0 58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a></td></tr>
cannam@0 59
cannam@0 60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ec450c2928b1ae5318d45972722dd16b" title="Search for all available Vamp plugins, and return a list of them in the order in...">listPlugins()</a>. <a href="#0d48b76e4f995110f53e0feeb23f733a"></a><br></td></tr>
cannam@0 61 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a></td></tr>
cannam@0 62
cannam@0 63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. <a href="#d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><br></td></tr>
cannam@0 64 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@0 65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ec450c2928b1ae5318d45972722dd16b">listPlugins</a> ()</td></tr>
cannam@0 66
cannam@0 67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Search for all available <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugins, and return a list of them in the order in which they were found. <a href="#ec450c2928b1ae5318d45972722dd16b"></a><br></td></tr>
cannam@0 68 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#2154970381343edef629482bdafea7e2">loadPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> key, float inputSampleRate, int adapterFlags=0)</td></tr>
cannam@0 69
cannam@0 70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key. <a href="#2154970381343edef629482bdafea7e2"></a><br></td></tr>
cannam@0 71 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#cc6865d27825c100d7b6f9ed6ecf5207">composePluginKey</a> (std::string libraryName, std::string identifier)</td></tr>
cannam@0 72
cannam@0 73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Given a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#2154970381343edef629482bdafea7e2" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>. <a href="#cc6865d27825c100d7b6f9ed6ecf5207"></a><br></td></tr>
cannam@0 74 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d5c594142ff058bd70e66247d45cd86e">getPluginCategory</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr>
cannam@0 75
cannam@0 76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the category hierarchy for a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key. <a href="#d5c594142ff058bd70e66247d45cd86e"></a><br></td></tr>
cannam@0 77 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#592d6b4c6edaa369407e833f56e4a4de">getLibraryPathForPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr>
cannam@0 78
cannam@0 79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the file path of the dynamic library from which the given plugin will be loaded (if available). <a href="#592d6b4c6edaa369407e833f56e4a4de"></a><br></td></tr>
cannam@0 80 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
cannam@0 81 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#dbb5c8855697a24be890e4f107e26b0e">getInstance</a> ()</td></tr>
cannam@0 82
cannam@0 83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain a pointer to the singleton instance of <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>. <a href="#dbb5c8855697a24be890e4f107e26b0e"></a><br></td></tr>
cannam@0 84 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
cannam@0 85 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#5ab9e0281244bef7976c6c0ce1a55c24">PluginLoader</a> ()</td></tr>
cannam@0 86
cannam@0 87 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#9e092d864efdc0f16c032bfb25e76dea">~PluginLoader</a> ()</td></tr>
cannam@0 88
cannam@0 89 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@0 90 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">m_impl</a></td></tr>
cannam@0 91
cannam@0 92 <tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
cannam@0 93 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aa4eae58ddbadf6537a95dbb6e957187">m_instance</a> = 0</td></tr>
cannam@0 94
cannam@0 95 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
cannam@0 96 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a></td></tr>
cannam@0 97
cannam@0 98 </table>
cannam@0 99 <hr><h2>Member Typedef Documentation</h2>
cannam@0 100 <a class="anchor" name="473645bbb3ac5c1a0da2f0f482947c4d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKey" ref="473645bbb3ac5c1a0da2f0f482947c4d" args="" -->
cannam@0 101 <div class="memitem">
cannam@0 102 <div class="memproto">
cannam@0 103 <table class="memname">
cannam@0 104 <tr>
cannam@0 105 <td class="memname">typedef std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">Vamp::HostExt::PluginLoader::PluginKey</a> </td>
cannam@0 106 </tr>
cannam@0 107 </table>
cannam@0 108 </div>
cannam@0 109 <div class="memdoc">
cannam@0 110
cannam@0 111 <p>
cannam@0 112 PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system".
cannam@0 113 <p>
cannam@0 114 It consists of the lower-cased base name of the plugin library, a colon separator, and the identifier string for the plugin. It is only meaningful in the context of a given plugin path (the one returned by <a class="el" href="classVamp_1_1PluginHostAdapter.html#08d7ed3a11bf4a3c30fa0f9b41a0fed6">PluginHostAdapter::getPluginPath()</a>).<p>
cannam@0 115 Use <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#cc6865d27825c100d7b6f9ed6ecf5207" title="Given a Vamp plugin library name and plugin identifier, return the corresponding...">composePluginKey()</a> to construct a plugin key from a known plugin library name and identifier.<p>
cannam@0 116 Note: the fact that the library component of the key is lower-cased implies that library names are matched case-insensitively by the <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> class, regardless of the case sensitivity of the underlying filesystem. (<a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a> identifiers _are_ case sensitive, however.) Also, it is not possible to portably extract a working library name from a plugin key, as the result may fail on case-sensitive filesystems. Use <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#592d6b4c6edaa369407e833f56e4a4de" title="Return the file path of the dynamic library from which the given plugin will be loaded...">getLibraryPathForPlugin()</a> instead.
cannam@0 117 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00098">98</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
cannam@0 118
cannam@0 119 </div>
cannam@0 120 </div><p>
cannam@0 121 <a class="anchor" name="0d48b76e4f995110f53e0feeb23f733a"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKeyList" ref="0d48b76e4f995110f53e0feeb23f733a" args="" -->
cannam@0 122 <div class="memitem">
cannam@0 123 <div class="memproto">
cannam@0 124 <table class="memname">
cannam@0 125 <tr>
cannam@0 126 <td class="memname">typedef std::vector&lt;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&gt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">Vamp::HostExt::PluginLoader::PluginKeyList</a> </td>
cannam@0 127 </tr>
cannam@0 128 </table>
cannam@0 129 </div>
cannam@0 130 <div class="memdoc">
cannam@0 131
cannam@0 132 <p>
cannam@0 133 PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ec450c2928b1ae5318d45972722dd16b" title="Search for all available Vamp plugins, and return a list of them in the order in...">listPlugins()</a>.
cannam@0 134 <p>
cannam@0 135
cannam@0 136 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00104">104</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
cannam@0 137
cannam@0 138 </div>
cannam@0 139 </div><p>
cannam@0 140 <a class="anchor" name="d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginCategoryHierarchy" ref="d6a39aa0c79d8d9209eb0b8dfe9d1364" args="" -->
cannam@0 141 <div class="memitem">
cannam@0 142 <div class="memproto">
cannam@0 143 <table class="memname">
cannam@0 144 <tr>
cannam@0 145 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">Vamp::HostExt::PluginLoader::PluginCategoryHierarchy</a> </td>
cannam@0 146 </tr>
cannam@0 147 </table>
cannam@0 148 </div>
cannam@0 149 <div class="memdoc">
cannam@0 150
cannam@0 151 <p>
cannam@0 152 PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin.
cannam@0 153 <p>
cannam@0 154 This sequence describes the location of a plugin within a category forest, containing the human-readable names of the plugin's category tree root, followed by each of the nodes down to the leaf containing the plugin.<p>
cannam@0 155 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d5c594142ff058bd70e66247d45cd86e" title="Return the category hierarchy for a Vamp plugin, given its identifying key.">getPluginCategory()</a> </dd></dl>
cannam@0 156
cannam@0 157 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00116">116</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
cannam@0 158
cannam@0 159 </div>
cannam@0 160 </div><p>
cannam@0 161 <hr><h2>Member Enumeration Documentation</h2>
cannam@0 162 <a class="anchor" name="ff3ee11692ce25e0dfb904324cbe3494"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::AdapterFlags" ref="ff3ee11692ce25e0dfb904324cbe3494" args="" -->
cannam@0 163 <div class="memitem">
cannam@0 164 <div class="memproto">
cannam@0 165 <table class="memname">
cannam@0 166 <tr>
cannam@0 167 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">Vamp::HostExt::PluginLoader::AdapterFlags</a> </td>
cannam@0 168 </tr>
cannam@0 169 </table>
cannam@0 170 </div>
cannam@0 171 <div class="memdoc">
cannam@0 172
cannam@0 173 <p>
cannam@0 174 AdapterFlags contains a set of values that may be OR'd together to indicate in which circumstances <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a> should use a plugin adapter to make a plugin easier to use for a host that does not want to cater for complex features.
cannam@0 175 <p>
cannam@0 176 The available flags are:<p>
cannam@0 177 ADAPT_INPUT_DOMAIN - If the plugin expects frequency domain input, wrap it in a <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> that automatically converts the plugin to one that expects time-domain input. This enables a host to accommodate time- and frequency-domain plugins without needing to do any conversion itself.<p>
cannam@0 178 ADAPT_CHANNEL_COUNT - Wrap the plugin in a <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> to handle any mismatch between the number of channels of audio the plugin can handle and the number available in the host. This enables a host to use plugins that may require the input to be mixed down to mono, etc., without having to worry about doing that itself.<p>
cannam@0 179 ADAPT_BUFFER_SIZE - Wrap the plugin in a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> permitting the host to provide audio input using any block size, with no overlap, regardless of the plugin's preferred block size (suitable for hosts that read from non-seekable streaming media, for example). This adapter introduces some run-time overhead and also changes the semantics of the plugin slightly (see the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> header documentation for details).<p>
cannam@0 180 ADAPT_ALL_SAFE - Perform all available adaptations that are meaningful for the plugin and "safe". Currently this means to ADAPT_INPUT_DOMAIN if the plugin wants FrequencyDomain input; ADAPT_CHANNEL_COUNT always; and ADAPT_BUFFER_SIZE never.<p>
cannam@0 181 ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.<p>
cannam@0 182 See <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> and <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> for more details of the classes that the loader may use if these flags are set. <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 183 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 184 <tr><td valign="top"><em><a class="anchor" name="ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09"></a><!-- doxytag: member="ADAPT_INPUT_DOMAIN" ref="ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09" args="" -->ADAPT_INPUT_DOMAIN</em>&nbsp;</td><td>
cannam@0 185 </td></tr>
cannam@0 186 <tr><td valign="top"><em><a class="anchor" name="ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139"></a><!-- doxytag: member="ADAPT_CHANNEL_COUNT" ref="ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139" args="" -->ADAPT_CHANNEL_COUNT</em>&nbsp;</td><td>
cannam@0 187 </td></tr>
cannam@0 188 <tr><td valign="top"><em><a class="anchor" name="ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1"></a><!-- doxytag: member="ADAPT_BUFFER_SIZE" ref="ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1" args="" -->ADAPT_BUFFER_SIZE</em>&nbsp;</td><td>
cannam@0 189 </td></tr>
cannam@0 190 <tr><td valign="top"><em><a class="anchor" name="ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08"></a><!-- doxytag: member="ADAPT_ALL_SAFE" ref="ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08" args="" -->ADAPT_ALL_SAFE</em>&nbsp;</td><td>
cannam@0 191 </td></tr>
cannam@0 192 <tr><td valign="top"><em><a class="anchor" name="ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0"></a><!-- doxytag: member="ADAPT_ALL" ref="ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0" args="" -->ADAPT_ALL</em>&nbsp;</td><td>
cannam@0 193 </td></tr>
cannam@0 194 </table>
cannam@0 195 </dl>
cannam@0 196
cannam@0 197 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00166">166</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
cannam@0 198
cannam@0 199 </div>
cannam@0 200 </div><p>
cannam@0 201 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@0 202 <a class="anchor" name="5ab9e0281244bef7976c6c0ce1a55c24"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginLoader" ref="5ab9e0281244bef7976c6c0ce1a55c24" args="()" -->
cannam@0 203 <div class="memitem">
cannam@0 204 <div class="memproto">
cannam@0 205 <table class="memname">
cannam@0 206 <tr>
cannam@0 207 <td class="memname">Vamp::HostExt::PluginLoader::PluginLoader </td>
cannam@0 208 <td>(</td>
cannam@0 209 <td class="paramname"> </td>
cannam@0 210 <td>&nbsp;)&nbsp;</td>
cannam@0 211 <td width="100%"><code> [protected]</code></td>
cannam@0 212 </tr>
cannam@0 213 </table>
cannam@0 214 </div>
cannam@0 215 <div class="memdoc">
cannam@0 216
cannam@0 217 <p>
cannam@0 218
cannam@0 219 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00141">141</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
cannam@0 220
cannam@0 221 <p>References <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
cannam@0 222
cannam@0 223 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00152">getInstance()</a>.</p>
cannam@0 224
cannam@0 225 </div>
cannam@0 226 </div><p>
cannam@0 227 <a class="anchor" name="9e092d864efdc0f16c032bfb25e76dea"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::~PluginLoader" ref="9e092d864efdc0f16c032bfb25e76dea" args="()" -->
cannam@0 228 <div class="memitem">
cannam@0 229 <div class="memproto">
cannam@0 230 <table class="memname">
cannam@0 231 <tr>
cannam@0 232 <td class="memname">Vamp::HostExt::PluginLoader::~PluginLoader </td>
cannam@0 233 <td>(</td>
cannam@0 234 <td class="paramname"> </td>
cannam@0 235 <td>&nbsp;)&nbsp;</td>
cannam@0 236 <td width="100%"><code> [protected, virtual]</code></td>
cannam@0 237 </tr>
cannam@0 238 </table>
cannam@0 239 </div>
cannam@0 240 <div class="memdoc">
cannam@0 241
cannam@0 242 <p>
cannam@0 243
cannam@0 244 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00146">146</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
cannam@0 245
cannam@0 246 <p>References <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
cannam@0 247
cannam@0 248 </div>
cannam@0 249 </div><p>
cannam@0 250 <hr><h2>Member Function Documentation</h2>
cannam@0 251 <a class="anchor" name="dbb5c8855697a24be890e4f107e26b0e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getInstance" ref="dbb5c8855697a24be890e4f107e26b0e" args="()" -->
cannam@0 252 <div class="memitem">
cannam@0 253 <div class="memproto">
cannam@0 254 <table class="memname">
cannam@0 255 <tr>
cannam@0 256 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * Vamp::HostExt::PluginLoader::getInstance </td>
cannam@0 257 <td>(</td>
cannam@0 258 <td class="paramname"> </td>
cannam@0 259 <td>&nbsp;)&nbsp;</td>
cannam@0 260 <td width="100%"><code> [static]</code></td>
cannam@0 261 </tr>
cannam@0 262 </table>
cannam@0 263 </div>
cannam@0 264 <div class="memdoc">
cannam@0 265
cannam@0 266 <p>
cannam@0 267 Obtain a pointer to the singleton instance of <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp...">PluginLoader</a>.
cannam@0 268 <p>
cannam@0 269 Use this to obtain your loader object.
cannam@0 270 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00152">152</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
cannam@0 271
cannam@0 272 <p>References <a class="el" href="PluginLoader_8h-source.html#l00230">m_instance</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00141">PluginLoader()</a>, and <a class="el" href="PluginLoader_8cpp-source.html#l00206">Vamp::HostExt::PluginLoader::Impl::setInstanceToClean()</a>.</p>
cannam@0 273
cannam@0 274 </div>
cannam@0 275 </div><p>
cannam@0 276 <a class="anchor" name="ec450c2928b1ae5318d45972722dd16b"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::listPlugins" ref="ec450c2928b1ae5318d45972722dd16b" args="()" -->
cannam@0 277 <div class="memitem">
cannam@0 278 <div class="memproto">
cannam@0 279 <table class="memname">
cannam@0 280 <tr>
cannam@0 281 <td class="memname">vector&lt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginLoader::PluginKey</a> &gt; Vamp::HostExt::PluginLoader::listPlugins </td>
cannam@0 282 <td>(</td>
cannam@0 283 <td class="paramname"> </td>
cannam@0 284 <td>&nbsp;)&nbsp;</td>
cannam@0 285 <td width="100%"></td>
cannam@0 286 </tr>
cannam@0 287 </table>
cannam@0 288 </div>
cannam@0 289 <div class="memdoc">
cannam@0 290
cannam@0 291 <p>
cannam@0 292 Search for all available <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugins, and return a list of them in the order in which they were found.
cannam@0 293 <p>
cannam@0 294
cannam@0 295 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00165">165</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
cannam@0 296
cannam@0 297 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00212">Vamp::HostExt::PluginLoader::Impl::listPlugins()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
cannam@0 298
cannam@0 299 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00577">printPluginCategoryList()</a>.</p>
cannam@0 300
cannam@0 301 </div>
cannam@0 302 </div><p>
cannam@0 303 <a class="anchor" name="2154970381343edef629482bdafea7e2"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::loadPlugin" ref="2154970381343edef629482bdafea7e2" args="(PluginKey key, float inputSampleRate, int adapterFlags=0)" -->
cannam@0 304 <div class="memitem">
cannam@0 305 <div class="memproto">
cannam@0 306 <table class="memname">
cannam@0 307 <tr>
cannam@0 308 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * Vamp::HostExt::PluginLoader::loadPlugin </td>
cannam@0 309 <td>(</td>
cannam@0 310 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td>
cannam@0 311 <td class="paramname"> <em>key</em>, </td>
cannam@0 312 </tr>
cannam@0 313 <tr>
cannam@0 314 <td class="paramkey"></td>
cannam@0 315 <td></td>
cannam@0 316 <td class="paramtype">float&nbsp;</td>
cannam@0 317 <td class="paramname"> <em>inputSampleRate</em>, </td>
cannam@0 318 </tr>
cannam@0 319 <tr>
cannam@0 320 <td class="paramkey"></td>
cannam@0 321 <td></td>
cannam@0 322 <td class="paramtype">int&nbsp;</td>
cannam@0 323 <td class="paramname"> <em>adapterFlags</em> = <code>0</code></td><td>&nbsp;</td>
cannam@0 324 </tr>
cannam@0 325 <tr>
cannam@0 326 <td></td>
cannam@0 327 <td>)</td>
cannam@0 328 <td></td><td></td><td width="100%"></td>
cannam@0 329 </tr>
cannam@0 330 </table>
cannam@0 331 </div>
cannam@0 332 <div class="memdoc">
cannam@0 333
cannam@0 334 <p>
cannam@0 335 Load a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key.
cannam@0 336 <p>
cannam@0 337 If the plugin could not be loaded, returns 0.<p>
cannam@0 338 The returned plugin should be deleted (using the standard C++ delete keyword) after use.<p>
cannam@0 339 <dl compact><dt><b>Parameters:</b></dt><dd>
cannam@0 340 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 341 <tr><td valign="top"></td><td valign="top"><em>adapterFlags</em>&nbsp;</td><td>a bitwise OR of the values in the AdapterFlags enumeration, indicating under which circumstances an adapter should be used to wrap the original plugin. If adapterFlags is 0, no optional adapters will be used. Otherwise, the returned plugin may be of an adapter class type which will behave identically to the original plugin, apart from any particular features implemented by the adapter itself.</td></tr>
cannam@0 342 </table>
cannam@0 343 </dl>
cannam@0 344 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494" title="AdapterFlags contains a set of values that may be OR&#39;d together to indicate in...">AdapterFlags</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> </dd></dl>
cannam@0 345
cannam@0 346 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00171">171</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
cannam@0 347
cannam@0 348 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00355">Vamp::HostExt::PluginLoader::Impl::loadPlugin()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
cannam@0 349
cannam@0 350 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, <a class="el" href="vamp-simple-host_8cpp-source.html#l00577">printPluginCategoryList()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
cannam@0 351
cannam@0 352 </div>
cannam@0 353 </div><p>
cannam@0 354 <a class="anchor" name="cc6865d27825c100d7b6f9ed6ecf5207"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::composePluginKey" ref="cc6865d27825c100d7b6f9ed6ecf5207" args="(std::string libraryName, std::string identifier)" -->
cannam@0 355 <div class="memitem">
cannam@0 356 <div class="memproto">
cannam@0 357 <table class="memname">
cannam@0 358 <tr>
cannam@0 359 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> Vamp::HostExt::PluginLoader::composePluginKey </td>
cannam@0 360 <td>(</td>
cannam@0 361 <td class="paramtype">std::string&nbsp;</td>
cannam@0 362 <td class="paramname"> <em>libraryName</em>, </td>
cannam@0 363 </tr>
cannam@0 364 <tr>
cannam@0 365 <td class="paramkey"></td>
cannam@0 366 <td></td>
cannam@0 367 <td class="paramtype">std::string&nbsp;</td>
cannam@0 368 <td class="paramname"> <em>identifier</em></td><td>&nbsp;</td>
cannam@0 369 </tr>
cannam@0 370 <tr>
cannam@0 371 <td></td>
cannam@0 372 <td>)</td>
cannam@0 373 <td></td><td></td><td width="100%"></td>
cannam@0 374 </tr>
cannam@0 375 </table>
cannam@0 376 </div>
cannam@0 377 <div class="memdoc">
cannam@0 378
cannam@0 379 <p>
cannam@0 380 Given a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin library name and plugin identifier, return the corresponding plugin key in a form suitable for passing in to <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#2154970381343edef629482bdafea7e2" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>.
cannam@0 381 <p>
cannam@0 382
cannam@0 383 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00244">runPlugin()</a>.</p>
cannam@0 384
cannam@0 385 </div>
cannam@0 386 </div><p>
cannam@0 387 <a class="anchor" name="d5c594142ff058bd70e66247d45cd86e"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getPluginCategory" ref="d5c594142ff058bd70e66247d45cd86e" args="(PluginKey plugin)" -->
cannam@0 388 <div class="memitem">
cannam@0 389 <div class="memproto">
cannam@0 390 <table class="memname">
cannam@0 391 <tr>
cannam@0 392 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginLoader::PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td>
cannam@0 393 <td>(</td>
cannam@0 394 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td>
cannam@0 395 <td class="paramname"> <em>plugin</em> </td>
cannam@0 396 <td>&nbsp;)&nbsp;</td>
cannam@0 397 <td width="100%"></td>
cannam@0 398 </tr>
cannam@0 399 </table>
cannam@0 400 </div>
cannam@0 401 <div class="memdoc">
cannam@0 402
cannam@0 403 <p>
cannam@0 404 Return the category hierarchy for a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin, given its identifying key.
cannam@0 405 <p>
cannam@0 406 If the plugin has no category information, return an empty hierarchy.<p>
cannam@0 407 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as...">PluginCategoryHierarchy</a> </dd></dl>
cannam@0 408
cannam@0 409 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00185">185</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
cannam@0 410
cannam@0 411 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00332">Vamp::HostExt::PluginLoader::Impl::getPluginCategory()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
cannam@0 412
cannam@0 413 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00577">printPluginCategoryList()</a>.</p>
cannam@0 414
cannam@0 415 </div>
cannam@0 416 </div><p>
cannam@0 417 <a class="anchor" name="592d6b4c6edaa369407e833f56e4a4de"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getLibraryPathForPlugin" ref="592d6b4c6edaa369407e833f56e4a4de" args="(PluginKey plugin)" -->
cannam@0 418 <div class="memitem">
cannam@0 419 <div class="memproto">
cannam@0 420 <table class="memname">
cannam@0 421 <tr>
cannam@0 422 <td class="memname">string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td>
cannam@0 423 <td>(</td>
cannam@0 424 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td>
cannam@0 425 <td class="paramname"> <em>plugin</em> </td>
cannam@0 426 <td>&nbsp;)&nbsp;</td>
cannam@0 427 <td width="100%"></td>
cannam@0 428 </tr>
cannam@0 429 </table>
cannam@0 430 </div>
cannam@0 431 <div class="memdoc">
cannam@0 432
cannam@0 433 <p>
cannam@0 434 Return the file path of the dynamic library from which the given plugin will be loaded (if available).
cannam@0 435 <p>
cannam@0 436
cannam@0 437 <p>Definition at line <a class="el" href="PluginLoader_8cpp-source.html#l00191">191</a> of file <a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a>.</p>
cannam@0 438
cannam@0 439 <p>References <a class="el" href="PluginLoader_8cpp-source.html#l00342">Vamp::HostExt::PluginLoader::Impl::getLibraryPathForPlugin()</a>, and <a class="el" href="PluginLoader_8h-source.html#l00227">m_impl</a>.</p>
cannam@0 440
cannam@0 441 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00478">enumeratePlugins()</a>.</p>
cannam@0 442
cannam@0 443 </div>
cannam@0 444 </div><p>
cannam@0 445 <hr><h2>Member Data Documentation</h2>
cannam@0 446 <a class="anchor" name="c12254d823f6d63cb8ce82a07bdcb072"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_impl" ref="c12254d823f6d63cb8ce82a07bdcb072" args="" -->
cannam@0 447 <div class="memitem">
cannam@0 448 <div class="memproto">
cannam@0 449 <table class="memname">
cannam@0 450 <tr>
cannam@0 451 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl.html">Impl</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">Vamp::HostExt::PluginLoader::m_impl</a><code> [protected]</code> </td>
cannam@0 452 </tr>
cannam@0 453 </table>
cannam@0 454 </div>
cannam@0 455 <div class="memdoc">
cannam@0 456
cannam@0 457 <p>
cannam@0 458
cannam@0 459 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00227">227</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
cannam@0 460
cannam@0 461 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00191">getLibraryPathForPlugin()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00185">getPluginCategory()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00165">listPlugins()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00171">loadPlugin()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00141">PluginLoader()</a>, and <a class="el" href="PluginLoader_8cpp-source.html#l00146">~PluginLoader()</a>.</p>
cannam@0 462
cannam@0 463 </div>
cannam@0 464 </div><p>
cannam@0 465 <a class="anchor" name="aa4eae58ddbadf6537a95dbb6e957187"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_instance" ref="aa4eae58ddbadf6537a95dbb6e957187" args="" -->
cannam@0 466 <div class="memitem">
cannam@0 467 <div class="memproto">
cannam@0 468 <table class="memname">
cannam@0 469 <tr>
cannam@0 470 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> * <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aa4eae58ddbadf6537a95dbb6e957187">Vamp::HostExt::PluginLoader::m_instance</a> = 0<code> [static, protected]</code> </td>
cannam@0 471 </tr>
cannam@0 472 </table>
cannam@0 473 </div>
cannam@0 474 <div class="memdoc">
cannam@0 475
cannam@0 476 <p>
cannam@0 477
cannam@0 478 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00230">230</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p>
cannam@0 479
cannam@0 480 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00152">getInstance()</a>.</p>
cannam@0 481
cannam@0 482 </div>
cannam@0 483 </div><p>
cannam@0 484 <hr>The documentation for this class was generated from the following files:<ul>
cannam@0 485 <li><a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a><li><a class="el" href="PluginLoader_8cpp-source.html">PluginLoader.cpp</a></ul>
cannam@0 486 </div>
cannam@0 487 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp;
cannam@0 488 <a href="http://www.doxygen.org/index.html">
cannam@0 489 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 490 </body>
cannam@0 491 </html>