This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchSF2ModItem.html is in libinstpatch-doc 1.0.0-7.

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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSF2ModItem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch05.html" title="SoundFont patches">
<link rel="prev" href="libinstpatch-IpatchSF2Mod.html" title="IpatchSF2Mod">
<link rel="next" href="IpatchSF2PZone.html" title="IpatchSF2PZone">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libinstpatch-IpatchSF2Mod.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="IpatchSF2PZone.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libinstpatch-IpatchSF2ModItem.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libinstpatch-IpatchSF2ModItem.description" class="shortcut">Description</a>
                 | 
                <a href="#libinstpatch-IpatchSF2ModItem.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#libinstpatch-IpatchSF2ModItem.prerequisites" class="shortcut">Prerequisites</a>
                 | 
                <a href="#libinstpatch-IpatchSF2ModItem.implementations" class="shortcut">Known Implementations</a>
                 | 
                <a href="#libinstpatch-IpatchSF2ModItem.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSF2ModItem">
<a name="libinstpatch-IpatchSF2ModItem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchSF2ModItem.top_of_page"></a>IpatchSF2ModItem</span></h2>
<p>IpatchSF2ModItem — SoundFont modulator item interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchSF2ModItem.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchSF2ModItem.synopsis"></a><h2>Synopsis</h2>
<a name="IpatchSF2ModItemIface"></a><pre class="synopsis">
typedef             <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a>;
                    <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItemIface-struct"
