Mercurial > hg > vamp-docs

comparison code-docs/classVamp_1_1HostExt_1_1PluginLoader.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

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