docs/plugins/html/gst-plugins-good-plugins-jackaudiosink.html


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

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>jackaudiosink</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-jackaudiosrc.html" title="jackaudiosrc">
<link rel="next" href="gst-plugins-good-plugins-jpegdec.html" title="jpegdec">
<meta name="generator" content="GTK-Doc V1.17 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-good-plugins-jackaudiosrc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-good-plugins-jpegdec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-good-plugins-jackaudiosink.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gst-plugins-good-plugins-jackaudiosink.description" class="shortcut">Description</a>
                   | 
                  <a href="#gst-plugins-good-plugins-jackaudiosink.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#gst-plugins-good-plugins-jackaudiosink.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-good-plugins-jackaudiosink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-jackaudiosink.top_of_page"></a>jackaudiosink</span></h2>
<p>jackaudiosink — Output audio to a JACK server</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-good-plugins-jackaudiosink.synopsis"></a><h2>Synopsis</h2>
<a name="GstJackAudioSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink-struct" title="struct GstJackAudioSink">GstJackAudioSink</a>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosink.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="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
                     +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink">GstBaseAudioSink</a>
                           +----GstJackAudioSink
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosink.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink--client" title='The "client" property'>client</a>"                   <span class="type">JackClient</span>*           : Read / Write
  "<a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink--connect" title='The "connect" property'>connect</a>"                  <span class="type">GstJackConnect</span>        : Read / Write
  "<a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink--server" title='The "server" property'>server</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosink.description"></a><h2>Description</h2>
<p>
A Sink that outputs data to Jack ports.
</p>
<p>
It will create N Jack ports named out_&lt;name&gt;_&lt;num&gt; where 
&lt;name&gt; is the element name and &lt;num&gt; is starting from 1.
Each port corresponds to a gstreamer channel.
</p>
<p>
The samplerate as exposed on the caps is always the same as the samplerate of
the jack server.
</p>
<p>
When the <a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink--connect" title='The "connect" property'><span class="type">"connect"</span></a> property is set to auto, this element
will try to connect each output port to a random physical jack input pin. In
this mode, the sink will expose the number of physical channels on its pad
caps.
</p>
<p>
When the <a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink--connect" title='The "connect" property'><span class="type">"connect"</span></a> property is set to none, the element will
accept any number of input channels and will create (but not connect) an
output port for each channel.
</p>
<p>
The element will generate an error when the Jack server is shut down when it
was PAUSED or PLAYING. This element does not support dynamic rate and buffer
size changes at runtime.
</p>
<p>
</p>
<div class="refsect2">
<a name="idp12351168"></a><h3>Example launch line</h3>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc <span class="gtkdoc opt">!</span> jackaudiosink</pre></td>
      </tr>
    </tbody>
  </table>
</div>
 Play a sine wave to using jack.
</div>
<p>
</p>
<p>
Last reviewed on 2006-11-30 (0.10.4)
</p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="idp15484672"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-good-plugins-plugin-jack.html#plugin-jack">jack</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Wim Taymans &lt;wim.taymans@gmail.com&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Sink/Audio</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="idp17395088"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>audio/x-raw-float, endianness=(int)1234, width=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosink.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstJackAudioSink-struct"></a><h3>struct GstJackAudioSink</h3>
<pre class="programlisting">struct GstJackAudioSink;</pre>
<p>
Opaque <a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink"><span class="type">GstJackAudioSink</span></a>.
</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosink.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstJackAudioSink--client"></a><h3>The <code class="literal">"client"</code> property</h3>
<pre class="programlisting">  "client"                   <span class="type">JackClient</span>*           : Read / Write</pre>
<p>Handle for jack client.</p>
</div>
<hr>
<div class="refsect2">
<a name="GstJackAudioSink--connect"></a><h3>The <code class="literal">"connect"</code> property</h3>
<pre class="programlisting">  "connect"                  <span class="type">GstJackConnect</span>        : Read / Write</pre>
<p>Specify how the output ports will be connected.</p>
<p>Default value: Automatically connect ports to physical ports</p>
</div>
<hr>
<div class="refsect2">
<a name="GstJackAudioSink--server"></a><h3>The <code class="literal">"server"</code> property</h3>
<pre class="programlisting">  "server"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
<p>The Jack server to connect to (NULL = default).</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosink.see-also"></a><h2>See Also</h2>
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstringbuffer.html#GstRingBuffer"><span class="type">GstRingBuffer</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>