docs/plugins/html/gst-plugins-good-plugins-jackaudiosrc.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>jackaudiosrc</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-ismlmux.html" title="ismlmux">
  10 <link rel="next" href="gst-plugins-good-plugins-jackaudiosink.html" title="jackaudiosink">
  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-ismlmux.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-jackaudiosink.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-jackaudiosrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-jackaudiosrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-jackaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-jackaudiosrc.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-jackaudiosrc"></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-jackaudiosrc.top_of_page"></a>jackaudiosrc</span></h2>
  38 <p>jackaudiosrc — Captures audio from 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-jackaudiosrc.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstJackAudioSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc-struct" title="struct GstJackAudioSrc">GstJackAudioSrc</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-jackaudiosrc.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/GstBaseSrc.html">GstBaseSrc</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  55                            +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc">GstBaseAudioSrc</a>
  56                                  +----GstJackAudioSrc
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-good-plugins-jackaudiosrc.properties"></a><h2>Properties</h2>
  61 <pre class="synopsis">
  62   "<a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--client" title='The "client" property'>client</a>"                   <span class="type">JackClient</span>*           : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--connect" title='The "connect" property'>connect</a>"                  <span class="type">GstJackConnect</span>        : Read / Write
  64   "<a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--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
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-good-plugins-jackaudiosrc.description"></a><h2>Description</h2>
  69 <p>
  70 A Src that inputs data from Jack ports.
  71 </p>
  72 <p>
  73 It will create N Jack ports named in_&lt;name&gt;_&lt;num&gt; where
  74 &lt;name&gt; is the element name and &lt;num&gt; is starting from 1.
  75 Each port corresponds to a gstreamer channel.
  76 </p>
  77 <p>
  78 The samplerate as exposed on the caps is always the same as the samplerate of
  79 the jack server.
  80 </p>
  81 <p>
  82 When the <a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--connect" title='The "connect" property'><span class="type">"connect"</span></a> property is set to auto, this element
  83 will try to connect each input port to a random physical jack output pin.
  84 </p>
  85 <p>
  86 When the <a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--connect" title='The "connect" property'><span class="type">"connect"</span></a> property is set to none, the element will
  87 accept any number of output channels and will create (but not connect) an
  88 input port for each channel.
  89 </p>
  90 <p>
  91 The element will generate an error when the Jack server is shut down when it
  92 was PAUSED or PLAYING. This element does not support dynamic rate and buffer
  93 size changes at runtime.
  94 </p>
  95 <p>
  96 </p>
  97 <div class="refsect2">
  98 <a name="idp10524848"></a><h3>Example launch line</h3>
  99 <div class="informalexample">
 100   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 101     <tbody>
 102       <tr>
 103         <td class="listing_lines" align="right"><pre>1</pre></td>
 104         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch jackaudiosrc connect<span class="gtkdoc opt">=</span><span class="number">0</span> <span class="gtkdoc opt">!</span> jackaudiosink connect<span class="gtkdoc opt">=</span><span class="number">0</span></pre></td>
 105       </tr>
 106     </tbody>
 107   </table>
 108 </div>
 109  Get audio input into gstreamer from jack.
 110 </div>
 111 <p>
 112 </p>
 113 <p>
 114 Last reviewed on 2008-07-22 (0.10.4)
 115 </p>
 116 <div class="refsynopsisdiv">
 117 <h2>Synopsis</h2>
 118 <div class="refsect2">
 119 <a name="idp14503376"></a><h3>Element Information</h3>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody>
 123 <tr>
 124 <td><p><span class="term">plugin</span></p></td>
 125 <td>
 126             <a class="link" href="gst-plugins-good-plugins-plugin-jack.html#plugin-jack">jack</a>
 127           </td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term">author</span></p></td>
 131 <td>Tristan Matthews &lt;tristan@sat.qc.ca&gt;</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term">class</span></p></td>
 135 <td>Source/Audio</td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="idp16749824"></a><h3>Element Pads</h3>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term">name</span></p></td>
 148 <td>src</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term">direction</span></p></td>
 152 <td>source</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term">presence</span></p></td>
 156 <td>always</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term">details</span></p></td>
 160 <td>audio/x-raw-float, endianness=(int)1234, width=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 </div>
 166 <p>
 167 </p>
 168 </div>
 169 <div class="refsect1">
 170 <a name="gst-plugins-good-plugins-jackaudiosrc.details"></a><h2>Details</h2>
 171 <div class="refsect2">
 172 <a name="GstJackAudioSrc-struct"></a><h3>struct GstJackAudioSrc</h3>
 173 <pre class="programlisting">struct GstJackAudioSrc;</pre>
 174 <p>
 175 </p>
 176 </div>
 177 </div>
 178 <div class="refsect1">
 179 <a name="gst-plugins-good-plugins-jackaudiosrc.property-details"></a><h2>Property Details</h2>
 180 <div class="refsect2">
 181 <a name="GstJackAudioSrc--client"></a><h3>The <code class="literal">"client"</code> property</h3>
 182 <pre class="programlisting">  "client"                   <span class="type">JackClient</span>*           : Read / Write</pre>
 183 <p>Handle for jack client.</p>
 184 </div>
 185 <hr>
 186 <div class="refsect2">
 187 <a name="GstJackAudioSrc--connect"></a><h3>The <code class="literal">"connect"</code> property</h3>
 188 <pre class="programlisting">  "connect"                  <span class="type">GstJackConnect</span>        : Read / Write</pre>
 189 <p>Specify how the input ports will be connected.</p>
 190 <p>Default value: Automatically connect ports to physical ports</p>
 191 </div>
 192 <hr>
 193 <div class="refsect2">
 194 <a name="GstJackAudioSrc--server"></a><h3>The <code class="literal">"server"</code> property</h3>
 195 <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>
 196 <p>The Jack server to connect to (NULL = default).</p>
 197 <p>Default value: NULL</p>
 198 </div>
 199 </div>
 200 <div class="refsect1">
 201 <a name="gst-plugins-good-plugins-jackaudiosrc.see-also"></a><h2>See Also</h2>
 202 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc"><span class="type">GstBaseAudioSrc</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>
 203 </div>
 204 </div>
 205 <div class="footer">
 206 <hr>
 207           Generated by GTK-Doc V1.17</div>
 208 </body>
 209 </html>