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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSampleStoreRam</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="IpatchSampleStoreFile.html" title="IpatchSampleStoreFile">
<link rel="next" href="IpatchSampleStoreRom.html" title="IpatchSampleStoreRom">
<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="IpatchSampleStoreFile.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="IpatchSampleStoreRom.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSampleStoreRam.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchSampleStoreRam.description" class="shortcut">Description</a>
|
<a href="#IpatchSampleStoreRam.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchSampleStoreRam.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#IpatchSampleStoreRam.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSampleStoreRam">
<a name="IpatchSampleStoreRam"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSampleStoreRam.top_of_page"></a>IpatchSampleStoreRam</span></h2>
<p>IpatchSampleStoreRam — Sample store object for audio data in RAM</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSampleStoreRam.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSampleStoreRam.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchSampleStoreRam.html#IpatchSampleStoreRam-struct"
>IpatchSampleStoreRam</a>;
enum <a
href="../libinstpatch/IpatchSampleStoreRam.html#IpatchSampleStoreRamFlags"
>IpatchSampleStoreRamFlags</a>;
#define <a
href="../libinstpatch/IpatchSampleStoreRam.html#IPATCH-SAMPLE-STORE-RAM-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_SAMPLE_STORE_RAM_UNUSED_FLAG_SHIFT</a>
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * <a
href="../libinstpatch/IpatchSampleStoreRam.html#ipatch-sample-store-ram-new"
>ipatch_sample_store_ram_new</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> location,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> free_data);
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * <a
href="../libinstpatch/IpatchSampleStoreRam.html#ipatch-sample-store-ram-get-blank"
>ipatch_sample_store_ram_get_blank</a> (void);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSampleStoreRam.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>
+----IpatchSampleStoreRam
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchSampleStoreRam.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchSampleStoreRam implements
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchSampleStoreRam.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a
href="../libinstpatch/IpatchSampleStoreRam.html#IpatchSampleStoreRam--free-data"
>free-data</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreRam.html#IpatchSampleStoreRam--location"
>location</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSampleStoreRam.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSampleStoreRam.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSampleStoreRam">
<a name="IpatchSampleStoreRam-struct"></a><h3>IpatchSampleStoreRam</h3>
<pre class="programlisting">typedef struct _IpatchSampleStoreRam IpatchSampleStoreRam;</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSampleStoreRamFlags">
<a name="IpatchSampleStoreRamFlags"></a><h3>enum IpatchSampleStoreRamFlags</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SAMPLE_STORE_RAM_ALLOCATED = 1 << IPATCH_SAMPLE_STORE_UNUSED_FLAG_SHIFT
} IpatchSampleStoreRamFlags;
</pre>
<p>
Flags crammed into <a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> flags field.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><a name="IPATCH-SAMPLE-STORE-RAM-ALLOCATED--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_STORE_RAM_ALLOCATED</code></span></p></td>
<td> Indicates if sample data was allocated
and therefore should be freed when finalized.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_STORE_RAM_UNUSED_FLAG_SHIFT">
<a name="IPATCH-SAMPLE-STORE-RAM-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_STORE_RAM_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_STORE_RAM_UNUSED_FLAG_SHIFT</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_ram_new ()">
<a name="ipatch-sample-store-ram-new"></a><h3>ipatch_sample_store_ram_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * ipatch_sample_store_ram_new (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> location,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> free_data);</pre>
<p>
Creates a new RAM 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>location</code></em> :</span></p></td>
<td> Location of existing sample data or <code class="literal">NULL</code> if the sample buffer
should be allocated (in which case the sample must be written to first).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>free_data</code></em> :</span></p></td>
<td> <code class="literal">TRUE</code> if sample data at <em class="parameter"><code>location</code></em> should be freed when object
is destroyed
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New RAM sample store, cast as a <a
href="../libinstpatch/IpatchSample.html"
><span class="type">IpatchSample</span></a> for convenience.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_ram_get_blank ()">
<a name="ipatch-sample-store-ram-get-blank"></a><h3>ipatch_sample_store_ram_get_blank ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * ipatch_sample_store_ram_get_blank (void);</pre>
<p>
Get blank mono RAM sample object. Return's a sample object
with 48 stereo 16 bit samples of silent audio. Only creates it on
the first call, subsequent calls return the same sample object. Therefore it
should not be modified.</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> The blank sample object. Remember to unref it when not
using it anymore with <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a>.
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchSampleStoreRam.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "free-data" property'>
<a name="IpatchSampleStoreRam--free-data"></a><h3>The <code class="literal">"free-data"</code> property</h3>
<pre class="programlisting"> "free-data" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>Free data when object destroyed.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" title='The "location" property'>
<a name="IpatchSampleStoreRam--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#gpointer"
>gpointer</a> : Read / Write</pre>
<p>Sample data pointer.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|
