<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: PluginManager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classPluginManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PluginManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This manager provides utilities for plugin loading.
<a href="classPluginManager.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PluginManager_8h_source.html">PluginManager.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a40285cffc96d5d0c7f3f7f9d8eec1b54"><td class="memItemLeft" align="right" valign="top">static void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluginManager.html#a40285cffc96d5d0c7f3f7f9d8eec1b54">openLibrary</a> (const std::string &path)</td></tr>
<tr class="memdesc:a40285cffc96d5d0c7f3f7f9d8eec1b54"><td class="mdescLeft"> </td><td class="mdescRight">Opens a shared library. <a href="#a40285cffc96d5d0c7f3f7f9d8eec1b54">More...</a><br /></td></tr>
<tr class="separator:a40285cffc96d5d0c7f3f7f9d8eec1b54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6fd9644ff39ff0f14c8273ce58b4aa0"><td class="memItemLeft" align="right" valign="top">static void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluginManager.html#aa6fd9644ff39ff0f14c8273ce58b4aa0">lookupLibrary</a> (void *handle, const std::string &name)</td></tr>
<tr class="memdesc:aa6fd9644ff39ff0f14c8273ce58b4aa0"><td class="mdescLeft"> </td><td class="mdescRight">Looks up a symbol from an opened library. <a href="#aa6fd9644ff39ff0f14c8273ce58b4aa0">More...</a><br /></td></tr>
<tr class="separator:aa6fd9644ff39ff0f14c8273ce58b4aa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e9a397280e8068a59872ee83573a3a8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluginManager.html#a6e9a397280e8068a59872ee83573a3a8">closeLibrary</a> (void *handle)</td></tr>
<tr class="memdesc:a6e9a397280e8068a59872ee83573a3a8"><td class="mdescLeft"> </td><td class="mdescRight">Closes an opened shared library. <a href="#a6e9a397280e8068a59872ee83573a3a8">More...</a><br /></td></tr>
<tr class="separator:a6e9a397280e8068a59872ee83573a3a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9d9bed28b7e9b335ed00499161c6217"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluginManager.html#ad9d9bed28b7e9b335ed00499161c6217">loadPlugin</a> (const std::string &path)</td></tr>
<tr class="memdesc:ad9d9bed28b7e9b335ed00499161c6217"><td class="mdescLeft"> </td><td class="mdescRight">Loads a plugin from a file. <a href="#ad9d9bed28b7e9b335ed00499161c6217">More...</a><br /></td></tr>
<tr class="separator:ad9d9bed28b7e9b335ed00499161c6217"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f039374823ff758c27c497c07add0a1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluginManager.html#a7f039374823ff758c27c497c07add0a1">loadPlugins</a> (const std::string &path="")</td></tr>
<tr class="memdesc:a7f039374823ff758c27c497c07add0a1"><td class="mdescLeft"> </td><td class="mdescRight">Loads all plugins found in a folder. <a href="#a7f039374823ff758c27c497c07add0a1">More...</a><br /></td></tr>
<tr class="separator:a7f039374823ff758c27c497c07add0a1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This manager provides utilities for plugin loading. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6e9a397280e8068a59872ee83573a3a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e9a397280e8068a59872ee83573a3a8">◆ </a></span>closeLibrary()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PluginManager::closeLibrary </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes an opened shared library. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to the library to be closed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad9d9bed28b7e9b335ed00499161c6217"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9d9bed28b7e9b335ed00499161c6217">◆ </a></span>loadPlugin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool PluginManager::loadPlugin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads a plugin from a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The path to the file. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the file could successfully be loaded. </dd></dl>
</div>
</div>
<a id="a7f039374823ff758c27c497c07add0a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f039374823ff758c27c497c07add0a1">◆ </a></span>loadPlugins()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void PluginManager::loadPlugins </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em> = <code>""</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads all plugins found in a folder. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The path to the folder containing the plugins. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa6fd9644ff39ff0f14c8273ce58b4aa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6fd9644ff39ff0f14c8273ce58b4aa0">◆ </a></span>lookupLibrary()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void* PluginManager::lookupLibrary </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks up a symbol from an opened library. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to the opened library. </td></tr>
<tr><td class="paramname">name</td><td>The name of the symbol to look up. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The symbol or nullptr if the symbol was not found. </dd></dl>
</div>
</div>
<a id="a40285cffc96d5d0c7f3f7f9d8eec1b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40285cffc96d5d0c7f3f7f9d8eec1b54">◆ </a></span>openLibrary()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void* PluginManager::openLibrary </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a shared library. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The path to the file. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A handle to the library or nullptr if opening failed. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>plugin/<a class="el" href="PluginManager_8h_source.html">PluginManager.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1205
