slv2-doc 0.6.6+dfsg1-2 / usr / share / doc / slv2 / group__slv2__world.html

This file is indexed.

/usr/share/doc/slv2/group__slv2__world.html is in slv2-doc 0.6.6+dfsg1-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>SLV2: Global library state</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">SLV2
   &#160;<span id="projectnumber">0.6.6</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Global library state</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2World&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#ga994e0c72ea68695a53e58062142265c4">slv2_world_new</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#ga659baac5e9a3959dd4c2b6a660bce372">slv2_world_free</a> (SLV2World world)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#gad1511da527acc874e83287206d9f07c0">slv2_world_load_all</a> (SLV2World world)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#ga8d1cf0231b1765930850d1d728f33888">slv2_world_load_bundle</a> (SLV2World world, SLV2Value bundle_uri)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2PluginClass&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#ga6da06ff9500eb1675d37570b4d82b90b">slv2_world_get_plugin_class</a> (SLV2World world)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2PluginClasses&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#ga2f288d8a323e2f834b029da0e4254e63">slv2_world_get_plugin_classes</a> (SLV2World world)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2Plugins&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#ga9b095ba2f57f83510caa01dfc5a42cd7">slv2_world_get_all_plugins</a> (SLV2World world)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2Plugins&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__world.html#ga67db64e62f7bdade9de8e3eaeb4d219b">slv2_world_get_plugins_by_filter</a> (SLV2World world, bool(*include)(SLV2Plugin))</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Plugins (and plugin extensions) and the LV2 specification (and LV2 extensions) itself can be queried from the world for use.</p>
<p>Normal hosts which just want to easily load plugins by URI are strongly recommended to simply call <a class="el" href="group__slv2__world.html#gad1511da527acc874e83287206d9f07c0">slv2_world_load_all</a> to find all installed data in the recommended way.</p>
<p>Normal hosts should NOT have to refer to bundles directly under normal circumstances. However, functions are provided to load individual bundles explicitly, intended for hosts which depend on a specific bundle (which is shipped with the application). </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga994e0c72ea68695a53e58062142265c4"></a><!-- doxytag: member="world.h::slv2_world_new" ref="ga994e0c72ea68695a53e58062142265c4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SLV2World <a class="el" href="group__slv2__world.html#ga994e0c72ea68695a53e58062142265c4">slv2_world_new</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialize a new, empty world. </p>
<p>If initialization fails, NULL is returned. </p>

