libinstpatch-doc 1.0.0-3 / usr / share / gtk-doc / html / libinstpatch / IpatchVBankInst.html

This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/IpatchVBankInst.html is in libinstpatch-doc 1.0.0-3.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchVBankInst</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="ch07.html" title="Virtual banks">
<link rel="prev" href="IpatchVBank.html" title="IpatchVBank">
<link rel="next" href="IpatchVBankRegion.html" title="IpatchVBankRegion">
<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="IpatchVBank.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.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="IpatchVBankRegion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchVBankInst.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchVBankInst.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchVBankInst.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#IpatchVBankInst.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchVBankInst">
<a name="IpatchVBankInst"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchVBankInst.top_of_page"></a>IpatchVBankInst</span></h2>
<p>IpatchVBankInst — VBank instrument item</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchVBankInst.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchVBankInst.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchVBankInst.html#IpatchVBankInst-struct"
>IpatchVBankInst</a>;
#define             <a
href="../libinstpatch/IpatchVBankInst.html#IPATCH-VBANK-INST-NAME-SIZE--CAPS"
>IPATCH_VBANK_INST_NAME_SIZE</a>
<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *   <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-new"
>ipatch_vbank_inst_new</a>               (void);
#define             <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-get-regions"
>ipatch_vbank_inst_get_regions</a>       (inst)
<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *   <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-first"
>ipatch_vbank_inst_first</a>             (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *   <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-next"
>ipatch_vbank_inst_next</a>              (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
void                <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-new-region"
>ipatch_vbank_inst_new_region</a>        (<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *inst,
                                                         <a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);
void                <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-set-midi-locale"
>ipatch_vbank_inst_set_midi_locale</a>   (<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *inst,
                                                         int bank,
                                                         int program);
void                <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-get-midi-locale"
>ipatch_vbank_inst_get_midi_locale</a>   (<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *inst,
                                                         int *bank,
                                                         int *program);
int                 <a
href="../libinstpatch/IpatchVBankInst.html#ipatch-vbank-inst-compare"
>ipatch_vbank_inst_compare</a>           (const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *p1,
                                                         const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *p2);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchVBankInst.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
         +----<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a>
               +----IpatchVBankInst
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchVBankInst.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a
href="../libinstpatch/IpatchVBankInst.html#IpatchVBankInst--bank"
>bank</a>"                     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write
  "<a
href="../libinstpatch/IpatchVBankInst.html#IpatchVBankInst--name"
>name</a>"                     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>*                : Read / Write
  "<a
href="../libinstpatch/IpatchVBankInst.html#IpatchVBankInst--program"
>program</a>"                  <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchVBankInst.description"></a><h2>Description</h2>
<p>
VBank instruments are children of <a
href="../libinstpatch/IpatchVBank.html"
><span class="type">IpatchVBank</span></a> objects and define individual
instruments mapped to MIDI bank/program numbers and which reference items
in other instrument files.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchVBankInst.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchVBankInst">
<a name="IpatchVBankInst-struct"></a><h3>IpatchVBankInst</h3>
<pre class="programlisting">typedef struct _IpatchVBankInst IpatchVBankInst;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_VBANK_INST_NAME_SIZE">
<a name="IPATCH-VBANK-INST-NAME-SIZE--CAPS"></a><h3>IPATCH_VBANK_INST_NAME_SIZE</h3>
<pre class="programlisting">#define IPATCH_VBANK_INST_NAME_SIZE	64
</pre>
<p>
Maximum length of a virtual bank instrument name.</p>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_new ()">
<a name="ipatch-vbank-inst-new"></a><h3>ipatch_vbank_inst_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *   ipatch_vbank_inst_new               (void);</pre>
<p>
Create a new virtual bank instrument object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New VBank instrument with a reference count of 1. Caller
owns the reference and removing it will destroy the item.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_get_regions()">
<a name="ipatch-vbank-inst-get-regions"></a><h3>ipatch_vbank_inst_get_regions()</h3>
<pre class="programlisting">#define             ipatch_vbank_inst_get_regions(inst)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_first ()">
<a name="ipatch-vbank-inst-first"></a><h3>ipatch_vbank_inst_first ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *   ipatch_vbank_inst_first             (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the first item in an instrument iterator. A convenience wrapper for
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-first"
><code class="function">ipatch_iter_first()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchVBankInst.html"
><span class="type">IpatchVBankInst</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first instrument in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if empty.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_next ()">
<a name="ipatch-vbank-inst-next"></a><h3>ipatch_vbank_inst_next ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *   ipatch_vbank_inst_next              (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the next item in an instrument iterator. A convenience wrapper for
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-next"
><code class="function">ipatch_iter_next()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchVBankInst.html"
><span class="type">IpatchVBankInst</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next instrument in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if at the end of the list.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_new_region ()">
<a name="ipatch-vbank-inst-new-region"></a><h3>ipatch_vbank_inst_new_region ()</h3>
<pre class="programlisting">void                ipatch_vbank_inst_new_region        (<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *inst,
                                                         <a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *item);</pre>
<p>
A convenience function for creating a new virtual bank region, adding it
to <em class="parameter"><code>inst</code></em> and setting the region's referenced item to <em class="parameter"><code>item</code></em>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inst</code></em> :</span></p></td>
<td> VBank instrument
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Referenced item for new region
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_set_midi_locale ()">
<a name="ipatch-vbank-inst-set-midi-locale"></a><h3>ipatch_vbank_inst_set_midi_locale ()</h3>
<pre class="programlisting">void                ipatch_vbank_inst_set_midi_locale   (<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *inst,
                                                         int bank,
                                                         int program);</pre>
<p>
Sets the MIDI locale of an instrument (bank and program numbers).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inst</code></em> :</span></p></td>
<td> Virtual bank instrument to set MIDI locale of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bank</code></em> :</span></p></td>
<td> MIDI bank number to assign to instrument
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td> MIDI program number to assign to instrument
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_get_midi_locale ()">
<a name="ipatch-vbank-inst-get-midi-locale"></a><h3>ipatch_vbank_inst_get_midi_locale ()</h3>
<pre class="programlisting">void                ipatch_vbank_inst_get_midi_locale   (<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *inst,
                                                         int *bank,
                                                         int *program);</pre>
<p>
Gets the MIDI locale of a virtual bank instrument (bank and program numbers).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>inst</code></em> :</span></p></td>
<td> Virtual bank instrument to get MIDI locale from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bank</code></em> :</span></p></td>
<td> Location to store instrument's MIDI bank number or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td> Location to store instrument's MIDI program number or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_inst_compare ()">
<a name="ipatch-vbank-inst-compare"></a><h3>ipatch_vbank_inst_compare ()</h3>
<pre class="programlisting">int                 ipatch_vbank_inst_compare           (const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *p1,
                                                         const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *p2);</pre>
<p>
Virtual bank instrument comparison function for sorting. Compare two
instruments by their MIDI bank:program numbers. Note that this function is
compatible with GCompareFunc and can therefore be used with g_list_sort, etc.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>p1</code></em> :</span></p></td>
<td> First instrument in comparison
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>p2</code></em> :</span></p></td>
<td> Second instrument in comparison
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Comparison result that is less than, equal to, or greater than zero
if <em class="parameter"><code>p1</code></em> is found, respectively, to be less than, to match, or be greater
than <em class="parameter"><code>p2</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchVBankInst.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "bank" property'>
<a name="IpatchVBankInst--bank"></a><h3>The <code class="literal">"bank"</code> property</h3>
<pre class="programlisting">  "bank"                     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write</pre>
<p>MIDI bank number.</p>
<p>Allowed values: [0,128]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "name" property'>
<a name="IpatchVBankInst--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting">  "name"                     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>*                : Read / Write</pre>
<p>Name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "program" property'>
<a name="IpatchVBankInst--program"></a><h3>The <code class="literal">"program"</code> property</h3>
<pre class="programlisting">  "program"                  <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write</pre>
<p>MIDI program number.</p>
<p>Allowed values: [0,127]</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="IpatchVBankInst.see-also"></a><h2>See Also</h2>
#IpatchVBank
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.