libinstpatch-doc 1.0.0-6 / usr / share / gtk-doc / html / libinstpatch / IpatchVBankRegion.html

This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/IpatchVBankRegion.html is in libinstpatch-doc 1.0.0-6.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchVBankRegion</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="IpatchVBankInst.html" title="IpatchVBankInst">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<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="IpatchVBankInst.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="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchVBankRegion.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchVBankRegion.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchVBankRegion.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#IpatchVBankRegion.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchVBankRegion">
<a name="IpatchVBankRegion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchVBankRegion.top_of_page"></a>IpatchVBankRegion</span></h2>
<p>IpatchVBankRegion — Virtual bank instrument region</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchVBankRegion.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchVBankRegion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion-struct"
>IpatchVBankRegion</a>;
enum                <a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegionNoteRangeMode"
>IpatchVBankRegionNoteRangeMode</a>;
enum                <a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegionRootNoteMode"
>IpatchVBankRegionRootNoteMode</a>;
<a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> * <a
href="../libinstpatch/IpatchVBankRegion.html#ipatch-vbank-region-new"
>ipatch_vbank_region_new</a>             (void);
<a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> * <a
href="../libinstpatch/IpatchVBankRegion.html#ipatch-vbank-region-first"
>ipatch_vbank_region_first</a>           (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
<a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> * <a
href="../libinstpatch/IpatchVBankRegion.html#ipatch-vbank-region-next"
>ipatch_vbank_region_next</a>            (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
void                <a
href="../libinstpatch/IpatchVBankRegion.html#ipatch-vbank-region-set-id-props"
>ipatch_vbank_region_set_id_props</a>    (<a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> *region,
                                                         char **id_props);
char **             <a
href="../libinstpatch/IpatchVBankRegion.html#ipatch-vbank-region-get-id-props"
>ipatch_vbank_region_get_id_props</a>    (<a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> *region,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *n_elements);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchVBankRegion.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
         +----IpatchVBankRegion
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchVBankRegion.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion--file-index"
>file-index</a>"               <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>                 : Read
  "<a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion--id-props"
>id-props</a>"                 <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"
>GValueArray</a>*          : Read / Write
  "<a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion--link-item"
>link-item</a>"                <a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>*           : Read / Write
  "<a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion--note-range"
>note-range</a>"               <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a>*          : Read / Write
  "<a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion--note-range-mode"
>note-range-mode</a>"          <a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegionNoteRangeMode"
>IpatchVBankRegionNoteRangeMode</a>  : Read / Write
  "<a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion--root-note"
>root-note</a>"                <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write
  "<a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegion--root-note-mode"
>root-note-mode</a>"           <a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegionRootNoteMode"
>IpatchVBankRegionRootNoteMode</a>  : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchVBankRegion.description"></a><h2>Description</h2>
<p>
Virtual bank regions are children to <a
href="../libinstpatch/IpatchVBankInst.html"
><span class="type">IpatchVBankInst</span></a> objects and reference
synthesizable <a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> objects from other files.  This object forms the
bases for constructing new instruments from one or more items in other
instrument bank files.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchVBankRegion.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchVBankRegion">
<a name="IpatchVBankRegion-struct"></a><h3>IpatchVBankRegion</h3>
<pre class="programlisting">typedef struct _IpatchVBankRegion IpatchVBankRegion;</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchVBankRegionNoteRangeMode">
<a name="IpatchVBankRegionNoteRangeMode"></a><h3>enum IpatchVBankRegionNoteRangeMode</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_VBANK_REGION_NOTE_RANGE_MODE_INTERSECT	= 0,
  IPATCH_VBANK_REGION_NOTE_RANGE_MODE_OVERRIDE	= 1
} IpatchVBankRegionNoteRangeMode;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchVBankRegionRootNoteMode">
<a name="IpatchVBankRegionRootNoteMode"></a><h3>enum IpatchVBankRegionRootNoteMode</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_VBANK_REGION_ROOT_NOTE_MODE_OFFSET	= 0,
  IPATCH_VBANK_REGION_ROOT_NOTE_MODE_OVERRIDE	= 1
} IpatchVBankRegionRootNoteMode;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_region_new ()">
<a name="ipatch-vbank-region-new"></a><h3>ipatch_vbank_region_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> * ipatch_vbank_region_new             (void);</pre>
<p>
Create a new virtual bank region 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 virtual bank region with a reference count of 1. Caller
owns the reference and removing it will destroy the item, unless another
reference is added (if its parented for example).
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_region_first ()">
<a name="ipatch-vbank-region-first"></a><h3>ipatch_vbank_region_first ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> * ipatch_vbank_region_first           (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the first item in a virtual bank region 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/IpatchVBankRegion.html"
><span class="type">IpatchVBankRegion</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first virtual bank region 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_region_next ()">
<a name="ipatch-vbank-region-next"></a><h3>ipatch_vbank_region_next ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> * ipatch_vbank_region_next            (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the next item in a virtual bank region 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/IpatchVBankRegion.html"
><span class="type">IpatchVBankRegion</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next virtual bank region 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_region_set_id_props ()">
<a name="ipatch-vbank-region-set-id-props"></a><h3>ipatch_vbank_region_set_id_props ()</h3>
<pre class="programlisting">void                ipatch_vbank_region_set_id_props    (<a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> *region,
                                                         char **id_props);</pre>
<p>
Set the ID properties of a virtual bank region.  These are used to uniquely
identify an item in an external instrument file.  This function is likely
only used by the VBank loader before an item is resolved.  Normal users
will likely just assign to the "item-link" parameter.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>region</code></em> :</span></p></td>
<td> VBank region
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id_props</code></em> :</span></p></td>
<td> NULL terminated array of name/value string pairs
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_region_get_id_props ()">
<a name="ipatch-vbank-region-get-id-props"></a><h3>ipatch_vbank_region_get_id_props ()</h3>
<pre class="programlisting">char **             ipatch_vbank_region_get_id_props    (<a
href="../libinstpatch/IpatchVBankRegion.html"
>IpatchVBankRegion</a> *region,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *n_elements);</pre>
<p>
Get ID properties which uniquely identify the referenced item.  These are
usually only available until the item gets resolved, at which point
"item-link" is set.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>region</code></em> :</span></p></td>
<td> VBank region
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_elements</code></em> :</span></p></td>
<td> Pointer to store count of elements in returned string array
  or <code class="literal">NULL</code> to ignore.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">NULL</code> terminated array of name/value pair property strings or
<code class="literal">NULL</code> if none.  Free with <a
href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"
><code class="function">g_strfreev()</code></a> when finished using it.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchVBankRegion.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "file-index" property'>
<a name="IpatchVBankRegion--file-index"></a><h3>The <code class="literal">"file-index"</code> property</h3>
<pre class="programlisting">  "file-index"               <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>                 : Read</pre>
<p>File index.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "id-props" property'>
<a name="IpatchVBankRegion--id-props"></a><h3>The <code class="literal">"id-props"</code> property</h3>
<pre class="programlisting">  "id-props"                 <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"
>GValueArray</a>*          : Read / Write</pre>
<p>Identification properties.</p>
</div>
<hr>
<div class="refsect2" title='The "link-item" property'>
<a name="IpatchVBankRegion--link-item"></a><h3>The <code class="literal">"link-item"</code> property</h3>
<pre class="programlisting">  "link-item"                <a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>*           : Read / Write</pre>
<p>Link item.</p>
</div>
<hr>
<div class="refsect2" title='The "note-range" property'>
<a name="IpatchVBankRegion--note-range"></a><h3>The <code class="literal">"note-range"</code> property</h3>
<pre class="programlisting">  "note-range"               <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a>*          : Read / Write</pre>
<p>Note range.</p>
</div>
<hr>
<div class="refsect2" title='The "note-range-mode" property'>
<a name="IpatchVBankRegion--note-range-mode"></a><h3>The <code class="literal">"note-range-mode"</code> property</h3>
<pre class="programlisting">  "note-range-mode"          <a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegionNoteRangeMode"
>IpatchVBankRegionNoteRangeMode</a>  : Read / Write</pre>
<p>Note range mode.</p>
<p>Default value: IPATCH_VBANK_REGION_NOTE_RANGE_MODE_INTERSECT</p>
</div>
<hr>
<div class="refsect2" title='The "root-note" property'>
<a name="IpatchVBankRegion--root-note"></a><h3>The <code class="literal">"root-note"</code> property</h3>
<pre class="programlisting">  "root-note"                <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write</pre>
<p>Root note.</p>
<p>Allowed values: [-127,127]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "root-note-mode" property'>
<a name="IpatchVBankRegion--root-note-mode"></a><h3>The <code class="literal">"root-note-mode"</code> property</h3>
<pre class="programlisting">  "root-note-mode"           <a
href="../libinstpatch/IpatchVBankRegion.html#IpatchVBankRegionRootNoteMode"
>IpatchVBankRegionRootNoteMode</a>  : Read / Write</pre>
<p>Root note mode.</p>
<p>Default value: IPATCH_VBANK_REGION_ROOT_NOTE_MODE_OFFSET</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="IpatchVBankRegion.see-also"></a><h2>See Also</h2>
#IpatchVBankInst, <a
href="../libinstpatch/IpatchVBank.html"
><span class="type">IpatchVBank</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.