File: BtSinkMachine.html

package info (click to toggle)
buzztrax 0.10.2-10
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 19,984 kB
  • sloc: ansic: 109,707; sh: 12,875; cpp: 10,882; xml: 6,081; makefile: 508; javascript: 338; asm: 116
file content (199 lines) | stat: -rw-r--r-- 10,128 bytes parent folder | download | duplicates (6) 
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>BtSinkMachine: 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="BtSinkBin.html" title="BtSinkBin">
<link rel="next" href="BtSong.html" title="BtSong">
<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="#BtSinkMachine.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#BtSinkMachine.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#BtSinkMachine.implemented-interfaces" class="shortcut">Implemented Interfaces</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="BtSinkBin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="BtSong.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="BtSinkMachine"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtSinkMachine.top_of_page"></a>BtSinkMachine</span></h2>
<p>BtSinkMachine — class for signal processing machines with inputs only</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="BtSinkMachine.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 class="link" href="BtSinkMachine.html" title="BtSinkMachine"><span class="returnvalue">BtSinkMachine</span></a> *
</td>
<td class="function_name">
<a class="link" href="BtSinkMachine.html#bt-sink-machine-new" title="bt_sink_machine_new ()">bt_sink_machine_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSinkMachine.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="BtSinkMachine.html#BtSinkMachine-struct" title="struct BtSinkMachine">BtSinkMachine</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="BtSinkMachine.html#BtSinkMachinePatternIndex" title="enum BtSinkMachinePatternIndex">BtSinkMachinePatternIndex</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSinkMachine.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <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> <a class="link" href="BtMachine.html" title="BtMachine">BtMachine</a>
                        <span class="lineart">╰──</span> BtSinkMachine
</pre>
</div>
<div class="refsect1">
<a name="BtSinkMachine.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
BtSinkMachine implements
 <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a> and  <a class="link" href="BtPersistence.html" title="BtPersistence">BtPersistence</a>.</p>
</div>
<div class="refsect1">
<a name="BtSinkMachine.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libbtcore/core.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="BtSinkMachine.description"></a><h2>Description</h2>
<p>Sinks are machines that do playback or recording of the song. The
sink-machine utilizes the <a class="link" href="BtSinkBin.html" title="BtSinkBin"><span class="type">BtSinkBin</span></a> to transparently switch elements between
record (encoding) and playback.</p>
</div>
<div class="refsect1">
<a name="BtSinkMachine.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="bt-sink-machine-new"></a><h3>bt_sink_machine_new ()</h3>
<pre class="programlisting"><a class="link" href="BtSinkMachine.html" title="BtSinkMachine"><span class="returnvalue">BtSinkMachine</span></a> *
bt_sink_machine_new (<em class="parameter"><code>const <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> * const song</code></em>,
                     <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const id</code></em>,
                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>Create a new instance.
The machine is automatically added to the setup from the given song object.
You don't need to add the machine with</p>
<code class="code"><a class="link" href="BtSetup.html#bt-setup-add-machine" title="bt_setup_add_machine ()"><span class="type">bt_setup_add_machine</span></a>(setup,BT_MACHINE(machine));</code>.
<p>The element used for this machine is <a class="link" href="BtSinkBin.html" title="BtSinkBin"><span class="type">BtSinkBin</span></a> which is configured according
to the use-case (playback, recording). The playback device is taken from the
<a class="link" href="BtSettings.html" title="BtSettings"><span class="type">BtSettings</span></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.11.9.2.7"></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>song</p></td>
<td class="parameter_description"><p>the song the new instance belongs to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>the id, we can use to lookup the machine</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>inform about failed instance creation</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.11.9.2.8"></a><h4>Returns</h4>
<p> the new instance or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of an error</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="BtSinkMachine.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BtSinkMachine-struct"></a><h3>struct BtSinkMachine</h3>
<pre class="programlisting">struct BtSinkMachine;</pre>
<p>Sub-class of a <a class="link" href="BtMachine.html" title="BtMachine"><span class="type">BtMachine</span></a> that implements a signal output
(a machine with inputs only).</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSinkMachinePatternIndex"></a><h3>enum BtSinkMachinePatternIndex</h3>
<p>Use this with <a class="link" href="BtMachine.html#bt-machine-get-pattern-by-index" title="bt_machine_get_pattern_by_index ()"><code class="function">bt_machine_get_pattern_by_index()</code></a> to get the command patterns.</p>
<div class="refsect3">
<a name="id-1.4.4.11.10.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-MACHINE-PATTERN-INDEX-BREAK:CAPS"></a>BT_SINK_MACHINE_PATTERN_INDEX_BREAK</p></td>
<td class="enum_member_description">
<p>stop the pattern</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-MACHINE-PATTERN-INDEX-MUTE:CAPS"></a>BT_SINK_MACHINE_PATTERN_INDEX_MUTE</p></td>
<td class="enum_member_description">
<p>mute the machine</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BT-SINK-MACHINE-PATTERN-INDEX-OFFSET:CAPS"></a>BT_SINK_MACHINE_PATTERN_INDEX_OFFSET</p></td>
<td class="enum_member_description">
<p>offset for real pattern ids</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>