File: IpatchSampleStoreFile.html

package info (click to toggle)
libinstpatch 1.0.0-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 8,148 kB
  • ctags: 7,030
  • sloc: ansic: 37,958; sh: 10,747; makefile: 361; python: 27
file content (199 lines) | stat: -rw-r--r-- 8,734 bytes parent folder | download | duplicates (4)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSampleStoreFile</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="IpatchSampleStoreCache.html" title="IpatchSampleStoreCache">
<link rel="next" href="IpatchSampleStoreRam.html" title="IpatchSampleStoreRam">
<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="IpatchSampleStoreCache.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="IpatchSampleStoreRam.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSampleStoreFile.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchSampleStoreFile.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchSampleStoreFile.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#IpatchSampleStoreFile.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                 | 
                <a href="#IpatchSampleStoreFile.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSampleStoreFile">
<a name="IpatchSampleStoreFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSampleStoreFile.top_of_page"></a>IpatchSampleStoreFile</span></h2>
<p>IpatchSampleStoreFile — Sample store object type for audio in files on disk</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSampleStoreFile.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSampleStoreFile.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchSampleStoreFile.html#IpatchSampleStoreFile-struct"
>IpatchSampleStoreFile</a>;
#define             <a
href="../libinstpatch/IpatchSampleStoreFile.html#IPATCH-SAMPLE-STORE-FILE-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_SAMPLE_STORE_FILE_UNUSED_FLAG_SHIFT</a>
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> *      <a
href="../libinstpatch/IpatchSampleStoreFile.html#ipatch-sample-store-file-new"
>ipatch_sample_store_file_new</a>        (<a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a> *file,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> location);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSampleStoreFile.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/IpatchSampleStore.html"
>IpatchSampleStore</a>
               +----IpatchSampleStoreFile
                     +----<a
href="../libinstpatch/IpatchSampleStoreSplit24.html"
>IpatchSampleStoreSplit24</a>
                     +----<a
href="../libinstpatch/IpatchSampleStoreSwap.html"
>IpatchSampleStoreSwap</a>
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchSampleStoreFile.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchSampleStoreFile implements
 <a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchSampleStoreFile.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a
href="../libinstpatch/IpatchSampleStoreFile.html#IpatchSampleStoreFile--file"
>file</a>"                     <a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a>*           : Read / Write / Construct Only
  "<a
href="../libinstpatch/IpatchSampleStoreFile.html#IpatchSampleStoreFile--location"
>location</a>"                 <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>                 : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSampleStoreFile.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSampleStoreFile.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSampleStoreFile">
<a name="IpatchSampleStoreFile-struct"></a><h3>IpatchSampleStoreFile</h3>
<pre class="programlisting">typedef struct _IpatchSampleStoreFile IpatchSampleStoreFile;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_STORE_FILE_UNUSED_FLAG_SHIFT">
<a name="IPATCH-SAMPLE-STORE-FILE-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_STORE_FILE_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_STORE_FILE_UNUSED_FLAG_SHIFT</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_file_new ()">
<a name="ipatch-sample-store-file-new"></a><h3>ipatch_sample_store_file_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> *      ipatch_sample_store_file_new        (<a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a> *file,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> location);</pre>
<p>
Creates a new file sample store.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td> File object to use for file sample store
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
<td> Location in file of audio data
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New file sample store, cast as a <a
href="../libinstpatch/IpatchSample.html"
><span class="type">IpatchSample</span></a> for convenience.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchSampleStoreFile.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "file" property'>
<a name="IpatchSampleStoreFile--file"></a><h3>The <code class="literal">"file"</code> property</h3>
<pre class="programlisting">  "file"                     <a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a>*           : Read / Write / Construct Only</pre>
<p>File object.</p>
</div>
<hr>
<div class="refsect2" title='The "location" property'>
<a name="IpatchSampleStoreFile--location"></a><h3>The <code class="literal">"location"</code> property</h3>
<pre class="programlisting">  "location"                 <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>                 : Read / Write / Construct Only</pre>
<p>Sample data file location.</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>