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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtSinkBin: Buzztrax Bt-Core Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztrax Bt-Core Reference Manual">
<link rel="up" href="ch03.html" title="Song Class Reference">
<link rel="prev" href="BtSetup.html" title="BtSetup">
<link rel="next" href="BtSinkMachine.html" title="BtSinkMachine">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#BtSinkBin.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#BtSinkBin.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#BtSinkBin.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#BtSinkBin.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="BtSetup.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="BtSinkMachine.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="BtSinkBin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtSinkBin.top_of_page"></a>BtSinkBin</span></h2>
<p>BtSinkBin — bin to be used by <a class="link" href="BtSinkMachine.html" title="BtSinkMachine"><span class="type">BtSinkMachine</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="BtSinkBin.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="BtSinkBin.html#bt-sink-bin-is-record-format-supported" title="bt_sink_bin_is_record_format_supported ()">bt_sink_bin_is_record_format_supported</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSinkBin.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="BtSinkBin.html#BtSinkBin--analyzers" title="The “analyzers” property">analyzers</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td>
<td class="property_name"><a class="link" href="BtSinkBin.html#BtSinkBin--input-gain" title="The “input-gain” property">input-gain</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="BtSinkBin.html#BtSinkBin--master-volume" title="The “master-volume” property">master-volume</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="BtSinkBin.html#BtSinkBinMode" title="enum BtSinkBinMode"><span class="type">BtSinkBinMode</span></a></td>
<td class="property_name"><a class="link" href="BtSinkBin.html#BtSinkBin--mode" title="The “mode” property">mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="BtSinkBin.html#BtSinkBin--record-file-name" title="The “record-file-name” property">record-file-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="BtSinkBin.html#BtSinkBinRecordFormat" title="enum BtSinkBinRecordFormat"><span class="type">BtSinkBinRecordFormat</span></a></td>
<td class="property_name"><a class="link" href="BtSinkBin.html#BtSinkBin--record-format" title="The “record-format” property">record-format</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSinkBin.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="BtSinkBin.html#BtSinkBin-struct" title="struct BtSinkBin">BtSinkBin</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="BtSinkBin.html#BtSinkBinMode" title="enum BtSinkBinMode">BtSinkBinMode</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="BtSinkBin.html#BtSinkBinRecordFormat" title="enum BtSinkBinRecordFormat">BtSinkBinRecordFormat</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSinkBin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
<span class="lineart">├──</span> BtSinkBinMode
<span class="lineart">╰──</span> BtSinkBinRecordFormat
<a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstObject.html#GstObject-struct">GstObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct">GstElement</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstBin.html#GstBin-struct">GstBin</a>
<span class="lineart">╰──</span> BtSinkBin
</pre>
</div>
<div class="refsect1">
<a name="BtSinkBin.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
BtSinkBin implements
<a href="/usr/share/gtk-doc/html/gstreamer-1.0GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a> and <a href="../html/GstBtTempo.html#GstBtTempo-struct">GstBtTempo</a>.</p>
</div>
<div class="refsect1">
<a name="BtSinkBin.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libbtcore/core.h>
</pre>
</div>
<div class="refsect1">
<a name="BtSinkBin.description"></a><h2>Description</h2>
<p>The sink-bin provides switchable play and record facilities.
It also provides controllable master-volume.</p>
<p>In play and record modes it plugs a chain of elements. In combined play and
record mode it uses a tee and plugs both pipelines.</p>
</div>
<div class="refsect1">
<a name="BtSinkBin.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="bt-sink-bin-is-record-format-supported"></a><h3>bt_sink_bin_is_record_format_supported ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_sink_bin_is_record_format_supported
(<em class="parameter"><code><a class="link" href="BtSinkBin.html#BtSinkBinRecordFormat" title="enum BtSinkBinRecordFormat"><span class="type">BtSinkBinRecordFormat</span></a> format</code></em>);</pre>
<p>Each record format might need a couple of GStreamer element to work. This
function verifies that all needed element are available.</p>
<div class="refsect3">
<a name="id-1.4.4.10.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>the format to check</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.10.10.2.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a fomat is useable</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="BtSinkBin.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BtSinkBin-struct"></a><h3>struct BtSinkBin</h3>
<pre class="programlisting">struct BtSinkBin;</pre>
<p>Sub-class of a <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstBin.html#GstBin-struct"><span class="type">GstBin</span></a> that implements a signal output
(a machine with inputs only).</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkBinMode"></a><h3>enum BtSinkBinMode</h3>
<p><a class="link" href="BtSinkBin.html" title="BtSinkBin"><span class="type">BtSinkBin</span></a> supports several modes of operation. Playing is the default
mode. Passthru is only needed if the song is plugged in another pipeline.</p>
<div class="refsect3">
<a name="id-1.4.4.10.11.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-MODE-PLAY:CAPS"></a>BT_SINK_BIN_MODE_PLAY</p></td>
<td class="enum_member_description">
<p>play the song</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-MODE-RECORD:CAPS"></a>BT_SINK_BIN_MODE_RECORD</p></td>
<td class="enum_member_description">
<p>record to file</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-MODE-PLAY-AND-RECORD:CAPS"></a>BT_SINK_BIN_MODE_PLAY_AND_RECORD</p></td>
<td class="enum_member_description">
<p>play and record together</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-MODE-PASS-THRU:CAPS"></a>BT_SINK_BIN_MODE_PASS_THRU</p></td>
<td class="enum_member_description">
<p>output audio on sometimes src pad</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkBinRecordFormat"></a><h3>enum BtSinkBinRecordFormat</h3>
<p><a class="link" href="BtSinkMachine.html" title="BtSinkMachine"><span class="type">BtSinkMachine</span></a> can record audio in several formats.</p>
<div class="refsect3">
<a name="id-1.4.4.10.11.4.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-OGG-VORBIS:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_OGG_VORBIS</p></td>
<td class="enum_member_description">
<p>ogg vorbis</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-MP3:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_MP3</p></td>
<td class="enum_member_description">
<p>mp3</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-WAV:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_WAV</p></td>
<td class="enum_member_description">
<p>wav</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-OGG-FLAC:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_OGG_FLAC</p></td>
<td class="enum_member_description">
<p>ogg flac</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-RAW:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_RAW</p></td>
<td class="enum_member_description">
<p>raw</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-MP4-AAC:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_MP4_AAC</p></td>
<td class="enum_member_description">
<p>mp4 aac</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-FLAC:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_FLAC</p></td>
<td class="enum_member_description">
<p>flac</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-OGG-OPUS:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_OGG_OPUS</p></td>
<td class="enum_member_description">
<p>ogg opus</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-BIN-RECORD-FORMAT-COUNT:CAPS"></a>BT_SINK_BIN_RECORD_FORMAT_COUNT</p></td>
<td class="enum_member_description">
<p>number of formats</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="BtSinkBin.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtSinkBin--analyzers"></a><h3>The <code class="literal">“analyzers”</code> property</h3>
<pre class="programlisting"> “analyzers” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>list of master analyzers.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkBin--input-gain"></a><h3>The <code class="literal">“input-gain”</code> property</h3>
<pre class="programlisting"> “input-gain” <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre>
<p>the input-gain element, if any.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkBin--master-volume"></a><h3>The <code class="literal">“master-volume”</code> property</h3>
<pre class="programlisting"> “master-volume” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>master volume for the song.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkBin--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
<pre class="programlisting"> “mode” <a class="link" href="BtSinkBin.html#BtSinkBinMode" title="enum BtSinkBinMode"><span class="type">BtSinkBinMode</span></a></pre>
<p>mode of operation.</p>
<p>Flags: Read / Write</p>
<p>Default value: BT_SINK_BIN_MODE_PLAY</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkBin--record-file-name"></a><h3>The <code class="literal">“record-file-name”</code> property</h3>
<pre class="programlisting"> “record-file-name” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>the file-name to use for recording.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkBin--record-format"></a><h3>The <code class="literal">“record-format”</code> property</h3>
<pre class="programlisting"> “record-format” <a class="link" href="BtSinkBin.html#BtSinkBinRecordFormat" title="enum BtSinkBinRecordFormat"><span class="type">BtSinkBinRecordFormat</span></a></pre>
<p>format to use when in record mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: .vorbis.ogg</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>
|