>IpatchSF2ModItemIface</a>;
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#ipatch-sf2-mod-item-add"
>ipatch_sf2_mod_item_add</a>             (item, mod)
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *            <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#ipatch-sf2-mod-item-get-mods"
>ipatch_sf2_mod_item_get_mods</a>        (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#ipatch-sf2-mod-item-set-mods"
>ipatch_sf2_mod_item_set_mods</a>        (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mod_list,
                                                         int flags);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#ipatch-sf2-mod-item-insert"
>ipatch_sf2_mod_item_insert</a>          (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod,
                                                         int pos);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#ipatch-sf2-mod-item-remove"
>ipatch_sf2_mod_item_remove</a>          (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#ipatch-sf2-mod-item-change"
>ipatch_sf2_mod_item_change</a>          (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *oldmod,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *newmod);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>               <a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#ipatch-sf2-mod-item-count"
>ipatch_sf2_mod_item_count</a>           (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="libinstpatch-IpatchSF2ModItem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----IpatchSF2ModItemIface
</pre>
</div>
<div class="refsect1" title="Prerequisites">
<a name="libinstpatch-IpatchSF2ModItem.prerequisites"></a><h2>Prerequisites</h2>
<p>
IpatchSF2ModItemIface requires
 <a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>.</p>
</div>
<div class="refsect1" title="Known Implementations">
<a name="libinstpatch-IpatchSF2ModItem.implementations"></a><h2>Known Implementations</h2>
<p>
IpatchSF2ModItemIface is implemented by
 <a
href="../libinstpatch/IpatchSF2Inst.html"
>IpatchSF2Inst</a>,  <a
href="../libinstpatch/IpatchSF2Zone.html"
>IpatchSF2Zone</a>,  <a
href="../libinstpatch/IpatchSF2PZone.html"
>IpatchSF2PZone</a>,  <a
href="../libinstpatch/IpatchSF2IZone.html"
>IpatchSF2IZone</a> and  <a
href="../libinstpatch/IpatchSF2Preset.html"
>IpatchSF2Preset</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="libinstpatch-IpatchSF2ModItem.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItemIface--modulators"
>modulators</a>"               <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModList"
>IpatchSF2ModList</a>*     : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchSF2ModItem.description"></a><h2>Description</h2>
<p>
An interface type which is used by <a
href="../libinstpatch/IpatchSF2Preset.html"
><span class="type">IpatchSF2Preset</span></a>, <a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a>,
<a
href="../libinstpatch/IpatchSF2PZone.html"
><span class="type">IpatchSF2PZone</span></a> and <a
href="../libinstpatch/IpatchSF2IZone.html"
><span class="type">IpatchSF2IZone</span></a> objects to add modulator realtime effect
functionality.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchSF2ModItem.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSF2ModItem">
<a name="IpatchSF2ModItem"></a><h3>IpatchSF2ModItem</h3>
<pre class="programlisting">typedef IpatchItem IpatchSF2ModItem;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2ModItemIface">
<a name="IpatchSF2ModItemIface-struct"></a><h3>IpatchSF2ModItemIface</h3>
<pre class="programlisting">typedef struct _IpatchSF2ModItemIface IpatchSF2ModItemIface;</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_item_add()">
<a name="ipatch-sf2-mod-item-add"></a><h3>ipatch_sf2_mod_item_add()</h3>
<pre class="programlisting">#define             ipatch_sf2_mod_item_add(item, mod)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_item_get_mods ()">
<a name="ipatch-sf2-mod-item-get-mods"></a><h3>ipatch_sf2_mod_item_get_mods ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *            ipatch_sf2_mod_item_get_mods        (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item);</pre>
<p>
Gets a list of modulators from an item with modulators. List should be freed
with <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-free"
><code class="function">ipatch_sf2_mod_list_free()</code></a> (free_mods set to <code class="literal">TRUE</code>) when finished
with it.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with modulators
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New list of modulators (<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
><span class="type">IpatchSF2Mod</span></a>) in <em class="parameter"><code>item</code></em> or <code class="literal">NULL</code> if no
modulators. Remember to free it with <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-free"
><code class="function">ipatch_sf2_mod_list_free()</code></a> when finished.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_item_set_mods ()">
<a name="ipatch-sf2-mod-item-set-mods"></a><h3>ipatch_sf2_mod_item_set_mods ()</h3>
<pre class="programlisting">void                ipatch_sf2_mod_item_set_mods        (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mod_list,
                                                         int flags);</pre>
<p>
Sets the complete modulator list of an item with modulators.
If <span class="type">IPATCH_SF2_MOD_NO_NOTIFY</span> is not in <em class="parameter"><code>flags</code></em> then <a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> property
notify is done.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with modulators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mod_list</code></em> :</span></p></td>
<td> Modulator list to assign to zone.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td> Flags for controlling list duplication and item property
  notification (<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModFlags"
><span class="type">IpatchSF2ModFlags</span></a>).  If <span class="type">IPATCH_SF2_MOD_NO_DUPLICATE</span>
  is set then ownership of <em class="parameter"><code>mod_list</code></em> is taken over (not duplicated).
  If <span class="type">IPATCH_SF2_MOD_NO_NOTIFY</span> is set, then item property notify will not
  be done.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_item_insert ()">
<a name="ipatch-sf2-mod-item-insert"></a><h3>ipatch_sf2_mod_item_insert ()</h3>
<pre class="programlisting">void                ipatch_sf2_mod_item_insert          (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod,
                                                         int pos);</pre>
<p>
Inserts a modulator into an item's modulator list. Does not check for
duplicates! The modulator is not used directly, a new one is created and
the values in <em class="parameter"><code>mod</code></em> are copied to it.
An <a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> property notify is done.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with modulators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mod</code></em> :</span></p></td>
<td> Modulator to insert (a new modulator is created and the
  values are copied to it)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Index position in zone's modulator list to insert
  (0 = first, &lt; 0 = last)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_item_remove ()">
<a name="ipatch-sf2-mod-item-remove"></a><h3>ipatch_sf2_mod_item_remove ()</h3>
<pre class="programlisting">void                ipatch_sf2_mod_item_remove          (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);</pre>
<p>
Remove a modulator from an item with modulators. The modulator values in <em class="parameter"><code>mod</code></em>
are used to search the modulator list. The first modulator
that matches all fields in <em class="parameter"><code>mod</code></em> is removed.
An <a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> property notify is done.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with modulators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mod</code></em> :</span></p></td>
<td> Matching values of modulator to remove
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_item_change ()">
<a name="ipatch-sf2-mod-item-change"></a><h3>ipatch_sf2_mod_item_change ()</h3>
<pre class="programlisting">void                ipatch_sf2_mod_item_change          (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *oldmod,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *newmod);</pre>
<p>
Sets the values of an existing modulator in an item with modulators. The
modulator list in item is searched for a modulator that matches the values in
<em class="parameter"><code>oldmod</code></em>. If a modulator is found its values are set to those in <em class="parameter"><code>newmod</code></em>.
If it is not found, nothing is done.
If change occurs <a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> property notify is done.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with modulators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>oldmod</code></em> :</span></p></td>
<td> Current values of modulator to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>newmod</code></em> :</span></p></td>
<td> New modulator values
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_item_count ()">
<a name="ipatch-sf2-mod-item-count"></a><h3>ipatch_sf2_mod_item_count ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>               ipatch_sf2_mod_item_count           (<a
href="../libinstpatch/libinstpatch-IpatchSF2ModItem.html#IpatchSF2ModItem"
>IpatchSF2ModItem</a> *item);</pre>
<p>
Count number of modulators in an item with modulators.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with modulators
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Count of modulators
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="libinstpatch-IpatchSF2ModItem.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "modulators" property'>
<a name="IpatchSF2ModItemIface--modulators"></a><h3>The <code class="literal">"modulators"</code> property</h3>
<pre class="programlisting">  "modulators"               <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModList"
>IpatchSF2ModList</a>*     : Read / Write</pre>
<p>Modulators.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>