/usr/share/gtk-doc/html/gst-plugins-good-plugins-1.0/gst-plugins-good-plugins-jackaudiosrc.html is in gstreamer1.0-plugins-good-doc 1.14.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>jackaudiosrc: GStreamer Good Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-jackaudiosink.html" title="jackaudiosink">
<link rel="next" href="gst-plugins-good-plugins-jpegdec.html" title="jpegdec">
<meta name="generator" content="GTK-Doc V1.27 (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="#gst-plugins-good-plugins-jackaudiosrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#gst-plugins-good-plugins-jackaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gst-plugins-good-plugins-jackaudiosrc.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-good-plugins-jackaudiosink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-good-plugins-jpegdec.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-good-plugins-jackaudiosrc"></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-jackaudiosrc.top_of_page"></a>jackaudiosrc</span></h2>
<p>jackaudiosrc</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" 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">
<span class="type">JackClient</span> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--client" title="The “client” property">client</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstJackConnect</span></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--connect" title="The “connect” property">connect</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--server" title="The “server” property">server</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--client-name" title="The “client-name” property">client-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstJackTransport</span></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--transport" title="The “transport” property">transport</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc--port-pattern" title="The “port-pattern” property">port-pattern</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstJackAudioSrc"></a><div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="gst-plugins-good-plugins-jackaudiosrc.html#GstJackAudioSrc-struct" title="struct GstJackAudioSrc">GstJackAudioSrc</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="../gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
<span class="lineart">╰──</span> <a href="../gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
<span class="lineart">╰──</span> <a href="../gstreamer-libs-1.0/GstBaseSrc.html#GstBaseSrc-struct">GstBaseSrc</a>
<span class="lineart">╰──</span> <a href="../gstreamer-libs-1.0/GstPushSrc.html#GstPushSrc-struct">GstPushSrc</a>
<span class="lineart">╰──</span> <a href="../gst-plugins-base-libs-1.0/GstAudioBaseSrc.html#GstAudioBaseSrc-struct">GstAudioBaseSrc</a>
<span class="lineart">╰──</span> GstJackAudioSrc
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.description"></a><h2>Description</h2>
<p>A Src that inputs data from Jack ports.</p>
<p>It will create N Jack ports named in_<name>_<num> where
<name> is the element name and <num> 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-jackaudiosrc.html#GstJackAudioSrc--connect" title="The “connect” property"><span class="type">“connect”</span></a> property is set to auto, this element
will try to connect each input port to a random physical jack output pin. </p>
<p>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
accept any number of output channels and will create (but not connect) an
input 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>
<div class="refsect2">
<a name="id-1.2.82.7.8"></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<span class="gtkdoc opt">-</span><span class="number">1.0</span> 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>
</tr>
</tbody>
</table>
</div>
Get audio input into gstreamer from jack.
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.82.7.9.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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>Tristan Matthews <tristan@sat.qc.ca></td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Source/Audio</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.82.7.9.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</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, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstJackAudioSrc-struct"></a><h3>struct GstJackAudioSrc</h3>
<pre class="programlisting">struct GstJackAudioSrc;</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstJackAudioSrc--client"></a><h3>The <code class="literal">“client”</code> property</h3>
<pre class="programlisting"> “client” <span class="type">JackClient</span> *</pre>
<p>Handle for jack client.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GstJackAudioSrc--connect"></a><h3>The <code class="literal">“connect”</code> property</h3>
<pre class="programlisting"> “connect” <span class="type">GstJackConnect</span></pre>
<p>Specify how the input ports will be connected.</p>
<p>Flags: Read / Write</p>
<p>Default value: Automatically connect ports to physical ports</p>
</div>
<hr>
<div class="refsect2">
<a name="GstJackAudioSrc--server"></a><h3>The <code class="literal">“server”</code> property</h3>
<pre class="programlisting"> “server” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The Jack server to connect to (NULL = default).</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstJackAudioSrc--client-name"></a><h3>The <code class="literal">“client-name”</code> property</h3>
<pre class="programlisting"> “client-name” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The client name to use.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstJackAudioSrc--transport"></a><h3>The <code class="literal">“transport”</code> property</h3>
<pre class="programlisting"> “transport” <span class="type">GstJackTransport</span></pre>
<p>Jack transport behaviour of the client.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GstJackAudioSrc--port-pattern"></a><h3>The <code class="literal">“port-pattern”</code> property</h3>
<pre class="programlisting"> “port-pattern” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>autoconnect to ports matching pattern, when NULL connect to physical ports</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: 1.6</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-jackaudiosrc.see-also"></a><h2>See Also</h2>
<p><a href="../gst-plugins-base-libs-1.0/GstAudioBaseSrc.html#GstAudioBaseSrc-struct"><span class="type">GstAudioBaseSrc</span></a>, <a href="../gst-plugins-base-libs-1.0/GstAudioRingBuffer.html#GstAudioRingBuffer-struct"><span class="type">GstAudioRingBuffer</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|