libinstpatch-doc 1.0.0-7 / usr / share / gtk-doc / html / libinstpatch / IpatchSndFile.html

This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/IpatchSndFile.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSndFile</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="ch03.html" title="Sample data objects and functions">
<link rel="prev" href="libinstpatch-IpatchSampleList.html" title="IpatchSampleList">
<link rel="next" href="IpatchSampleStoreCache.html" title="IpatchSampleStoreCache">
<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-IpatchSampleList.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.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="IpatchSampleStoreCache.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSndFile.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchSndFile.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchSndFile.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSndFile">
<a name="IpatchSndFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSndFile.top_of_page"></a>IpatchSndFile</span></h2>
<p>IpatchSndFile — libsndfile file object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSndFile.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSndFile.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define             <a
href="../libinstpatch/IpatchSndFile.html#IPATCH-TYPE-SND-FILE-FORMAT--CAPS"
>IPATCH_TYPE_SND_FILE_FORMAT</a>
#define             <a
href="../libinstpatch/IpatchSndFile.html#IPATCH-TYPE-SND-FILE-SUB-FORMAT--CAPS"
>IPATCH_TYPE_SND_FILE_SUB_FORMAT</a>
enum                <a
href="../libinstpatch/IpatchSndFile.html#IpatchSndFileEndian"
>IpatchSndFileEndian</a>;
#define             <a
href="../libinstpatch/IpatchSndFile.html#IPATCH-SND-FILE-DEFAULT-FORMAT--CAPS"
>IPATCH_SND_FILE_DEFAULT_FORMAT</a>
#define             <a
href="../libinstpatch/IpatchSndFile.html#IPATCH-SND-FILE-DEFAULT-SUB-FORMAT--CAPS"
>IPATCH_SND_FILE_DEFAULT_SUB_FORMAT</a>
#define             <a
href="../libinstpatch/IpatchSndFile.html#IPATCH-SND-FILE-DEFAULT-ENDIAN--CAPS"
>IPATCH_SND_FILE_DEFAULT_ENDIAN</a>
                    <a
href="../libinstpatch/IpatchSndFile.html#IpatchSndFile-struct"
>IpatchSndFile</a>;
<a
href="../libinstpatch/IpatchSndFile.html"
>IpatchSndFile</a> *     <a
href="../libinstpatch/IpatchSndFile.html#ipatch-snd-file-new"
>ipatch_snd_file_new</a>                 (void);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a>               <a
href="../libinstpatch/IpatchSndFile.html#ipatch-snd-file-format-get-type"
>ipatch_snd_file_format_get_type</a>     (void);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a>               <a
href="../libinstpatch/IpatchSndFile.html#ipatch-snd-file-sub-format-get-type"
>ipatch_snd_file_sub_format_get_type</a> (void);
int *               <a
href="../libinstpatch/IpatchSndFile.html#ipatch-snd-file-format-get-sub-formats"
>ipatch_snd_file_format_get_sub_formats</a>
                                                        (int format,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *size);
