Mercurial > hg > vamp-docs

annotate code-docs/classVamp_1_1HostExt_1_1PluginLoader.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: Vamp::HostExt::PluginLoader Class Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('classVamp_1_1HostExt_1_1PluginLoader.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@1 63 <a href="#pub-types">Public Types</a> &#124;
Chris@1 64 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 65 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
Chris@1 66 <a href="#pro-methods">Protected Member Functions</a> &#124;
Chris@1 67 <a href="#pro-attribs">Protected Attributes</a> &#124;
Chris@6 68 <a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
Chris@6 69 <a href="classVamp_1_1HostExt_1_1PluginLoader-members.html">List of all members</a> </div>
Chris@1 70 <div class="headertitle">
Chris@1 71 <div class="title">Vamp::HostExt::PluginLoader Class Reference</div> </div>
Chris@3 72 </div><!--header-->
Chris@1 73 <div class="contents">
Chris@3 74
Chris@1 75 <p><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html">Vamp</a> SDK documentation.
Chris@1 76 <a href="classVamp_1_1HostExt_1_1PluginLoader.html#details">More...</a></p>
Chris@1 77
Chris@1 78 <p><code>#include &lt;<a class="el" href="PluginLoader_8h_source.html">vamp-hostsdk/PluginLoader.h</a>&gt;</code></p>
Chris@1 79 <table class="memberdecls">
Chris@6 80 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Chris@1 81 Public Types</h2></td></tr>
Chris@6 82 <tr class="memitem:aff3ee11692ce25e0dfb904324cbe3494"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494">AdapterFlags</a> { <br />
Chris@6 83 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09">ADAPT_INPUT_DOMAIN</a> = 0x01,
Chris@6 84 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139">ADAPT_CHANNEL_COUNT</a> = 0x02,
Chris@6 85 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1">ADAPT_BUFFER_SIZE</a> = 0x04,
Chris@6 86 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08">ADAPT_ALL_SAFE</a> = 0x03,
Chris@6 87 <br />
Chris@6 88 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0">ADAPT_ALL</a> = 0xff
Chris@6 89 <br />
Chris@6 90 }<tr class="memdesc:aff3ee11692ce25e0dfb904324cbe3494"><td class="mdescLeft">&#160;</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 plugins using the...">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#aff3ee11692ce25e0dfb904324cbe3494">More...</a><br /></td></tr>
Chris@6 91 </td></tr>
Chris@6 92 <tr class="separator:aff3ee11692ce25e0dfb904324cbe3494"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 93 <tr class="memitem:a473645bbb3ac5c1a0da2f0f482947c4d"><td class="memItemLeft" align="right" valign="top">typedef std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a></td></tr>
Chris@6 94 <tr class="memdesc:a473645bbb3ac5c1a0da2f0f482947c4d"><td class="mdescLeft">&#160;</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="#a473645bbb3ac5c1a0da2f0f482947c4d">More...</a><br /></td></tr>
Chris@6 95 <tr class="separator:a473645bbb3ac5c1a0da2f0f482947c4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 96 <tr class="memitem:a0d48b76e4f995110f53e0feeb23f733a"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a></td></tr>
Chris@6 97 <tr class="memdesc:a0d48b76e4f995110f53e0feeb23f733a"><td class="mdescLeft">&#160;</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#aff51b52bb68aa2934ccf26ad1d284f28" title="Search for all available Vamp plugins, and return a list of them in the order in which they were foun...">listPlugins()</a>. <a href="#a0d48b76e4f995110f53e0feeb23f733a">More...</a><br /></td></tr>
Chris@6 98 <tr class="separator:a0d48b76e4f995110f53e0feeb23f733a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 99 <tr class="memitem:ad6a39aa0c79d8d9209eb0b8dfe9d1364"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a></td></tr>
Chris@6 100 <tr class="memdesc:ad6a39aa0c79d8d9209eb0b8dfe9d1364"><td class="mdescLeft">&#160;</td><td class="mdescRight">PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. <a href="#ad6a39aa0c79d8d9209eb0b8dfe9d1364">More...</a><br /></td></tr>
Chris@6 101 <tr class="separator:ad6a39aa0c79d8d9209eb0b8dfe9d1364"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 102 </table><table class="memberdecls">
Chris@6 103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Chris@1 104 Public Member Functions</h2></td></tr>
Chris@3 105 <tr class="memitem:aff51b52bb68aa2934ccf26ad1d284f28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff51b52bb68aa2934ccf26ad1d284f28">listPlugins</a> ()</td></tr>
Chris@6 106 <tr class="memdesc:aff51b52bb68aa2934ccf26ad1d284f28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search for all available <a class="el" href="namespaceVamp.html">Vamp</a> plugins, and return a list of them in the order in which they were found. <a href="#aff51b52bb68aa2934ccf26ad1d284f28">More...</a><br /></td></tr>
Chris@6 107 <tr class="separator:aff51b52bb68aa2934ccf26ad1d284f28"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 108 <tr class="memitem:a04c207e7c936710d70f31dba36f1773c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a04c207e7c936710d70f31dba36f1773c">listPluginsIn</a> (std::vector&lt; std::string &gt; libraryNames)</td></tr>
Chris@6 109 <tr class="memdesc:a04c207e7c936710d70f31dba36f1773c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search for available <a class="el" href="namespaceVamp.html">Vamp</a> plugins in libraries with the given library names, and return a list of them in the order in which they were found. <a href="#a04c207e7c936710d70f31dba36f1773c">More...</a><br /></td></tr>
Chris@6 110 <tr class="separator:a04c207e7c936710d70f31dba36f1773c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 111 <tr class="memitem:a0bd7c1f000b6e5411cffd908bd77f931"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0bd7c1f000b6e5411cffd908bd77f931">listPluginsNotIn</a> (std::vector&lt; std::string &gt; libraryNames)</td></tr>
Chris@6 112 <tr class="memdesc:a0bd7c1f000b6e5411cffd908bd77f931"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search for available <a class="el" href="namespaceVamp.html">Vamp</a> plugins in libraries other than those with the given library names, and return a list of them in the order in which they were found. <a href="#a0bd7c1f000b6e5411cffd908bd77f931">More...</a><br /></td></tr>
Chris@6 113 <tr class="separator:a0bd7c1f000b6e5411cffd908bd77f931"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 114 <tr class="memitem:a964689eb9688cd7e58e8c82ebb0d305f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a964689eb9688cd7e58e8c82ebb0d305f">loadPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> key, float inputSampleRate, int adapterFlags=0)</td></tr>
Chris@6 115 <tr class="memdesc:a964689eb9688cd7e58e8c82ebb0d305f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. <a href="#a964689eb9688cd7e58e8c82ebb0d305f">More...</a><br /></td></tr>
Chris@6 116 <tr class="separator:a964689eb9688cd7e58e8c82ebb0d305f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 117 <tr class="memitem:acc6865d27825c100d7b6f9ed6ecf5207"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#acc6865d27825c100d7b6f9ed6ecf5207">composePluginKey</a> (std::string libraryName, std::string identifier)</td></tr>
Chris@6 118 <tr class="memdesc:acc6865d27825c100d7b6f9ed6ecf5207"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a <a class="el" href="namespaceVamp.html">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#a964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key. ">loadPlugin()</a>. <a href="#acc6865d27825c100d7b6f9ed6ecf5207">More...</a><br /></td></tr>
Chris@6 119 <tr class="separator:acc6865d27825c100d7b6f9ed6ecf5207"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 120 <tr class="memitem:a52746ea66339ad981b868a031a3b382d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a52746ea66339ad981b868a031a3b382d">getPluginCategory</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr>
Chris@6 121 <tr class="memdesc:a52746ea66339ad981b868a031a3b382d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the category hierarchy for a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. <a href="#a52746ea66339ad981b868a031a3b382d">More...</a><br /></td></tr>
Chris@6 122 <tr class="separator:a52746ea66339ad981b868a031a3b382d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 123 <tr class="memitem:a4bbcb7873e617bbc9f79eade1f90f7ad"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a4bbcb7873e617bbc9f79eade1f90f7ad">getLibraryPathForPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr>
Chris@6 124 <tr class="memdesc:a4bbcb7873e617bbc9f79eade1f90f7ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the file path of the dynamic library from which the given plugin will be loaded (if available). <a href="#a4bbcb7873e617bbc9f79eade1f90f7ad">More...</a><br /></td></tr>
Chris@6 125 <tr class="separator:a4bbcb7873e617bbc9f79eade1f90f7ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 126 </table><table class="memberdecls">
Chris@6 127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Chris@1 128 Static Public Member Functions</h2></td></tr>
Chris@3 129 <tr class="memitem:a1d77fa1d58ee4fee2985b5af02380326"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a1d77fa1d58ee4fee2985b5af02380326">getInstance</a> ()</td></tr>
Chris@6 130 <tr class="memdesc:a1d77fa1d58ee4fee2985b5af02380326"><td class="mdescLeft">&#160;</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 plugins using the...">PluginLoader</a>. <a href="#a1d77fa1d58ee4fee2985b5af02380326">More...</a><br /></td></tr>
Chris@6 131 <tr class="separator:a1d77fa1d58ee4fee2985b5af02380326"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 132 </table><table class="memberdecls">
Chris@6 133 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Chris@1 134 Protected Member Functions</h2></td></tr>
Chris@3 135 <tr class="memitem:a5ab9e0281244bef7976c6c0ce1a55c24"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a5ab9e0281244bef7976c6c0ce1a55c24">PluginLoader</a> ()</td></tr>
Chris@6 136 <tr class="separator:a5ab9e0281244bef7976c6c0ce1a55c24"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 137 <tr class="memitem:ad74ab52bc6aa2514b3a6b3f679fc492c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad74ab52bc6aa2514b3a6b3f679fc492c">~PluginLoader</a> ()</td></tr>
Chris@6 138 <tr class="separator:ad74ab52bc6aa2514b3a6b3f679fc492c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 139 </table><table class="memberdecls">
Chris@6 140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Chris@1 141 Protected Attributes</h2></td></tr>
Chris@3 142 <tr class="memitem:ac12254d823f6d63cb8ce82a07bdcb072"><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">m_impl</a></td></tr>
Chris@6 143 <tr class="separator:ac12254d823f6d63cb8ce82a07bdcb072"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 144 </table><table class="memberdecls">
Chris@6 145 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Chris@1 146 Static Protected Attributes</h2></td></tr>
Chris@3 147 <tr class="memitem:af89caf5f838a586b117c417260b7a116"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#af89caf5f838a586b117c417260b7a116">m_instance</a></td></tr>
Chris@6 148 <tr class="separator:af89caf5f838a586b117c417260b7a116"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 149 </table>
Chris@6 150 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@1 151 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html">Vamp</a> SDK documentation. </p>
Chris@1 152 <p>This class is intended to greatly simplify the task of becoming a <a class="el" href="namespaceVamp.html">Vamp</a> plugin host for any C++ application.</p>
Chris@1 153 <p>Hosts are not required by the <a class="el" href="namespaceVamp.html">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>
Chris@6 154 <p>This class is not thread-safe; use it from a single application thread, or guard access to it with a mutex.</p>
Chris@6 155 <dl class="section note"><dt>Note</dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
Chris@1 156
Chris@6 157 <p class="definition">Definition at line <a class="el" href="PluginLoader_8h_source.html#l00075">75</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
Chris@6 158 </div><h2 class="groupheader">Member Typedef Documentation</h2>
Chris@6 159 <a id="a473645bbb3ac5c1a0da2f0f482947c4d"></a>
Chris@6 160 <h2 class="memtitle"><span class="permalink"><a href="#a473645bbb3ac5c1a0da2f0f482947c4d">&#9670;&nbsp;</a></span>PluginKey</h2>
Chris@6 161
Chris@1 162 <div class="memitem">
Chris@1 163 <div class="memproto">
Chris@1 164 <table class="memname">
Chris@1 165 <tr>
Chris@1 166 <td class="memname">typedef std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">Vamp::HostExt::PluginLoader::PluginKey</a></td>
Chris@1 167 </tr>
Chris@1 168 </table>
Chris@6 169 </div><div class="memdoc">
Chris@1 170
Chris@1 171 <p>PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". </p>
Chris@1 172 <p>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#a09cbfb7903d28f10d6d556c6cb81c5f6">PluginHostAdapter::getPluginPath()</a>).</p>
Chris@1 173 <p>Use <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#acc6865d27825c100d7b6f9ed6ecf5207" title="Given a Vamp plugin library name and plugin identifier, return the corresponding plugin key in a form...">composePluginKey()</a> to construct a plugin key from a known plugin library name and identifier.</p>
Chris@3 174 <p>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 plugins using the...">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 from audio o...">Plugin</a> identifiers <em>are</em> 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#a4bbcb7873e617bbc9f79eade1f90f7ad" title="Return the file path of the dynamic library from which the given plugin will be loaded (if available)...">getLibraryPathForPlugin()</a> instead. </p>
Chris@1 175
Chris@6 176 <p class="definition">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>
Chris@1 177
Chris@1 178 </div>
Chris@1 179 </div>
Chris@6 180 <a id="a0d48b76e4f995110f53e0feeb23f733a"></a>
Chris@6 181 <h2 class="memtitle"><span class="permalink"><a href="#a0d48b76e4f995110f53e0feeb23f733a">&#9670;&nbsp;</a></span>PluginKeyList</h2>
Chris@6 182
Chris@1 183 <div class="memitem">
Chris@1 184 <div class="memproto">
Chris@1 185 <table class="memname">
Chris@1 186 <tr>
Chris@1 187 <td class="memname">typedef std::vector&lt;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&gt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">Vamp::HostExt::PluginLoader::PluginKeyList</a></td>
Chris@1 188 </tr>
Chris@1 189 </table>
Chris@6 190 </div><div class="memdoc">
Chris@1 191
Chris@1 192 <p>PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff51b52bb68aa2934ccf26ad1d284f28" title="Search for all available Vamp plugins, and return a list of them in the order in which they were foun...">listPlugins()</a>. </p>
Chris@1 193
Chris@6 194 <p class="definition">Definition at line <a class="el" href="PluginLoader_8h_source.html#l00110">110</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
Chris@1 195
Chris@1 196 </div>
Chris@1 197 </div>
Chris@6 198 <a id="ad6a39aa0c79d8d9209eb0b8dfe9d1364"></a>
Chris@6 199 <h2 class="memtitle"><span class="permalink"><a href="#ad6a39aa0c79d8d9209eb0b8dfe9d1364">&#9670;&nbsp;</a></span>PluginCategoryHierarchy</h2>
Chris@6 200
Chris@1 201 <div class="memitem">
Chris@1 202 <div class="memproto">
Chris@1 203 <table class="memname">
Chris@1 204 <tr>
Chris@1 205 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">Vamp::HostExt::PluginLoader::PluginCategoryHierarchy</a></td>
Chris@1 206 </tr>
Chris@1 207 </table>
Chris@6 208 </div><div class="memdoc">
Chris@1 209
Chris@1 210 <p>PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. </p>
Chris@1 211 <p>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>
Chris@6 212 <dl class="section see"><dt>See also</dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a52746ea66339ad981b868a031a3b382d" title="Return the category hierarchy for a Vamp plugin, given its identifying key. ">getPluginCategory()</a> </dd></dl>
Chris@1 213
Chris@6 214 <p class="definition">Definition at line <a class="el" href="PluginLoader_8h_source.html#l00122">122</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
Chris@1 215
Chris@1 216 </div>
Chris@1 217 </div>
Chris@6 218 <h2 class="groupheader">Member Enumeration Documentation</h2>
Chris@6 219 <a id="aff3ee11692ce25e0dfb904324cbe3494"></a>
Chris@6 220 <h2 class="memtitle"><span class="permalink"><a href="#aff3ee11692ce25e0dfb904324cbe3494">&#9670;&nbsp;</a></span>AdapterFlags</h2>
Chris@6 221
Chris@1 222 <div class="memitem">
Chris@1 223 <div class="memproto">
Chris@1 224 <table class="memname">
Chris@1 225 <tr>
Chris@1 226 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494">Vamp::HostExt::PluginLoader::AdapterFlags</a></td>
Chris@1 227 </tr>
Chris@1 228 </table>
Chris@6 229 </div><div class="memdoc">
Chris@1 230
Chris@1 231 <p>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 plugins using the...">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. </p>
Chris@1 232 <p>The available flags are:</p>
Chris@1 233 <p>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 into frequency-doma...">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>
Chris@1 234 <p>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 of plugins that...">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>
Chris@1 235 <p>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 a host supplying an...">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 a host supplying an...">PluginBufferingAdapter</a> header documentation for details).</p>
Chris@1 236 <p>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>
Chris@1 237 <p>ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.</p>
Chris@1 238 <p>See <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-doma...">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 of plugins that...">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 a host supplying an...">PluginBufferingAdapter</a> for more details of the classes that the loader may use if these flags are set. </p>
Chris@6 239 <table class="fieldtable">
Chris@6 240 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09"></a>ADAPT_INPUT_DOMAIN&#160;</td><td class="fielddoc"></td></tr>
Chris@6 241 <tr><td class="fieldname"><a id="aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139"></a>ADAPT_CHANNEL_COUNT&#160;</td><td class="fielddoc"></td></tr>
Chris@6 242 <tr><td class="fieldname"><a id="aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1"></a>ADAPT_BUFFER_SIZE&#160;</td><td class="fielddoc"></td></tr>
Chris@6 243 <tr><td class="fieldname"><a id="aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08"></a>ADAPT_ALL_SAFE&#160;</td><td class="fielddoc"></td></tr>
Chris@6 244 <tr><td class="fieldname"><a id="aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0"></a>ADAPT_ALL&#160;</td><td class="fielddoc"></td></tr>
Chris@1 245 </table>
Chris@1 246
Chris@6 247 <p class="definition">Definition at line <a class="el" href="PluginLoader_8h_source.html#l00200">200</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
Chris@1 248
Chris@1 249 </div>
Chris@1 250 </div>
Chris@6 251 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
Chris@6 252 <a id="a5ab9e0281244bef7976c6c0ce1a55c24"></a>
Chris@6 253 <h2 class="memtitle"><span class="permalink"><a href="#a5ab9e0281244bef7976c6c0ce1a55c24">&#9670;&nbsp;</a></span>PluginLoader()</h2>
Chris@6 254
Chris@1 255 <div class="memitem">
Chris@1 256 <div class="memproto">
Chris@6 257 <table class="mlabels">
Chris@6 258 <tr>
Chris@6 259 <td class="mlabels-left">
Chris@1 260 <table class="memname">
Chris@1 261 <tr>
Chris@6 262 <td class="memname">Vamp::HostExt::PluginLoader::PluginLoader </td>
Chris@1 263 <td>(</td>
Chris@1 264 <td class="paramname"></td><td>)</td>
Chris@6 265 <td></td>
Chris@1 266 </tr>
Chris@1 267 </table>
Chris@6 268 </td>
Chris@6 269 <td class="mlabels-right">
Chris@6 270 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 271 </tr>
Chris@6 272 </table>
Chris@6 273 </div><div class="memdoc">
Chris@1 274
Chris@1 275 </div>
Chris@1 276 </div>
Chris@6 277 <a id="ad74ab52bc6aa2514b3a6b3f679fc492c"></a>
Chris@6 278 <h2 class="memtitle"><span class="permalink"><a href="#ad74ab52bc6aa2514b3a6b3f679fc492c">&#9670;&nbsp;</a></span>~PluginLoader()</h2>
Chris@6 279
Chris@1 280 <div class="memitem">
Chris@1 281 <div class="memproto">
Chris@6 282 <table class="mlabels">
Chris@6 283 <tr>
Chris@6 284 <td class="mlabels-left">
Chris@1 285 <table class="memname">
Chris@1 286 <tr>
Chris@6 287 <td class="memname">virtual Vamp::HostExt::PluginLoader::~PluginLoader </td>
Chris@1 288 <td>(</td>
Chris@1 289 <td class="paramname"></td><td>)</td>
Chris@6 290 <td></td>
Chris@1 291 </tr>
Chris@1 292 </table>
Chris@6 293 </td>
Chris@6 294 <td class="mlabels-right">
Chris@6 295 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
Chris@6 296 </tr>
Chris@6 297 </table>
Chris@6 298 </div><div class="memdoc">
Chris@1 299
Chris@1 300 </div>
Chris@1 301 </div>
Chris@6 302 <h2 class="groupheader">Member Function Documentation</h2>
Chris@6 303 <a id="a1d77fa1d58ee4fee2985b5af02380326"></a>
Chris@6 304 <h2 class="memtitle"><span class="permalink"><a href="#a1d77fa1d58ee4fee2985b5af02380326">&#9670;&nbsp;</a></span>getInstance()</h2>
Chris@6 305
Chris@1 306 <div class="memitem">
Chris@1 307 <div class="memproto">
Chris@6 308 <table class="mlabels">
Chris@6 309 <tr>
Chris@6 310 <td class="mlabels-left">
Chris@1 311 <table class="memname">
Chris@1 312 <tr>
Chris@6 313 <td class="memname">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>* Vamp::HostExt::PluginLoader::getInstance </td>
Chris@1 314 <td>(</td>
Chris@1 315 <td class="paramname"></td><td>)</td>
Chris@6 316 <td></td>
Chris@1 317 </tr>
Chris@1 318 </table>
Chris@6 319 </td>
Chris@6 320 <td class="mlabels-right">
Chris@6 321 <span class="mlabels"><span class="mlabel">static</span></span> </td>
Chris@6 322 </tr>
Chris@6 323 </table>
Chris@6 324 </div><div class="memdoc">
Chris@1 325
Chris@1 326 <p>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 plugins using the...">PluginLoader</a>. </p>
Chris@1 327 <p>Use this to obtain your loader object. </p>
Chris@1 328
Chris@1 329 </div>
Chris@1 330 </div>
Chris@6 331 <a id="aff51b52bb68aa2934ccf26ad1d284f28"></a>
Chris@6 332 <h2 class="memtitle"><span class="permalink"><a href="#aff51b52bb68aa2934ccf26ad1d284f28">&#9670;&nbsp;</a></span>listPlugins()</h2>
Chris@6 333
Chris@1 334 <div class="memitem">
Chris@1 335 <div class="memproto">
Chris@1 336 <table class="memname">
Chris@1 337 <tr>
Chris@6 338 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> Vamp::HostExt::PluginLoader::listPlugins </td>
Chris@1 339 <td>(</td>
Chris@1 340 <td class="paramname"></td><td>)</td>
Chris@1 341 <td></td>
Chris@1 342 </tr>
Chris@1 343 </table>
Chris@6 344 </div><div class="memdoc">
Chris@1 345
Chris@1 346 <p>Search for all available <a class="el" href="namespaceVamp.html">Vamp</a> plugins, and return a list of them in the order in which they were found. </p>
Chris@1 347
Chris@6 348 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00828">printPluginCategoryList()</a>.</p>
Chris@1 349
Chris@1 350 </div>
Chris@1 351 </div>
Chris@6 352 <a id="a04c207e7c936710d70f31dba36f1773c"></a>
Chris@6 353 <h2 class="memtitle"><span class="permalink"><a href="#a04c207e7c936710d70f31dba36f1773c">&#9670;&nbsp;</a></span>listPluginsIn()</h2>
Chris@6 354
Chris@1 355 <div class="memitem">
Chris@1 356 <div class="memproto">
Chris@1 357 <table class="memname">
Chris@1 358 <tr>
Chris@6 359 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> Vamp::HostExt::PluginLoader::listPluginsIn </td>
Chris@6 360 <td>(</td>
Chris@6 361 <td class="paramtype">std::vector&lt; std::string &gt;&#160;</td>
Chris@6 362 <td class="paramname"><em>libraryNames</em></td><td>)</td>
Chris@6 363 <td></td>
Chris@6 364 </tr>
Chris@6 365 </table>
Chris@6 366 </div><div class="memdoc">
Chris@6 367
Chris@6 368 <p>Search for available <a class="el" href="namespaceVamp.html">Vamp</a> plugins in libraries with the given library names, and return a list of them in the order in which they were found. </p>
Chris@6 369 <p>Do not attempt to load any plugin libraries other than those named.</p>
Chris@6 370 <p>The library names should be supplied without path or suffix. For example, use "vamp-example-plugins" to find plugins in /install/path/of/vamp-example-plugins.dll (or .so etc). This is the same concept of "library name" as appears in the plugin key: </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#acc6865d27825c100d7b6f9ed6ecf5207" title="Given a Vamp plugin library name and plugin identifier, return the corresponding plugin key in a form...">composePluginKey()</a>. </dd></dl>
Chris@6 371
Chris@6 372 </div>
Chris@6 373 </div>
Chris@6 374 <a id="a0bd7c1f000b6e5411cffd908bd77f931"></a>
Chris@6 375 <h2 class="memtitle"><span class="permalink"><a href="#a0bd7c1f000b6e5411cffd908bd77f931">&#9670;&nbsp;</a></span>listPluginsNotIn()</h2>
Chris@6 376
Chris@6 377 <div class="memitem">
Chris@6 378 <div class="memproto">
Chris@6 379 <table class="memname">
Chris@6 380 <tr>
Chris@6 381 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> Vamp::HostExt::PluginLoader::listPluginsNotIn </td>
Chris@6 382 <td>(</td>
Chris@6 383 <td class="paramtype">std::vector&lt; std::string &gt;&#160;</td>
Chris@6 384 <td class="paramname"><em>libraryNames</em></td><td>)</td>
Chris@6 385 <td></td>
Chris@6 386 </tr>
Chris@6 387 </table>
Chris@6 388 </div><div class="memdoc">
Chris@6 389
Chris@6 390 <p>Search for available <a class="el" href="namespaceVamp.html">Vamp</a> plugins in libraries other than those with the given library names, and return a list of them in the order in which they were found. </p>
Chris@6 391 <p>Do not attempt to load any of the libraries named.</p>
Chris@6 392 <p>The library names should be supplied without path or suffix. For example, use "vamp-example-plugins" to find plugins not appearing in /install/path/of/vamp-example-plugins.dll (or .so etc). This is the same concept of "library name" as appears in the plugin key: </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#acc6865d27825c100d7b6f9ed6ecf5207" title="Given a Vamp plugin library name and plugin identifier, return the corresponding plugin key in a form...">composePluginKey()</a>. </dd></dl>
Chris@6 393
Chris@6 394 </div>
Chris@6 395 </div>
Chris@6 396 <a id="a964689eb9688cd7e58e8c82ebb0d305f"></a>
Chris@6 397 <h2 class="memtitle"><span class="permalink"><a href="#a964689eb9688cd7e58e8c82ebb0d305f">&#9670;&nbsp;</a></span>loadPlugin()</h2>
Chris@6 398
Chris@6 399 <div class="memitem">
Chris@6 400 <div class="memproto">
Chris@6 401 <table class="memname">
Chris@6 402 <tr>
Chris@6 403 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginLoader::loadPlugin </td>
Chris@1 404 <td>(</td>
Chris@1 405 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&#160;</td>
Chris@1 406 <td class="paramname"><em>key</em>, </td>
Chris@1 407 </tr>
Chris@1 408 <tr>
Chris@1 409 <td class="paramkey"></td>
Chris@1 410 <td></td>
Chris@1 411 <td class="paramtype">float&#160;</td>
Chris@1 412 <td class="paramname"><em>inputSampleRate</em>, </td>
Chris@1 413 </tr>
Chris@1 414 <tr>
Chris@1 415 <td class="paramkey"></td>
Chris@1 416 <td></td>
Chris@1 417 <td class="paramtype">int&#160;</td>
Chris@1 418 <td class="paramname"><em>adapterFlags</em> = <code>0</code>&#160;</td>
Chris@1 419 </tr>
Chris@1 420 <tr>
Chris@1 421 <td></td>
Chris@1 422 <td>)</td>
Chris@1 423 <td></td><td></td>
Chris@1 424 </tr>
Chris@1 425 </table>
Chris@6 426 </div><div class="memdoc">
Chris@1 427
Chris@1 428 <p>Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. </p>
Chris@1 429 <p>If the plugin could not be loaded, returns 0.</p>
Chris@1 430 <p>The returned plugin should be deleted (using the standard C++ delete keyword) after use.</p>
Chris@6 431 <dl class="params"><dt>Parameters</dt><dd>
Chris@1 432 <table class="params">
Chris@1 433 <tr><td class="paramname">adapterFlags</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>
Chris@1 434 </table>
Chris@1 435 </dd>
Chris@1 436 </dl>
Chris@6 437 <dl class="section see"><dt>See also</dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494" title="AdapterFlags contains a set of values that may be OR&#39;d together to indicate in which circumstances Pl...">AdapterFlags</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-doma...">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 of plugins that...">PluginChannelAdapter</a> </dd></dl>
Chris@1 438
Chris@6 439 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, <a class="el" href="vamp-simple-host_8cpp_source.html#l00828">printPluginCategoryList()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 440
Chris@1 441 </div>
Chris@1 442 </div>
Chris@6 443 <a id="acc6865d27825c100d7b6f9ed6ecf5207"></a>
Chris@6 444 <h2 class="memtitle"><span class="permalink"><a href="#acc6865d27825c100d7b6f9ed6ecf5207">&#9670;&nbsp;</a></span>composePluginKey()</h2>
Chris@6 445
Chris@1 446 <div class="memitem">
Chris@1 447 <div class="memproto">
Chris@1 448 <table class="memname">
Chris@1 449 <tr>
Chris@6 450 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> Vamp::HostExt::PluginLoader::composePluginKey </td>
Chris@1 451 <td>(</td>
Chris@1 452 <td class="paramtype">std::string&#160;</td>
Chris@1 453 <td class="paramname"><em>libraryName</em>, </td>
Chris@1 454 </tr>
Chris@1 455 <tr>
Chris@1 456 <td class="paramkey"></td>
Chris@1 457 <td></td>
Chris@1 458 <td class="paramtype">std::string&#160;</td>
Chris@1 459 <td class="paramname"><em>identifier</em>&#160;</td>
Chris@1 460 </tr>
Chris@1 461 <tr>
Chris@1 462 <td></td>
Chris@1 463 <td>)</td>
Chris@1 464 <td></td><td></td>
Chris@1 465 </tr>
Chris@1 466 </table>
Chris@6 467 </div><div class="memdoc">
Chris@1 468
Chris@6 469 <p>Given a <a class="el" href="namespaceVamp.html">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#a964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key. ">loadPlugin()</a>. </p>
Chris@1 470
Chris@6 471 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
Chris@1 472
Chris@1 473 </div>
Chris@1 474 </div>
Chris@6 475 <a id="a52746ea66339ad981b868a031a3b382d"></a>
Chris@6 476 <h2 class="memtitle"><span class="permalink"><a href="#a52746ea66339ad981b868a031a3b382d">&#9670;&nbsp;</a></span>getPluginCategory()</h2>
Chris@6 477
Chris@1 478 <div class="memitem">
Chris@1 479 <div class="memproto">
Chris@1 480 <table class="memname">
Chris@1 481 <tr>
Chris@6 482 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td>
Chris@1 483 <td>(</td>
Chris@1 484 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&#160;</td>
Chris@1 485 <td class="paramname"><em>plugin</em></td><td>)</td>
Chris@1 486 <td></td>
Chris@1 487 </tr>
Chris@1 488 </table>
Chris@6 489 </div><div class="memdoc">
Chris@1 490
Chris@1 491 <p>Return the category hierarchy for a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. </p>
Chris@1 492 <p>If the plugin has no category information, return an empty hierarchy.</p>
Chris@6 493 <dl class="section see"><dt>See also</dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364" title="PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with ...">PluginCategoryHierarchy</a> </dd></dl>
Chris@1 494
Chris@6 495 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00828">printPluginCategoryList()</a>.</p>
Chris@1 496
Chris@1 497 </div>
Chris@1 498 </div>
Chris@6 499 <a id="a4bbcb7873e617bbc9f79eade1f90f7ad"></a>
Chris@6 500 <h2 class="memtitle"><span class="permalink"><a href="#a4bbcb7873e617bbc9f79eade1f90f7ad">&#9670;&nbsp;</a></span>getLibraryPathForPlugin()</h2>
Chris@6 501
Chris@1 502 <div class="memitem">
Chris@1 503 <div class="memproto">
Chris@1 504 <table class="memname">
Chris@1 505 <tr>
Chris@6 506 <td class="memname">std::string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td>
Chris@1 507 <td>(</td>
Chris@1 508 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&#160;</td>
Chris@1 509 <td class="paramname"><em>plugin</em></td><td>)</td>
Chris@1 510 <td></td>
Chris@1 511 </tr>
Chris@1 512 </table>
Chris@6 513 </div><div class="memdoc">
Chris@1 514
Chris@1 515 <p>Return the file path of the dynamic library from which the given plugin will be loaded (if available). </p>
Chris@1 516
Chris@6 517 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
Chris@1 518
Chris@1 519 </div>
Chris@1 520 </div>
Chris@6 521 <h2 class="groupheader">Member Data Documentation</h2>
Chris@6 522 <a id="ac12254d823f6d63cb8ce82a07bdcb072"></a>
Chris@6 523 <h2 class="memtitle"><span class="permalink"><a href="#ac12254d823f6d63cb8ce82a07bdcb072">&#9670;&nbsp;</a></span>m_impl</h2>
Chris@6 524
Chris@1 525 <div class="memitem">
Chris@1 526 <div class="memproto">
Chris@6 527 <table class="mlabels">
Chris@6 528 <tr>
Chris@6 529 <td class="mlabels-left">
Chris@1 530 <table class="memname">
Chris@1 531 <tr>
Chris@6 532 <td class="memname">Impl* Vamp::HostExt::PluginLoader::m_impl</td>
Chris@1 533 </tr>
Chris@1 534 </table>
Chris@6 535 </td>
Chris@6 536 <td class="mlabels-right">
Chris@6 537 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
Chris@6 538 </tr>
Chris@6 539 </table>
Chris@6 540 </div><div class="memdoc">
Chris@1 541
Chris@6 542 <p class="definition">Definition at line <a class="el" href="PluginLoader_8h_source.html#l00261">261</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
Chris@1 543
Chris@1 544 </div>
Chris@1 545 </div>
Chris@6 546 <a id="af89caf5f838a586b117c417260b7a116"></a>
Chris@6 547 <h2 class="memtitle"><span class="permalink"><a href="#af89caf5f838a586b117c417260b7a116">&#9670;&nbsp;</a></span>m_instance</h2>
Chris@6 548
Chris@1 549 <div class="memitem">
Chris@1 550 <div class="memproto">
Chris@6 551 <table class="mlabels">
Chris@6 552 <tr>
Chris@6 553 <td class="mlabels-left">
Chris@1 554 <table class="memname">
Chris@1 555 <tr>
Chris@6 556 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>* Vamp::HostExt::PluginLoader::m_instance</td>
Chris@1 557 </tr>
Chris@1 558 </table>
Chris@6 559 </td>
Chris@6 560 <td class="mlabels-right">
Chris@6 561 <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
Chris@6 562 </tr>
Chris@6 563 </table>
Chris@6 564 </div><div class="memdoc">
Chris@1 565
Chris@6 566 <p class="definition">Definition at line <a class="el" href="PluginLoader_8h_source.html#l00264">264</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
Chris@1 567
Chris@1 568 </div>
Chris@1 569 </div>
Chris@1 570 <hr/>The documentation for this class was generated from the following file:<ul>
Chris@1 571 <li><a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a></li>
Chris@1 572 </ul>
Chris@3 573 </div><!-- contents -->
Chris@6 574 </div><!-- doc-content -->
Chris@6 575 <!-- start footer part -->
Chris@6 576 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 577 <ul>
Chris@6 578 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></li><li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a></li>
Chris@6 579 <li class="footer">Generated by
Chris@6 580 <a href="http://www.doxygen.org/index.html">
Chris@6 581 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 582 </ul>
Chris@1 583 </div>
Chris@1 584 </body>
Chris@1 585 </html>