Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginLoader.html @ 50:8260c0f4e05b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs for 2.3
author cannam
date Tue, 04 Oct 2011 13:47:23 +0000
parents 0976232e353b
children
comparison
equal deleted inserted replaced
49:f75f330aa130 50:8260c0f4e05b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3 <title>VampPluginSDK: Vamp::HostExt::PluginLoader Class Reference</title> 5 <title>VampPluginSDK: Vamp::HostExt::PluginLoader Class Reference</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css"> 6
5 <link href="doxygen.css" rel="stylesheet" type="text/css"> 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
6 </head><body> 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
7 <!-- Generated by Doxygen 1.5.8 --> 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
8 <div class="navigation" id="top"> 10 <script type="text/javascript" src="jquery.js"></script>
9 <div class="tabs"> 11 <script type="text/javascript" src="resize.js"></script>
10 <ul> 12 <script type="text/javascript" src="navtree.js"></script>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li> 49 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li> 50 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul> 51 </ul>
17 </div> 52 </div>
18 <div class="tabs"> 53 <div id="navrow2" class="tabs2">
19 <ul> 54 <ul class="tablist">
20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li> 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
23 </ul> 58 </ul>
24 </div> 59 </div>
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> 60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree">
63 <div id="nav-tree-contents">
64 </div>
26 </div> 65 </div>
66 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle">
68 </div>
69 </div>
70 <script type="text/javascript">
71 initNavTree('classVamp_1_1HostExt_1_1PluginLoader.html','');
72 </script>
73 <div id="doc-content">
74 <div class="header">
75 <div class="summary">
76 <a href="#pub-types">Public Types</a> &#124;
77 <a href="#pub-methods">Public Member Functions</a> &#124;
78 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
79 <a href="#pro-methods">Protected Member Functions</a> &#124;
80 <a href="#pro-attribs">Protected Attributes</a> &#124;
81 <a href="#pro-static-attribs">Static Protected Attributes</a> </div>
82 <div class="headertitle">
83 <div class="title">Vamp::HostExt::PluginLoader Class Reference</div> </div>
27 </div> 84 </div>
28 <div class="contents"> 85 <div class="contents">
29 <h1>Vamp::HostExt::PluginLoader Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginLoader" --><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">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. 86 <!-- doxytag: class="Vamp::HostExt::PluginLoader" -->
30 <a href="#_details">More...</a> 87 <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.
31 <p> 88 <a href="classVamp_1_1HostExt_1_1PluginLoader.html#details">More...</a></p>
32 <code>#include &lt;<a class="el" href="PluginLoader_8h-source.html">vamp-hostsdk/PluginLoader.h</a>&gt;</code> 89
33 <p> 90 <p><code>#include &lt;<a class="el" href="PluginLoader_8h_source.html">vamp-hostsdk/PluginLoader.h</a>&gt;</code></p>
34 91
35 <p> 92 <p><a href="classVamp_1_1HostExt_1_1PluginLoader-members.html">List of all members.</a></p>
36 <a href="classVamp_1_1HostExt_1_1PluginLoader-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 93 <table class="memberdecls">
37 <tr><td></td></tr> 94 <tr><td colspan="2"><h2><a name="pub-types"></a>
38 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> 95 Public Types</h2></td></tr>
39 <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> 96 <tr><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/>
40 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494763a9a0caf512d9671b90c05c2808a09">ADAPT_INPUT_DOMAIN</a> = 0x01, 97 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09">ADAPT_INPUT_DOMAIN</a> = 0x01,
41 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe349454c43b85382d78e8ea8da192bce3a139">ADAPT_CHANNEL_COUNT</a> = 0x02, 98 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139">ADAPT_CHANNEL_COUNT</a> = 0x02,
42 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34945c0c389797922630a6b54ffd1eed21f1">ADAPT_BUFFER_SIZE</a> = 0x04, 99 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1">ADAPT_BUFFER_SIZE</a> = 0x04,
43 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34948220529e851ae30d37f413c40a389e08">ADAPT_ALL_SAFE</a> = 0x03, 100 <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08">ADAPT_ALL_SAFE</a> = 0x03,
44 <br> 101 <br/>
45 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe34943b1e08415c0cbc96f7900eac955ad6d0">ADAPT_ALL</a> = 0xff 102 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0">ADAPT_ALL</a> = 0xff
46 <br> 103 <br/>
47 }</td></tr> 104 }</td></tr>
48 105 <tr><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>
49 <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> 106 <tr><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>
50 <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> 107 <tr><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"></a><br/></td></tr>
51 108 <tr><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>
52 <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> 109 <tr><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"></a><br/></td></tr>
53 <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> 110 <tr><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>
54 111 <tr><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"></a><br/></td></tr>
55 <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#ff51b52bb68aa2934ccf26ad1d284f28" 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> 112 <tr><td colspan="2"><h2><a name="pub-methods"></a>
56 <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> 113 Public Member Functions</h2></td></tr>
57 114 <tr><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>
58 <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> 115 <tr><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"></a><br/></td></tr>
59 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 116 <tr><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>
60 <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#ff51b52bb68aa2934ccf26ad1d284f28">listPlugins</a> ()</td></tr> 117 <tr><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"></a><br/></td></tr>
61 118 <tr><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>
62 <tr><td class="mdescLeft">&nbsp;</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="#ff51b52bb68aa2934ccf26ad1d284f28"></a><br></td></tr> 119 <tr><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"></a><br/></td></tr>
63 <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#964689eb9688cd7e58e8c82ebb0d305f">loadPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> key, float inputSampleRate, int adapterFlags=0)</td></tr> 120 <tr><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>
64 121 <tr><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"></a><br/></td></tr>
65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. <a href="#964689eb9688cd7e58e8c82ebb0d305f"></a><br></td></tr> 122 <tr><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>
66 <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> 123 <tr><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"></a><br/></td></tr>
67 124 <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
68 <tr><td class="mdescLeft">&nbsp;</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#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>. <a href="#cc6865d27825c100d7b6f9ed6ecf5207"></a><br></td></tr> 125 Static Public Member Functions</h2></td></tr>
69 <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#52746ea66339ad981b868a031a3b382d">getPluginCategory</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr> 126 <tr><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>
70 127 <tr><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"></a><br/></td></tr>
71 <tr><td class="mdescLeft">&nbsp;</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="#52746ea66339ad981b868a031a3b382d"></a><br></td></tr> 128 <tr><td colspan="2"><h2><a name="pro-methods"></a>
72 <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#4bbcb7873e617bbc9f79eade1f90f7ad">getLibraryPathForPlugin</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> plugin)</td></tr> 129 Protected Member Functions</h2></td></tr>
73 130 <tr><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>
74 <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="#4bbcb7873e617bbc9f79eade1f90f7ad"></a><br></td></tr> 131 <tr><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>
75 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> 132 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
76 <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#1d77fa1d58ee4fee2985b5af02380326">getInstance</a> ()</td></tr> 133 Protected Attributes</h2></td></tr>
77 134 <tr><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>
78 <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="#1d77fa1d58ee4fee2985b5af02380326"></a><br></td></tr> 135 <tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
79 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> 136 Static Protected Attributes</h2></td></tr>
80 <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> 137 <tr><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>
81
82 <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#d74ab52bc6aa2514b3a6b3f679fc492c">~PluginLoader</a> ()</td></tr>
83
84 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
85 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">m_impl</a></td></tr>
86
87 <tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
88 <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#f89caf5f838a586b117c417260b7a116">m_instance</a></td></tr>
89
90 </table> 138 </table>
91 <hr><a name="_details"></a><h2>Detailed Description</h2> 139 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
92 <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">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. 140 <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>
93 <p> 141 <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>
94 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> 142 <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>
95 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> 143 <dl class="note"><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
96 <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">Vamp</a> plugin SDK. </dd></dl> 144
97 145 <p>Definition at line <a class="el" href="PluginLoader_8h_source.html#l00072">72</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
98 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00072">72</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 146 </div><hr/><h2>Member Typedef Documentation</h2>
99 <hr><h2>Member Typedef Documentation</h2> 147 <a class="anchor" id="a473645bbb3ac5c1a0da2f0f482947c4d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKey" ref="a473645bbb3ac5c1a0da2f0f482947c4d" args="" -->
100 <a class="anchor" name="473645bbb3ac5c1a0da2f0f482947c4d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKey" ref="473645bbb3ac5c1a0da2f0f482947c4d" args="" --> 148 <div class="memitem">
101 <div class="memitem"> 149 <div class="memproto">
102 <div class="memproto"> 150 <table class="memname">
103 <table class="memname"> 151 <tr>
104 <tr> 152 <td class="memname">typedef std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">Vamp::HostExt::PluginLoader::PluginKey</a></td>
105 <td class="memname">typedef std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">Vamp::HostExt::PluginLoader::PluginKey</a> </td> 153 </tr>
106 </tr> 154 </table>
107 </table> 155 </div>
108 </div> 156 <div class="memdoc">
109 <div class="memdoc"> 157
110 158 <p>PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". </p>
111 <p> 159 <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>
112 PluginKey is a string type that is used to identify a plugin uniquely within the scope of "the current system". 160 <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>
113 <p> 161 <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 _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#a4bbcb7873e617bbc9f79eade1f90f7ad" title="Return the file path of the dynamic library from which the given plugin will be loaded (if available)...">getLibraryPathForPlugin()</a> instead. </p>
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#09cbfb7903d28f10d6d556c6cb81c5f6">PluginHostAdapter::getPluginPath()</a>).<p> 162
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> 163 <p>Definition at line <a class="el" href="PluginLoader_8h_source.html#l00101">101</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
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#4bbcb7873e617bbc9f79eade1f90f7ad" title="Return the file path of the dynamic library from which the given plugin will be loaded...">getLibraryPathForPlugin()</a> instead. 164
117 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00101">101</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 165 </div>
118 166 </div>
119 </div> 167 <a class="anchor" id="a0d48b76e4f995110f53e0feeb23f733a"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKeyList" ref="a0d48b76e4f995110f53e0feeb23f733a" args="" -->
120 </div><p> 168 <div class="memitem">
121 <a class="anchor" name="0d48b76e4f995110f53e0feeb23f733a"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginKeyList" ref="0d48b76e4f995110f53e0feeb23f733a" args="" --> 169 <div class="memproto">
122 <div class="memitem"> 170 <table class="memname">
123 <div class="memproto"> 171 <tr>
124 <table class="memname"> 172 <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>
125 <tr> 173 </tr>
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> 174 </table>
127 </tr> 175 </div>
128 </table> 176 <div class="memdoc">
129 </div> 177
130 <div class="memdoc"> 178 <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>
131 179
132 <p> 180 <p>Definition at line <a class="el" href="PluginLoader_8h_source.html#l00107">107</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
133 PluginKeyList is a sequence of plugin keys, such as returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff51b52bb68aa2934ccf26ad1d284f28" title="Search for all available Vamp plugins, and return a list of them in the order in...">listPlugins()</a>. 181
134 <p> 182 </div>
135 183 </div>
136 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00107">107</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 184 <a class="anchor" id="ad6a39aa0c79d8d9209eb0b8dfe9d1364"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginCategoryHierarchy" ref="ad6a39aa0c79d8d9209eb0b8dfe9d1364" args="" -->
137 185 <div class="memitem">
138 </div> 186 <div class="memproto">
139 </div><p> 187 <table class="memname">
140 <a class="anchor" name="d6a39aa0c79d8d9209eb0b8dfe9d1364"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginCategoryHierarchy" ref="d6a39aa0c79d8d9209eb0b8dfe9d1364" args="" --> 188 <tr>
141 <div class="memitem"> 189 <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>
142 <div class="memproto"> 190 </tr>
143 <table class="memname"> 191 </table>
144 <tr> 192 </div>
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> 193 <div class="memdoc">
146 </tr> 194
147 </table> 195 <p>PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. </p>
148 </div> 196 <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>
149 <div class="memdoc"> 197 <dl class="see"><dt><b>See also:</b></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>
150 198
151 <p> 199 <p>Definition at line <a class="el" href="PluginLoader_8h_source.html#l00119">119</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
152 PluginCategoryHierarchy is a sequence of general-&gt;specific category names, as may be associated with a single plugin. 200
153 <p> 201 </div>
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> 202 </div>
155 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#52746ea66339ad981b868a031a3b382d" title="Return the category hierarchy for a Vamp plugin, given its identifying key.">getPluginCategory()</a> </dd></dl> 203 <hr/><h2>Member Enumeration Documentation</h2>
156 204 <a class="anchor" id="aff3ee11692ce25e0dfb904324cbe3494"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::AdapterFlags" ref="aff3ee11692ce25e0dfb904324cbe3494" args="" -->
157 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00119">119</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 205 <div class="memitem">
158 206 <div class="memproto">
159 </div> 207 <table class="memname">
160 </div><p> 208 <tr>
161 <hr><h2>Member Enumeration Documentation</h2> 209 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#aff3ee11692ce25e0dfb904324cbe3494">Vamp::HostExt::PluginLoader::AdapterFlags</a></td>
162 <a class="anchor" name="ff3ee11692ce25e0dfb904324cbe3494"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::AdapterFlags" ref="ff3ee11692ce25e0dfb904324cbe3494" args="" --> 210 </tr>
163 <div class="memitem"> 211 </table>
164 <div class="memproto"> 212 </div>
165 <table class="memname"> 213 <div class="memdoc">
166 <tr> 214
167 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ff3ee11692ce25e0dfb904324cbe3494">Vamp::HostExt::PluginLoader::AdapterFlags</a> </td> 215 <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>
168 </tr> 216 <p>The available flags are:</p>
169 </table> 217 <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>
170 </div> 218 <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>
171 <div class="memdoc"> 219 <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>
172 220 <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>
173 <p> 221 <p>ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.</p>
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. 222 <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>
175 <p> 223 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
176 The available flags are:<p> 224 <tr><td valign="top"><em><a class="anchor" id="aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09"></a><!-- doxytag: member="ADAPT_INPUT_DOMAIN" ref="aff3ee11692ce25e0dfb904324cbe3494a763a9a0caf512d9671b90c05c2808a09" args="" -->ADAPT_INPUT_DOMAIN</em>&nbsp;</td><td>
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>
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>
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>
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>
181 ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.<p>
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>
183 <table border="0" cellspacing="2" cellpadding="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>
185 </td></tr> 225 </td></tr>
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> 226 <tr><td valign="top"><em><a class="anchor" id="aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139"></a><!-- doxytag: member="ADAPT_CHANNEL_COUNT" ref="aff3ee11692ce25e0dfb904324cbe3494a54c43b85382d78e8ea8da192bce3a139" args="" -->ADAPT_CHANNEL_COUNT</em>&nbsp;</td><td>
187 </td></tr> 227 </td></tr>
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> 228 <tr><td valign="top"><em><a class="anchor" id="aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1"></a><!-- doxytag: member="ADAPT_BUFFER_SIZE" ref="aff3ee11692ce25e0dfb904324cbe3494a5c0c389797922630a6b54ffd1eed21f1" args="" -->ADAPT_BUFFER_SIZE</em>&nbsp;</td><td>
189 </td></tr> 229 </td></tr>
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> 230 <tr><td valign="top"><em><a class="anchor" id="aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08"></a><!-- doxytag: member="ADAPT_ALL_SAFE" ref="aff3ee11692ce25e0dfb904324cbe3494a8220529e851ae30d37f413c40a389e08" args="" -->ADAPT_ALL_SAFE</em>&nbsp;</td><td>
191 </td></tr> 231 </td></tr>
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> 232 <tr><td valign="top"><em><a class="anchor" id="aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0"></a><!-- doxytag: member="ADAPT_ALL" ref="aff3ee11692ce25e0dfb904324cbe3494a3b1e08415c0cbc96f7900eac955ad6d0" args="" -->ADAPT_ALL</em>&nbsp;</td><td>
193 </td></tr> 233 </td></tr>
194 </table> 234 </table>
235 </dd>
195 </dl> 236 </dl>
196 237
197 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00169">169</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 238 <p>Definition at line <a class="el" href="PluginLoader_8h_source.html#l00169">169</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
198 239
199 </div> 240 </div>
200 </div><p> 241 </div>
201 <hr><h2>Constructor &amp; Destructor Documentation</h2> 242 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
202 <a class="anchor" name="5ab9e0281244bef7976c6c0ce1a55c24"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginLoader" ref="5ab9e0281244bef7976c6c0ce1a55c24" args="()" --> 243 <a class="anchor" id="a5ab9e0281244bef7976c6c0ce1a55c24"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::PluginLoader" ref="a5ab9e0281244bef7976c6c0ce1a55c24" args="()" -->
203 <div class="memitem"> 244 <div class="memitem">
204 <div class="memproto"> 245 <div class="memproto">
205 <table class="memname"> 246 <table class="memname">
206 <tr> 247 <tr>
207 <td class="memname">Vamp::HostExt::PluginLoader::PluginLoader </td> 248 <td class="memname">Vamp::HostExt::PluginLoader::PluginLoader </td>
208 <td>(</td> 249 <td>(</td>
209 <td class="paramname"> </td> 250 <td class="paramname"></td><td>)</td>
210 <td>&nbsp;)&nbsp;</td>
211 <td><code> [protected]</code></td> 251 <td><code> [protected]</code></td>
212 </tr> 252 </tr>
213 </table> 253 </table>
214 </div> 254 </div>
215 <div class="memdoc"> 255 <div class="memdoc">
216 256
217 <p> 257 </div>
218 258 </div>
219 </div> 259 <a class="anchor" id="ad74ab52bc6aa2514b3a6b3f679fc492c"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::~PluginLoader" ref="ad74ab52bc6aa2514b3a6b3f679fc492c" args="()" -->
220 </div><p> 260 <div class="memitem">
221 <a class="anchor" name="d74ab52bc6aa2514b3a6b3f679fc492c"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::~PluginLoader" ref="d74ab52bc6aa2514b3a6b3f679fc492c" args="()" --> 261 <div class="memproto">
222 <div class="memitem"> 262 <table class="memname">
223 <div class="memproto"> 263 <tr>
224 <table class="memname"> 264 <td class="memname">virtual Vamp::HostExt::PluginLoader::~PluginLoader </td>
225 <tr> 265 <td>(</td>
226 <td class="memname">virtual Vamp::HostExt::PluginLoader::~PluginLoader </td> 266 <td class="paramname"></td><td>)</td>
227 <td>(</td>
228 <td class="paramname"> </td>
229 <td>&nbsp;)&nbsp;</td>
230 <td><code> [protected, virtual]</code></td> 267 <td><code> [protected, virtual]</code></td>
231 </tr> 268 </tr>
232 </table> 269 </table>
233 </div> 270 </div>
234 <div class="memdoc"> 271 <div class="memdoc">
235 272
236 <p> 273 </div>
237 274 </div>
238 </div> 275 <hr/><h2>Member Function Documentation</h2>
239 </div><p> 276 <a class="anchor" id="a1d77fa1d58ee4fee2985b5af02380326"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getInstance" ref="a1d77fa1d58ee4fee2985b5af02380326" args="()" -->
240 <hr><h2>Member Function Documentation</h2> 277 <div class="memitem">
241 <a class="anchor" name="1d77fa1d58ee4fee2985b5af02380326"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getInstance" ref="1d77fa1d58ee4fee2985b5af02380326" args="()" --> 278 <div class="memproto">
242 <div class="memitem"> 279 <table class="memname">
243 <div class="memproto"> 280 <tr>
244 <table class="memname"> 281 <td class="memname">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>* Vamp::HostExt::PluginLoader::getInstance </td>
245 <tr> 282 <td>(</td>
246 <td class="memname">static <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a>* Vamp::HostExt::PluginLoader::getInstance </td> 283 <td class="paramname"></td><td>)</td>
247 <td>(</td>
248 <td class="paramname"> </td>
249 <td>&nbsp;)&nbsp;</td>
250 <td><code> [static]</code></td> 284 <td><code> [static]</code></td>
251 </tr> 285 </tr>
252 </table> 286 </table>
253 </div> 287 </div>
254 <div class="memdoc"> 288 <div class="memdoc">
255 289
256 <p> 290 <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>
257 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>. 291 <p>Use this to obtain your loader object. </p>
258 <p> 292
259 Use this to obtain your loader object. 293 </div>
260 </div> 294 </div>
261 </div><p> 295 <a class="anchor" id="aff51b52bb68aa2934ccf26ad1d284f28"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::listPlugins" ref="aff51b52bb68aa2934ccf26ad1d284f28" args="()" -->
262 <a class="anchor" name="ff51b52bb68aa2934ccf26ad1d284f28"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::listPlugins" ref="ff51b52bb68aa2934ccf26ad1d284f28" args="()" --> 296 <div class="memitem">
263 <div class="memitem"> 297 <div class="memproto">
264 <div class="memproto"> 298 <table class="memname">
265 <table class="memname"> 299 <tr>
266 <tr> 300 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> Vamp::HostExt::PluginLoader::listPlugins </td>
267 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#0d48b76e4f995110f53e0feeb23f733a">PluginKeyList</a> Vamp::HostExt::PluginLoader::listPlugins </td> 301 <td>(</td>
268 <td>(</td> 302 <td class="paramname"></td><td>)</td>
269 <td class="paramname"> </td> 303 <td></td>
270 <td>&nbsp;)&nbsp;</td> 304 </tr>
271 <td></td> 305 </table>
272 </tr> 306 </div>
273 </table> 307 <div class="memdoc">
274 </div> 308
275 <div class="memdoc"> 309 <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>
276 310
277 <p> 311 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p>
278 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. 312
279 <p> 313 </div>
280 314 </div>
281 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>.</p> 315 <a class="anchor" id="a964689eb9688cd7e58e8c82ebb0d305f"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::loadPlugin" ref="a964689eb9688cd7e58e8c82ebb0d305f" args="(PluginKey key, float inputSampleRate, int adapterFlags=0)" -->
282 316 <div class="memitem">
283 </div> 317 <div class="memproto">
284 </div><p> 318 <table class="memname">
285 <a class="anchor" name="964689eb9688cd7e58e8c82ebb0d305f"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::loadPlugin" ref="964689eb9688cd7e58e8c82ebb0d305f" args="(PluginKey key, float inputSampleRate, int adapterFlags=0)" --> 319 <tr>
286 <div class="memitem"> 320 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginLoader::loadPlugin </td>
287 <div class="memproto"> 321 <td>(</td>
288 <table class="memname"> 322 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&#160;</td>
289 <tr> 323 <td class="paramname"><em>key</em>, </td>
290 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginLoader::loadPlugin </td>
291 <td>(</td>
292 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td>
293 <td class="paramname"> <em>key</em>, </td>
294 </tr> 324 </tr>
295 <tr> 325 <tr>
296 <td class="paramkey"></td> 326 <td class="paramkey"></td>
297 <td></td> 327 <td></td>
298 <td class="paramtype">float&nbsp;</td> 328 <td class="paramtype">float&#160;</td>
299 <td class="paramname"> <em>inputSampleRate</em>, </td> 329 <td class="paramname"><em>inputSampleRate</em>, </td>
300 </tr> 330 </tr>
301 <tr> 331 <tr>
302 <td class="paramkey"></td> 332 <td class="paramkey"></td>
303 <td></td> 333 <td></td>
304 <td class="paramtype">int&nbsp;</td> 334 <td class="paramtype">int&#160;</td>
305 <td class="paramname"> <em>adapterFlags</em> = <code>0</code></td><td>&nbsp;</td> 335 <td class="paramname"><em>adapterFlags</em> = <code>0</code>&#160;</td>
306 </tr> 336 </tr>
307 <tr> 337 <tr>
308 <td></td> 338 <td></td>
309 <td>)</td> 339 <td>)</td>
310 <td></td><td></td><td></td> 340 <td></td><td></td>
311 </tr> 341 </tr>
312 </table> 342 </table>
313 </div> 343 </div>
314 <div class="memdoc"> 344 <div class="memdoc">
315 345
316 <p> 346 <p>Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. </p>
317 Load a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. 347 <p>If the plugin could not be loaded, returns 0.</p>
318 <p> 348 <p>The returned plugin should be deleted (using the standard C++ delete keyword) after use.</p>
319 If the plugin could not be loaded, returns 0.<p> 349 <dl><dt><b>Parameters:</b></dt><dd>
320 The returned plugin should be deleted (using the standard C++ delete keyword) after use.<p> 350 <table class="params">
321 <dl compact><dt><b>Parameters:</b></dt><dd> 351 <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>
322 <table border="0" cellspacing="2" cellpadding="0">
323 <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>
324 </table> 352 </table>
353 </dd>
325 </dl> 354 </dl>
326 <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> 355 <dl class="see"><dt><b>See also:</b></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>
327 356
328 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> 357 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
329 358
330 </div> 359 </div>
331 </div><p> 360 </div>
332 <a class="anchor" name="cc6865d27825c100d7b6f9ed6ecf5207"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::composePluginKey" ref="cc6865d27825c100d7b6f9ed6ecf5207" args="(std::string libraryName, std::string identifier)" --> 361 <a class="anchor" id="acc6865d27825c100d7b6f9ed6ecf5207"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::composePluginKey" ref="acc6865d27825c100d7b6f9ed6ecf5207" args="(std::string libraryName, std::string identifier)" -->
333 <div class="memitem"> 362 <div class="memitem">
334 <div class="memproto"> 363 <div class="memproto">
335 <table class="memname"> 364 <table class="memname">
336 <tr> 365 <tr>
337 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> Vamp::HostExt::PluginLoader::composePluginKey </td> 366 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a> Vamp::HostExt::PluginLoader::composePluginKey </td>
338 <td>(</td> 367 <td>(</td>
339 <td class="paramtype">std::string&nbsp;</td> 368 <td class="paramtype">std::string&#160;</td>
340 <td class="paramname"> <em>libraryName</em>, </td> 369 <td class="paramname"><em>libraryName</em>, </td>
341 </tr> 370 </tr>
342 <tr> 371 <tr>
343 <td class="paramkey"></td> 372 <td class="paramkey"></td>
344 <td></td> 373 <td></td>
345 <td class="paramtype">std::string&nbsp;</td> 374 <td class="paramtype">std::string&#160;</td>
346 <td class="paramname"> <em>identifier</em></td><td>&nbsp;</td> 375 <td class="paramname"><em>identifier</em>&#160;</td>
347 </tr> 376 </tr>
348 <tr> 377 <tr>
349 <td></td> 378 <td></td>
350 <td>)</td> 379 <td>)</td>
351 <td></td><td></td><td></td> 380 <td></td><td></td>
352 </tr> 381 </tr>
353 </table> 382 </table>
354 </div> 383 </div>
355 <div class="memdoc"> 384 <div class="memdoc">
356 385
357 <p> 386 <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>
358 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#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">loadPlugin()</a>. 387
359 <p> 388 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
360 389
361 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> 390 </div>
362 391 </div>
363 </div> 392 <a class="anchor" id="a52746ea66339ad981b868a031a3b382d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getPluginCategory" ref="a52746ea66339ad981b868a031a3b382d" args="(PluginKey plugin)" -->
364 </div><p> 393 <div class="memitem">
365 <a class="anchor" name="52746ea66339ad981b868a031a3b382d"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getPluginCategory" ref="52746ea66339ad981b868a031a3b382d" args="(PluginKey plugin)" --> 394 <div class="memproto">
366 <div class="memitem"> 395 <table class="memname">
367 <div class="memproto"> 396 <tr>
368 <table class="memname"> 397 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ad6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td>
369 <tr> 398 <td>(</td>
370 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#d6a39aa0c79d8d9209eb0b8dfe9d1364">PluginCategoryHierarchy</a> Vamp::HostExt::PluginLoader::getPluginCategory </td> 399 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&#160;</td>
371 <td>(</td> 400 <td class="paramname"><em>plugin</em></td><td>)</td>
372 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td> 401 <td></td>
373 <td class="paramname"> <em>plugin</em> </td> 402 </tr>
374 <td>&nbsp;)&nbsp;</td> 403 </table>
375 <td></td> 404 </div>
376 </tr> 405 <div class="memdoc">
377 </table> 406
378 </div> 407 <p>Return the category hierarchy for a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. </p>
379 <div class="memdoc"> 408 <p>If the plugin has no category information, return an empty hierarchy.</p>
380 409 <dl class="see"><dt><b>See also:</b></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>
381 <p> 410
382 Return the category hierarchy for a <a class="el" href="namespaceVamp.html">Vamp</a> plugin, given its identifying key. 411 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p>
383 <p> 412
384 If the plugin has no category information, return an empty hierarchy.<p> 413 </div>
385 <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> 414 </div>
386 415 <a class="anchor" id="a4bbcb7873e617bbc9f79eade1f90f7ad"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getLibraryPathForPlugin" ref="a4bbcb7873e617bbc9f79eade1f90f7ad" args="(PluginKey plugin)" -->
387 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>.</p> 416 <div class="memitem">
388 417 <div class="memproto">
389 </div> 418 <table class="memname">
390 </div><p> 419 <tr>
391 <a class="anchor" name="4bbcb7873e617bbc9f79eade1f90f7ad"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::getLibraryPathForPlugin" ref="4bbcb7873e617bbc9f79eade1f90f7ad" args="(PluginKey plugin)" --> 420 <td class="memname">std::string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td>
392 <div class="memitem"> 421 <td>(</td>
393 <div class="memproto"> 422 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&#160;</td>
394 <table class="memname"> 423 <td class="paramname"><em>plugin</em></td><td>)</td>
395 <tr> 424 <td></td>
396 <td class="memname">std::string Vamp::HostExt::PluginLoader::getLibraryPathForPlugin </td> 425 </tr>
397 <td>(</td> 426 </table>
398 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#473645bbb3ac5c1a0da2f0f482947c4d">PluginKey</a>&nbsp;</td> 427 </div>
399 <td class="paramname"> <em>plugin</em> </td> 428 <div class="memdoc">
400 <td>&nbsp;)&nbsp;</td> 429
401 <td></td> 430 <p>Return the file path of the dynamic library from which the given plugin will be loaded (if available). </p>
402 </tr> 431
403 </table> 432 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
404 </div> 433
405 <div class="memdoc"> 434 </div>
406 435 </div>
407 <p> 436 <hr/><h2>Member Data Documentation</h2>
408 Return the file path of the dynamic library from which the given plugin will be loaded (if available). 437 <a class="anchor" id="ac12254d823f6d63cb8ce82a07bdcb072"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_impl" ref="ac12254d823f6d63cb8ce82a07bdcb072" args="" -->
409 <p> 438 <div class="memitem">
410 439 <div class="memproto">
411 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p> 440 <table class="memname">
412 441 <tr>
413 </div> 442 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#ac12254d823f6d63cb8ce82a07bdcb072">Vamp::HostExt::PluginLoader::m_impl</a><code> [protected]</code></td>
414 </div><p> 443 </tr>
415 <hr><h2>Member Data Documentation</h2> 444 </table>
416 <a class="anchor" name="c12254d823f6d63cb8ce82a07bdcb072"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_impl" ref="c12254d823f6d63cb8ce82a07bdcb072" args="" --> 445 </div>
417 <div class="memitem"> 446 <div class="memdoc">
418 <div class="memproto"> 447
419 <table class="memname"> 448 <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>
420 <tr> 449
421 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#c12254d823f6d63cb8ce82a07bdcb072">Vamp::HostExt::PluginLoader::m_impl</a><code> [protected]</code> </td> 450 </div>
422 </tr> 451 </div>
423 </table> 452 <a class="anchor" id="af89caf5f838a586b117c417260b7a116"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_instance" ref="af89caf5f838a586b117c417260b7a116" args="" -->
424 </div> 453 <div class="memitem">
425 <div class="memdoc"> 454 <div class="memproto">
426 455 <table class="memname">
427 <p> 456 <tr>
428 457 <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#af89caf5f838a586b117c417260b7a116">Vamp::HostExt::PluginLoader::m_instance</a><code> [static, protected]</code></td>
429 <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> 458 </tr>
430 459 </table>
431 </div> 460 </div>
432 </div><p> 461 <div class="memdoc">
433 <a class="anchor" name="f89caf5f838a586b117c417260b7a116"></a><!-- doxytag: member="Vamp::HostExt::PluginLoader::m_instance" ref="f89caf5f838a586b117c417260b7a116" args="" --> 462
434 <div class="memitem"> 463 <p>Definition at line <a class="el" href="PluginLoader_8h_source.html#l00233">233</a> of file <a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a>.</p>
435 <div class="memproto"> 464
436 <table class="memname"> 465 </div>
437 <tr> 466 </div>
438 <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#f89caf5f838a586b117c417260b7a116">Vamp::HostExt::PluginLoader::m_instance</a><code> [static, protected]</code> </td> 467 <hr/>The documentation for this class was generated from the following file:<ul>
439 </tr> 468 <li><a class="el" href="PluginLoader_8h_source.html">PluginLoader.h</a></li>
440 </table> 469 </ul>
441 </div> 470 </div>
442 <div class="memdoc"> 471 </div>
443 472 <div id="nav-path" class="navpath">
444 <p> 473 <ul>
445 474 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
446 <p>Definition at line <a class="el" href="PluginLoader_8h-source.html#l00233">233</a> of file <a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a>.</p> 475 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li>
447 476 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">PluginLoader</a> </li>
448 </div> 477
449 </div><p> 478 <li class="footer">Generated on Tue Oct 4 2011 14:38:53 for VampPluginSDK by
450 <hr>The documentation for this class was generated from the following file:<ul> 479 <a href="http://www.doxygen.org/index.html">
451 <li><a class="el" href="PluginLoader_8h-source.html">PluginLoader.h</a></ul> 480 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
452 </div> 481 </ul>
453 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp; 482 </div>
454 <a href="http://www.doxygen.org/index.html"> 483
455 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 484
456 </body> 485 </body>
457 </html> 486 </html>