File: IpatchSampleStoreVirtual.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 (257 lines) | stat: -rw-r--r-- 11,639 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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSampleStoreVirtual</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="IpatchSampleStoreSwap.html" title="IpatchSampleStoreSwap">
<link rel="next" href="ch04.html" title="DLS patches">
<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="IpatchSampleStoreSwap.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="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSampleStoreVirtual.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchSampleStoreVirtual.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchSampleStoreVirtual.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#IpatchSampleStoreVirtual.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                 | 
                <a href="#IpatchSampleStoreVirtual.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSampleStoreVirtual">
<a name="IpatchSampleStoreVirtual"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSampleStoreVirtual.top_of_page"></a>IpatchSampleStoreVirtual</span></h2>
<p>IpatchSampleStoreVirtual — Virtual sample storage object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSampleStoreVirtual.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSampleStoreVirtual.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchSampleStoreVirtual.html#IpatchSampleStoreVirtual-struct"
>IpatchSampleStoreVirtual</a>;
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> *      <a
href="../libinstpatch/IpatchSampleStoreVirtual.html#ipatch-sample-store-virtual-new"
>ipatch_sample_store_virtual_new</a>     (void);
<a
href="../libinstpatch/libinstpatch-IpatchSampleList.html#IpatchSampleList"
>IpatchSampleList</a> *  <a
href="../libinstpatch/IpatchSampleStoreVirtual.html#ipatch-sample-store-virtual-get-list"
>ipatch_sample_store_virtual_get_list</a>
                                                        (<a
href="../libinstpatch/IpatchSampleStoreVirtual.html"
>IpatchSampleStoreVirtual</a> *store,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> chan);
void                <a
href="../libinstpatch/IpatchSampleStoreVirtual.html#ipatch-sample-store-virtual-set-list"
>ipatch_sample_store_virtual_set_list</a>
                                                        (<a
href="../libinstpatch/IpatchSampleStoreVirtual.html"
>IpatchSampleStoreVirtual</a> *store,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> chan,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSampleList.html#IpatchSampleList"
>IpatchSampleList</a> *list);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSampleStoreVirtual.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>
               +----IpatchSampleStoreVirtual
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchSampleStoreVirtual.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchSampleStoreVirtual implements
 <a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchSampleStoreVirtual.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a
href="../libinstpatch/IpatchSampleStoreVirtual.html#IpatchSampleStoreVirtual--sample-lists"
>sample-lists</a>"             <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"
>GValueArray</a>*          : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSampleStoreVirtual.description"></a><h2>Description</h2>
<p>
A sample store that does in place sample conversions of other samples
using sample lists (<a
href="../libinstpatch/libinstpatch-IpatchSampleList.html#IpatchSampleList"
><span class="type">IpatchSampleList</span></a>).</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSampleStoreVirtual.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSampleStoreVirtual">
<a name="IpatchSampleStoreVirtual-struct"></a><h3>IpatchSampleStoreVirtual</h3>
<pre class="programlisting">typedef struct _IpatchSampleStoreVirtual IpatchSampleStoreVirtual;</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_virtual_new ()">
<a name="ipatch-sample-store-virtual-new"></a><h3>ipatch_sample_store_virtual_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> *      ipatch_sample_store_virtual_new     (void);</pre>
<p>
Creates a new virtual sample store.</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 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_virtual_get_list ()">
<a name="ipatch-sample-store-virtual-get-list"></a><h3>ipatch_sample_store_virtual_get_list ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchSampleList.html#IpatchSampleList"
>IpatchSampleList</a> *  ipatch_sample_store_virtual_get_list
                                                        (<a
href="../libinstpatch/IpatchSampleStoreVirtual.html"
>IpatchSampleStoreVirtual</a> *store,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> chan);</pre>
<p>
Gets a sample list from a virtual 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>store</code></em> :</span></p></td>
<td> Virtual store to get sample list from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>chan</code></em> :</span></p></td>
<td> Which channel to get sample list from (0 = mono or left stereo channel,
  1 = right stereo channel).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The sample list for the corresponding channel or <code class="literal">NULL</code> if not
  assigned.  The list is internal and should not be modified or freed and
  should be used only as long as <em class="parameter"><code>store</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_virtual_set_list ()">
<a name="ipatch-sample-store-virtual-set-list"></a><h3>ipatch_sample_store_virtual_set_list ()</h3>
<pre class="programlisting">void                ipatch_sample_store_virtual_set_list
                                                        (<a
href="../libinstpatch/IpatchSampleStoreVirtual.html"
>IpatchSampleStoreVirtual</a> *store,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> chan,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSampleList.html#IpatchSampleList"
>IpatchSampleList</a> *list);</pre>
<p>
Sets a sample list of a virtual sample store.  Can only be assigned before
the sample store is active.  The size of <em class="parameter"><code>store</code></em> is set to that of <em class="parameter"><code>list</code></em>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td> Virtual store to set sample list of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>chan</code></em> :</span></p></td>
<td> Which channel to set sample list of (0 = mono or left stereo channel,
  1 = right stereo channel).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> List to assign to virtual store.  The allocation is taken over by
  the virtual store (if caller would like to continue using it beyond the
  life of <em class="parameter"><code>store</code></em> or modify it, it should be duplicated).
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchSampleStoreVirtual.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "sample-lists" property'>
<a name="IpatchSampleStoreVirtual--sample-lists"></a><h3>The <code class="literal">"sample-lists"</code> property</h3>
<pre class="programlisting">  "sample-lists"             <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"
>GValueArray</a>*          : Read / Write</pre>
<p>Sample lists.</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="IpatchSampleStoreVirtual.see-also"></a><h2>See Also</h2>
#IpatchSampleList
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>