This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/IpatchGigSubRegion.html is in libinstpatch-doc 1.0.0-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
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
431
432
433
434
435
436
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchGigSubRegion</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="ch06.html" title="GigaSampler patches">
<link rel="prev" href="IpatchGigDimension.html" title="IpatchGigDimension">
<link rel="next" href="libinstpatch-IpatchGigEffects.html" title="IpatchGigEffects">
<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="IpatchGigDimension.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.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="libinstpatch-IpatchGigEffects.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchGigSubRegion.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchGigSubRegion.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchGigSubRegion.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#IpatchGigSubRegion.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                 | 
                <a href="#IpatchGigSubRegion.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchGigSubRegion">
<a name="IpatchGigSubRegion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchGigSubRegion.top_of_page"></a>IpatchGigSubRegion</span></h2>
<p>IpatchGigSubRegion — GigaSampler sub region object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchGigSubRegion.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchGigSubRegion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion-struct"
>IpatchGigSubRegion</a>;
enum                <a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegionFlags"
>IpatchGigSubRegionFlags</a>;
#define             <a
href="../libinstpatch/IpatchGigSubRegion.html#IPATCH-GIG-SUB-REGION-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_GIG_SUB_REGION_UNUSED_FLAG_SHIFT</a>
<a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> * <a
href="../libinstpatch/IpatchGigSubRegion.html#ipatch-gig-sub-region-new"
>ipatch_gig_sub_region_new</a>          (void);
<a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> * <a
href="../libinstpatch/IpatchGigSubRegion.html#ipatch-gig-sub-region-first"
>ipatch_gig_sub_region_first</a>        (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
<a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> * <a
href="../libinstpatch/IpatchGigSubRegion.html#ipatch-gig-sub-region-next"
>ipatch_gig_sub_region_next</a>         (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
<a
href="../libinstpatch/IpatchGigSample.html"
>IpatchGigSample</a> *   <a
href="../libinstpatch/IpatchGigSubRegion.html#ipatch-gig-sub-region-get-sample"
>ipatch_gig_sub_region_get_sample</a>    (<a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> *subregion);
void                <a
href="../libinstpatch/IpatchGigSubRegion.html#ipatch-gig-sub-region-set-sample"
>ipatch_gig_sub_region_set_sample</a>    (<a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> *subregion,
                                                         <a
href="../libinstpatch/IpatchGigSample.html"
>IpatchGigSample</a> *sample);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchGigSubRegion.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>
         +----IpatchGigSubRegion
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchGigSubRegion.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchGigSubRegion implements
 <a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchGigSubRegion.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--fine-tune"
>fine-tune</a>"                <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--flags"
>flags</a>"                    <a
href="../libinstpatch/IpatchDLS2Sample.html#IpatchDLS2SampleFlags"
>IpatchDLS2SampleFlags</a>  : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--gain"
>gain</a>"                     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--link-item"
>link-item</a>"                <a
href="../libinstpatch/IpatchGigSample.html"
>IpatchGigSample</a>*      : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--loop-end"
>loop-end</a>"                 <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a>                 : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--loop-start"
>loop-start</a>"               <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a>                 : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--loop-type"
>loop-type</a>"                <a
href="../libinstpatch/IpatchSample.html#IpatchSampleLoopType"
>IpatchSampleLoopType</a>  : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--root-note"
>root-note</a>"                <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write
  "<a
href="../libinstpatch/IpatchGigSubRegion.html#IpatchGigSubRegion--sample-info-override"
>sample-info-override</a>"     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchGigSubRegion.description"></a><h2>Description</h2>
<p>
Defines a GigaSampler sub region object which are children of
<a
href="../libinstpatch/IpatchGigRegion.html"
><span class="type">IpatchGigRegion</span></a> objects and define how a referenced <a
href="../libinstpatch/IpatchGigSample.html"
><span class="type">IpatchGigSample</span></a>
is synthesized in a <a
href="../libinstpatch/IpatchGigInst.html"
><span class="type">IpatchGigInst</span></a>.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchGigSubRegion.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchGigSubRegion">
<a name="IpatchGigSubRegion-struct"></a><h3>IpatchGigSubRegion</h3>
<pre class="programlisting">typedef struct _IpatchGigSubRegion IpatchGigSubRegion;</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchGigSubRegionFlags">
<a name="IpatchGigSubRegionFlags"></a><h3>enum IpatchGigSubRegionFlags</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_GIG_SUB_REGION_SAMPLE_INFO_OVERRIDE = 1 &lt;&lt; IPATCH_ITEM_UNUSED_FLAG_SHIFT
} IpatchGigSubRegionFlags;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_GIG_SUB_REGION_UNUSED_FLAG_SHIFT">
<a name="IPATCH-GIG-SUB-REGION-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_GIG_SUB_REGION_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define             IPATCH_GIG_SUB_REGION_UNUSED_FLAG_SHIFT</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_sub_region_new ()">
<a name="ipatch-gig-sub-region-new"></a><h3>ipatch_gig_sub_region_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> * ipatch_gig_sub_region_new          (void);</pre>
<p>
Create a new GigaSampler sub region.</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 GigaSampler sub region with a ref count of 1 which the caller
owns.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_sub_region_first ()">
<a name="ipatch-gig-sub-region-first"></a><h3>ipatch_gig_sub_region_first ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> * ipatch_gig_sub_region_first        (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the first item in a sub 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/IpatchGigSubRegion.html"
><span class="type">IpatchGigSubRegion</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first sub 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_gig_sub_region_next ()">
<a name="ipatch-gig-sub-region-next"></a><h3>ipatch_gig_sub_region_next ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> * ipatch_gig_sub_region_next         (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the next item in a sub 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/IpatchGigSubRegion.html"
><span class="type">IpatchGigSubRegion</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next sub 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_gig_sub_region_get_sample ()">
<a name="ipatch-gig-sub-region-get-sample"></a><h3>ipatch_gig_sub_region_get_sample ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchGigSample.html"
>IpatchGigSample</a> *   ipatch_gig_sub_region_get_sample    (<a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> *subregion);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>subregion</code></em> :</span></p></td>
<td> GigaSampler sub region to get sample of
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The sub region's sample, referenced for the caller, unref
  it when finished.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_sub_region_set_sample ()">
<a name="ipatch-gig-sub-region-set-sample"></a><h3>ipatch_gig_sub_region_set_sample ()</h3>
<pre class="programlisting">void                ipatch_gig_sub_region_set_sample    (<a
href="../libinstpatch/IpatchGigSubRegion.html"
>IpatchGigSubRegion</a> *subregion,
                                                         <a
href="../libinstpatch/IpatchGigSample.html"
>IpatchGigSample</a> *sample);</pre>
<p>
Set the referenced sample of a sub region.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>subregion</code></em> :</span></p></td>
<td> GigaSampler sub region to set sample of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample</code></em> :</span></p></td>
<td> Sample to assign to the sub region
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchGigSubRegion.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "fine-tune" property'>
<a name="IpatchGigSubRegion--fine-tune"></a><h3>The <code class="literal">"fine-tune"</code> property</h3>
<pre class="programlisting">  "fine-tune"                <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write</pre>
<p>Fine tuning in cents.</p>
<p>Allowed values: [-99,99]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "flags" property'>
<a name="IpatchGigSubRegion--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
<pre class="programlisting">  "flags"                    <a
href="../libinstpatch/IpatchDLS2Sample.html#IpatchDLS2SampleFlags"
>IpatchDLS2SampleFlags</a>  : Read / Write</pre>
<p>Sample flags.</p>
</div>
<hr>
<div class="refsect2" title='The "gain" property'>
<a name="IpatchGigSubRegion--gain"></a><h3>The <code class="literal">"gain"</code> property</h3>
<pre class="programlisting">  "gain"                     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write</pre>
<p>Gain in DLS relative gain units.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "link-item" property'>
<a name="IpatchGigSubRegion--link-item"></a><h3>The <code class="literal">"link-item"</code> property</h3>
<pre class="programlisting">  "link-item"                <a
href="../libinstpatch/IpatchGigSample.html"
>IpatchGigSample</a>*      : Read / Write</pre>
<p>Link item.</p>
</div>
<hr>
<div class="refsect2" title='The "loop-end" property'>
<a name="IpatchGigSubRegion--loop-end"></a><h3>The <code class="literal">"loop-end"</code> property</h3>
<pre class="programlisting">  "loop-end"                 <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a>                 : Read / Write</pre>
<p>Loop end in frames (after loop).</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "loop-start" property'>
<a name="IpatchGigSubRegion--loop-start"></a><h3>The <code class="literal">"loop-start"</code> property</h3>
<pre class="programlisting">  "loop-start"               <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a>                 : Read / Write</pre>
<p>Start of loop in frames.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "loop-type" property'>
<a name="IpatchGigSubRegion--loop-type"></a><h3>The <code class="literal">"loop-type"</code> property</h3>
<pre class="programlisting">  "loop-type"                <a
href="../libinstpatch/IpatchSample.html#IpatchSampleLoopType"
>IpatchSampleLoopType</a>  : Read / Write</pre>
<p>Loop method type.</p>
<p>Default value: IPATCH_SAMPLE_LOOP_NONE</p>
</div>
<hr>
<div class="refsect2" title='The "root-note" property'>
<a name="IpatchGigSubRegion--root-note"></a><h3>The <code class="literal">"root-note"</code> property</h3>
<pre class="programlisting">  "root-note"                <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write</pre>
<p>Root MIDI note.</p>
<p>Allowed values: [0,127]</p>
<p>Default value: 60</p>
</div>
<hr>
<div class="refsect2" title='The "sample-info-override" property'>
<a name="IpatchGigSubRegion--sample-info-override"></a><h3>The <code class="literal">"sample-info-override"</code> property</h3>
<pre class="programlisting">  "sample-info-override"     <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write</pre>
<p>Override sample info.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="IpatchGigSubRegion.see-also"></a><h2>See Also</h2>
#IpatchGigRegion
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>