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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>jackaudiosink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-jackaudiosrc.html" title="jackaudiosrc">
  10 <link rel="next" href="gst-plugins-good-plugins-jpegdec.html" title="jpegdec">
  11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <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>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
  21 <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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-good-plugins-jackaudiosink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-jackaudiosink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-jackaudiosink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-jackaudiosink.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-jackaudiosink"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-jackaudiosink.top_of_page"></a>jackaudiosink</span></h2>
  38 <p>jackaudiosink — Output audio to a JACK server</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-jackaudiosink.synopsis"></a><h2>Synopsis</h2>
  44 <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>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-jackaudiosink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink">GstBaseAudioSink</a>
  55                            +----GstJackAudioSink
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-jackaudiosink.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<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
  62   "<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
  63   "<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
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-good-plugins-jackaudiosink.description"></a><h2>Description</h2>
  68 <p>
  69 A Sink that outputs data to Jack ports.
  70 </p>
  71 <p>
  72 It will create N Jack ports named out_&lt;name&gt;_&lt;num&gt; where
  73 &lt;name&gt; is the element name and &lt;num&gt; is starting from 1.
  74 Each port corresponds to a gstreamer channel.
  75 </p>
  76 <p>
  77 The samplerate as exposed on the caps is always the same as the samplerate of
  78 the jack server.
  79 </p>
  80 <p>
  81 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
  82 will try to connect each output port to a random physical jack input pin. In
  83 this mode, the sink will expose the number of physical channels on its pad
  84 caps.
  85 </p>
  86 <p>
  87 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
  88 accept any number of input channels and will create (but not connect) an
  89 output port for each channel.
  90 </p>
  91 <p>
  92 The element will generate an error when the Jack server is shut down when it
  93 was PAUSED or PLAYING. This element does not support dynamic rate and buffer
  94 size changes at runtime.
  95 </p>
  96 <p>
  97 </p>
  98 <div class="refsect2">
  99 <a name="idp12351168"></a><h3>Example launch line</h3>
 100 <div class="informalexample">
 101   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 102     <tbody>
 103       <tr>
 104         <td class="listing_lines" align="right"><pre>1</pre></td>
 105         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc <span class="gtkdoc opt">!</span> jackaudiosink</pre></td>
 106       </tr>
 107     </tbody>
 108   </table>
 109 </div>
 110  Play a sine wave to using jack.
 111 </div>
 112 <p>
 113 </p>
 114 <p>
 115 Last reviewed on 2006-11-30 (0.10.4)
 116 </p>
 117 <div class="refsynopsisdiv">
 118 <h2>Synopsis</h2>
 119 <div class="refsect2">
 120 <a name="idp15484672"></a><h3>Element Information</h3>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term">plugin</span></p></td>
 126 <td>
 127             <a class="link" href="gst-plugins-good-plugins-plugin-jack.html#plugin-jack">jack</a>
 128           </td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term">author</span></p></td>
 132 <td>Wim Taymans &lt;wim.taymans@gmail.com&gt;</td>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term">class</span></p></td>
 136 <td>Sink/Audio</td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <hr>
 142 <div class="refsect2">
 143 <a name="idp17395088"></a><h3>Element Pads</h3>
 144 <div class="variablelist"><table border="0">
 145 <col align="left" valign="top">
 146 <tbody>
 147 <tr>
 148 <td><p><span class="term">name</span></p></td>
 149 <td>sink</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term">direction</span></p></td>
 153 <td>sink</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term">presence</span></p></td>
 157 <td>always</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term">details</span></p></td>
 161 <td>audio/x-raw-float, endianness=(int)1234, width=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 </div>
 166 </div>
 167 <p>
 168 </p>
 169 </div>
 170 <div class="refsect1">
 171 <a name="gst-plugins-good-plugins-jackaudiosink.details"></a><h2>Details</h2>
 172 <div class="refsect2">
 173 <a name="GstJackAudioSink-struct"></a><h3>struct GstJackAudioSink</h3>
 174 <pre class="programlisting">struct GstJackAudioSink;</pre>
 175 <p>
 176 Opaque <a class="link" href="gst-plugins-good-plugins-jackaudiosink.html#GstJackAudioSink"><span class="type">GstJackAudioSink</span></a>.
 177 </p>
 178 </div>
 179 </div>
 180 <div class="refsect1">
 181 <a name="gst-plugins-good-plugins-jackaudiosink.property-details"></a><h2>Property Details</h2>
 182 <div class="refsect2">
 183 <a name="GstJackAudioSink--client"></a><h3>The <code class="literal">"client"</code> property</h3>
 184 <pre class="programlisting">  "client"                   <span class="type">JackClient</span>*           : Read / Write</pre>
 185 <p>Handle for jack client.</p>
 186 </div>
 187 <hr>
 188 <div class="refsect2">
 189 <a name="GstJackAudioSink--connect"></a><h3>The <code class="literal">"connect"</code> property</h3>
 190 <pre class="programlisting">  "connect"                  <span class="type">GstJackConnect</span>        : Read / Write</pre>
 191 <p>Specify how the output ports will be connected.</p>
 192 <p>Default value: Automatically connect ports to physical ports</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="GstJackAudioSink--server"></a><h3>The <code class="literal">"server"</code> property</h3>
 197 <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>
 198 <p>The Jack server to connect to (NULL = default).</p>
 199 <p>Default value: NULL</p>
 200 </div>
 201 </div>
 202 <div class="refsect1">
 203 <a name="gst-plugins-good-plugins-jackaudiosink.see-also"></a><h2>See Also</h2>
 204 <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>
 205 </div>
 206 </div>
 207 <div class="footer">
 208 <hr>
 209           Generated by GTK-Doc V1.17</div>
 210 </body>
 211 </html>