int                 <a
href="../libinstpatch/IpatchSndFile.html#ipatch-snd-file-sample-format-to-sub-format"
>ipatch_snd_file_sample_format_to_sub_format</a>
                                                        (int sample_format,
                                                         int file_format);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSndFile.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>
         +----<a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a>
               +----IpatchSndFile
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSndFile.description"></a><h2>Description</h2>
<p>
Object type for libsndfile audio file identification.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSndFile.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_TYPE_SND_FILE_FORMAT">
<a name="IPATCH-TYPE-SND-FILE-FORMAT--CAPS"></a><h3>IPATCH_TYPE_SND_FILE_FORMAT</h3>
<pre class="programlisting">#define             IPATCH_TYPE_SND_FILE_FORMAT</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_TYPE_SND_FILE_SUB_FORMAT">
<a name="IPATCH-TYPE-SND-FILE-SUB-FORMAT--CAPS"></a><h3>IPATCH_TYPE_SND_FILE_SUB_FORMAT</h3>
<pre class="programlisting">#define             IPATCH_TYPE_SND_FILE_SUB_FORMAT</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSndFileEndian">
<a name="IpatchSndFileEndian"></a><h3>enum IpatchSndFileEndian</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SND_FILE_ENDIAN_FILE,
  IPATCH_SND_FILE_ENDIAN_LITTLE,
  IPATCH_SND_FILE_ENDIAN_BIG,
  IPATCH_SND_FILE_ENDIAN_CPU
} IpatchSndFileEndian;
</pre>
<p>
Endian byte order libsndfile enum.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="IPATCH-SND-FILE-ENDIAN-FILE--CAPS"></a><span class="term"><code class="literal">IPATCH_SND_FILE_ENDIAN_FILE</code></span></p></td>
<td> Use the default endian for the file format
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SND-FILE-ENDIAN-LITTLE--CAPS"></a><span class="term"><code class="literal">IPATCH_SND_FILE_ENDIAN_LITTLE</code></span></p></td>
<td> Little endian byte order
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SND-FILE-ENDIAN-BIG--CAPS"></a><span class="term"><code class="literal">IPATCH_SND_FILE_ENDIAN_BIG</code></span></p></td>
<td> Big endian byte order
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SND-FILE-ENDIAN-CPU--CAPS"></a><span class="term"><code class="literal">IPATCH_SND_FILE_ENDIAN_CPU</code></span></p></td>
<td> Native CPU byte order
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SND_FILE_DEFAULT_FORMAT">
<a name="IPATCH-SND-FILE-DEFAULT-FORMAT--CAPS"></a><h3>IPATCH_SND_FILE_DEFAULT_FORMAT</h3>
<pre class="programlisting">#define IPATCH_SND_FILE_DEFAULT_FORMAT     SF_FORMAT_WAV
</pre>
<p>
Default file format enum for <a
href="../libinstpatch/IpatchSndFile.html#IPATCH-TYPE-SND-FILE-FORMAT--CAPS"
><span class="type">IPATCH_TYPE_SND_FILE_FORMAT</span></a>.</p>
</div>
<hr>
<div class="refsect2" title="IPATCH_SND_FILE_DEFAULT_SUB_FORMAT">
<a name="IPATCH-SND-FILE-DEFAULT-SUB-FORMAT--CAPS"></a><h3>IPATCH_SND_FILE_DEFAULT_SUB_FORMAT</h3>
<pre class="programlisting">#define IPATCH_SND_FILE_DEFAULT_SUB_FORMAT SF_FORMAT_PCM_16
</pre>
<p>
Default file sub format enum for <a
href="../libinstpatch/IpatchSndFile.html#IPATCH-TYPE-SND-FILE-SUB-FORMAT--CAPS"
><span class="type">IPATCH_TYPE_SND_FILE_SUB_FORMAT</span></a>.</p>
</div>
<hr>
<div class="refsect2" title="IPATCH_SND_FILE_DEFAULT_ENDIAN">
<a name="IPATCH-SND-FILE-DEFAULT-ENDIAN--CAPS"></a><h3>IPATCH_SND_FILE_DEFAULT_ENDIAN</h3>
<pre class="programlisting">#define IPATCH_SND_FILE_DEFAULT_ENDIAN     IPATCH_SND_FILE_ENDIAN_FILE
</pre>
<p>
Default endian byte order from enum <span class="type">IPATCH_TYPE_SND_FILE_ENDIAN</span>.</p>
</div>
<hr>
<div class="refsect2" title="IpatchSndFile">
<a name="IpatchSndFile-struct"></a><h3>IpatchSndFile</h3>
<pre class="programlisting">typedef struct _IpatchSndFile IpatchSndFile;</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_snd_file_new ()">
<a name="ipatch-snd-file-new"></a><h3>ipatch_snd_file_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSndFile.html"
>IpatchSndFile</a> *     ipatch_snd_file_new                 (void);</pre>
<p>
Create a new libsndfile file 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 libsndfile file object (derived from IpatchFile) 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_snd_file_format_get_type ()">
<a name="ipatch-snd-file-format-get-type"></a><h3>ipatch_snd_file_format_get_type ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a>               ipatch_snd_file_format_get_type     (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_snd_file_sub_format_get_type ()">
<a name="ipatch-snd-file-sub-format-get-type"></a><h3>ipatch_snd_file_sub_format_get_type ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a>               ipatch_snd_file_sub_format_get_type (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_snd_file_format_get_sub_formats ()">
<a name="ipatch-snd-file-format-get-sub-formats"></a><h3>ipatch_snd_file_format_get_sub_formats ()</h3>
<pre class="programlisting">int *               ipatch_snd_file_format_get_sub_formats
                                                        (int format,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *size);</pre>
<p>
Get supported sub formats of a given libsndfile format.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> "IpatchSndFileFormat" GEnum to get sub formats of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td> Location to store size of returned sub formats array
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Newly allocated list of sub format enum values or <code class="literal">NULL</code> if <em class="parameter"><code>format</code></em>
  is invalid
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_snd_file_sample_format_to_sub_format ()">
<a name="ipatch-snd-file-sample-format-to-sub-format"></a><h3>ipatch_snd_file_sample_format_to_sub_format ()</h3>
<pre class="programlisting">int                 ipatch_snd_file_sample_format_to_sub_format
                                                        (int sample_format,
                                                         int file_format);</pre>
<p>
Get the optimal libsndfile sub format for a libinstpatch sample format.  The
returned value may not be an exact equivalent, in the case of unsigned
sample data with bit widths greater than 8, but will return the optimal
format in those cases.  If <em class="parameter"><code>file_format</code></em> is not -1 then the resulting sub
format is guaranteed to be valid for it.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_format</code></em> :</span></p></td>
<td> libinstpatch sample format (see <span class="type">sample</span>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_format</code></em> :</span></p></td>
<td> libsndfile format GEnum "IpatchSndFileFormat" value or -1 to
  not limit sub formats to a given file format.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Optimal libsndfile sub format enum value or -1 on error (invalid
  <em class="parameter"><code>sample_format</code></em>).
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.