</div>
</div>
<a class="anchor" id="ga659baac5e9a3959dd4c2b6a660bce372"></a><!-- doxytag: member="world.h::slv2_world_free" ref="ga659baac5e9a3959dd4c2b6a660bce372" args="(SLV2World world)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__slv2__world.html#ga659baac5e9a3959dd4c2b6a660bce372">slv2_world_free</a> </td>
          <td>(</td>
          <td class="paramtype">SLV2World&#160;</td>
          <td class="paramname"><em>world</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destroy the world, mwahaha. </p>
<p>NB: Destroying the world will leave dangling references in any plugin lists, plugins, etc. Do not destroy the world until you are finished with all objects that came from it. </p>

</div>
</div>
<a class="anchor" id="gad1511da527acc874e83287206d9f07c0"></a><!-- doxytag: member="world.h::slv2_world_load_all" ref="gad1511da527acc874e83287206d9f07c0" args="(SLV2World world)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__slv2__world.html#gad1511da527acc874e83287206d9f07c0">slv2_world_load_all</a> </td>
          <td>(</td>
          <td class="paramtype">SLV2World&#160;</td>
          <td class="paramname"><em>world</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Load all installed LV2 bundles on the system. </p>
<p>This is the recommended way for hosts to load LV2 data. It does the most reasonable thing to find all installed plugins, extensions, etc. on the system. The environment variable LV2_PATH may be used to set the directories inside which this function will look for bundles. Otherwise a sensible, standard default will be used.</p>
<p>Use of other functions for loading bundles is <em>highly</em> discouraged without a special reason to do so - use this one.</p>
<p>Time = Query </p>

</div>
</div>
<a class="anchor" id="ga8d1cf0231b1765930850d1d728f33888"></a><!-- doxytag: member="world.h::slv2_world_load_bundle" ref="ga8d1cf0231b1765930850d1d728f33888" args="(SLV2World world, SLV2Value bundle_uri)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__slv2__world.html#ga8d1cf0231b1765930850d1d728f33888">slv2_world_load_bundle</a> </td>
          <td>(</td>
          <td class="paramtype">SLV2World&#160;</td>
          <td class="paramname"><em>world</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">SLV2Value&#160;</td>
          <td class="paramname"><em>bundle_uri</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Load a specific bundle. </p>
<ul>
<li>bundle_uri A fully qualified URI to the bundle directory, with the trailing slash, eg. <a href="file:///usr/lib/lv2/someBundle/">file:///usr/lib/lv2/someBundle/</a></li>
</ul>
<p>Normal hosts should not use this function.</p>
<p>Hosts should <b>never</b> attach any long-term significance to bundle paths as there are no guarantees they will remain consistent whatsoever. Plugins (and other things) are identified by URIs, <b>not</b> bundle or file names.</p>
<p>This function should only be used by apps which ship with a special bundle (which it knows exists at some path because the bundle is shipped with the application).</p>
<p>Time = Query </p>

</div>
</div>
<a class="anchor" id="ga6da06ff9500eb1675d37570b4d82b90b"></a><!-- doxytag: member="world.h::slv2_world_get_plugin_class" ref="ga6da06ff9500eb1675d37570b4d82b90b" args="(SLV2World world)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SLV2PluginClass <a class="el" href="group__slv2__world.html#ga6da06ff9500eb1675d37570b4d82b90b">slv2_world_get_plugin_class</a> </td>
          <td>(</td>
          <td class="paramtype">SLV2World&#160;</td>
          <td class="paramname"><em>world</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the parent of all other plugin classes, lv2:Plugin. </p>
<p>Time = O(1) </p>

</div>
</div>
<a class="anchor" id="ga2f288d8a323e2f834b029da0e4254e63"></a><!-- doxytag: member="world.h::slv2_world_get_plugin_classes" ref="ga2f288d8a323e2f834b029da0e4254e63" args="(SLV2World world)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SLV2PluginClasses <a class="el" href="group__slv2__world.html#ga2f288d8a323e2f834b029da0e4254e63">slv2_world_get_plugin_classes</a> </td>
          <td>(</td>
          <td class="paramtype">SLV2World&#160;</td>
          <td class="paramname"><em>world</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return a list of all found plugin classes. </p>
<p>Returned list is owned by world and must not be freed by the caller.</p>
<p>Time = O(1) </p>

</div>
</div>
<a class="anchor" id="ga9b095ba2f57f83510caa01dfc5a42cd7"></a><!-- doxytag: member="world.h::slv2_world_get_all_plugins" ref="ga9b095ba2f57f83510caa01dfc5a42cd7" args="(SLV2World world)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SLV2Plugins <a class="el" href="group__slv2__world.html#ga9b095ba2f57f83510caa01dfc5a42cd7">slv2_world_get_all_plugins</a> </td>
          <td>(</td>
          <td class="paramtype">SLV2World&#160;</td>
          <td class="paramname"><em>world</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return a list of all found plugins. </p>
<p>The returned list contains just enough references to query or instantiate plugins. The data for a particular plugin will not be loaded into memory until a call to an slv2_plugin_* function results in a query (at which time the data is cached with the SLV2Plugin so future queries are very fast).</p>
<p>Returned list must be freed by user with slv2_plugins_free. The contained plugins are owned by <em>world</em> and must not be freed by caller.</p>
<p>Time = O(1) </p>

</div>
</div>
<a class="anchor" id="ga67db64e62f7bdade9de8e3eaeb4d219b"></a><!-- doxytag: member="world.h::slv2_world_get_plugins_by_filter" ref="ga67db64e62f7bdade9de8e3eaeb4d219b" args="(SLV2World world, bool(*include)(SLV2Plugin))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SLV2Plugins <a class="el" href="group__slv2__world.html#ga67db64e62f7bdade9de8e3eaeb4d219b">slv2_world_get_plugins_by_filter</a> </td>
          <td>(</td>
          <td class="paramtype">SLV2World&#160;</td>
          <td class="paramname"><em>world</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool(*)(SLV2Plugin)&#160;</td>
          <td class="paramname"><em>include</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return a list of found plugins filtered by a user-defined filter function. </p>
<p>All plugins currently found in <em>world</em> that return true when passed to <em>include</em> (a pointer to a function which takes an SLV2Plugin and returns a bool) will be in the returned list.</p>
<p>Returned list must be freed by user with slv2_plugins_free. The contained plugins are owned by <em>world</em> and must not be freed by caller.</p>
<p>Time = O(n * Time(include)) </p>

</div>
</div>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Mon May 14 2012 17:37:43 for SLV2 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>

APT Browse - Built by Thomas Orozco.