docs/plugins/html/gst-plugins-good-plugins-pulsesrc.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>pulsesrc</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-pulsesink.html" title="pulsesink">
  10 <link rel="next" href="gst-plugins-good-plugins-pulsemixer.html" title="pulsemixer">
  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-pulsesink.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-pulsemixer.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-pulsesrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-pulsesrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-pulsesrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-pulsesrc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-pulsesrc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-pulsesrc"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-pulsesrc.top_of_page"></a>pulsesrc</span></h2>
  40 <p>pulsesrc — Captures audio from a PulseAudio server</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-good-plugins-pulsesrc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstPulseSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc-struct" title="struct GstPulseSrc">GstPulseSrc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-pulsesrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  57                            +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosrc.html#GstBaseAudioSrc">GstBaseAudioSrc</a>
  58                                  +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiosrc.html#GstAudioSrc">GstAudioSrc</a>
  59                                        +----GstPulseSrc
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="gst-plugins-good-plugins-pulsesrc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  64 <p>
  65 GstPulseSrc implements
  66  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstImplementsInterface.html">GstImplementsInterface</a>,  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstmixer.html#GstMixer">GstMixer</a> and  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a>.</p>
  67 </div>
  68 <div class="refsect1">
  69 <a name="gst-plugins-good-plugins-pulsesrc.properties"></a><h2>Properties</h2>
  70 <pre class="synopsis">
  71   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--device" title='The "device" property'>device</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  72   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--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
  73   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--device-name" title='The "device-name" property'>device-name</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  74   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--stream-properties" title='The "stream-properties" property'>stream-properties</a>"        <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a>*         : Read / Write
  75   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--client" title='The "client" property'>client</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="gst-plugins-good-plugins-pulsesrc.description"></a><h2>Description</h2>
  80 <p>
  81 This element captures audio from a
  82 <a class="ulink" href="" target="_top">PulseAudio sound server</a>.
  83 </p>
  84 <p>
  85 </p>
  86 <div class="refsect2">
  87 <a name="idp20135440"></a><h3>Example pipelines</h3>
  88 <div class="informalexample">
  89   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  90     <tbody>
  91       <tr>
  92         <td class="listing_lines" align="right"><pre>1</pre></td>
  93         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v pulsesrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> vorbisenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>alsasrc<span class="gtkdoc opt">.</span>ogg</pre></td>
  94       </tr>
  95     </tbody>
  96   </table>
  97 </div>
  98  Record from a sound card using pulseaudio and encode to Ogg/Vorbis.
  99 </div>
 100 <p>
 101 </p>
 102 <div class="refsynopsisdiv">
 103 <h2>Synopsis</h2>
 104 <div class="refsect2">
 105 <a name="idp14527904"></a><h3>Element Information</h3>
 106 <div class="variablelist"><table border="0">
 107 <col align="left" valign="top">
 108 <tbody>
 109 <tr>
 110 <td><p><span class="term">plugin</span></p></td>
 111 <td>
 112             <a class="link" href="gst-plugins-good-plugins-plugin-pulseaudio.html#plugin-pulseaudio">pulseaudio</a>
 113           </td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term">author</span></p></td>
 117 <td>Lennart Poettering</td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">class</span></p></td>
 121 <td>Source/Audio</td>
 122 </tr>
 123 </tbody>
 124 </table></div>
 125 </div>
 126 <hr>
 127 <div class="refsect2">
 128 <a name="idp19556336"></a><h3>Element Pads</h3>
 129 <div class="variablelist"><table border="0">
 130 <col align="left" valign="top">
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term">name</span></p></td>
 134 <td>src</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">direction</span></p></td>
 138 <td>source</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">presence</span></p></td>
 142 <td>always</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">details</span></p></td>
 146 <td>audio/x-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean)true, width=(int)16, depth=(int)16, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term"></span></p></td>
 150 <td> audio/x-raw-float, endianness=(int){ 1234, 4321 }, width=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"></span></p></td>
 154 <td> audio/x-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean)true, width=(int)32, depth=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"></span></p></td>
 158 <td> audio/x-raw-int, signed=(boolean)false, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term"></span></p></td>
 162 <td> audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term"></span></p></td>
 166 <td> audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 </div>
 172 <p>
 173 </p>
 174 </div>
 175 <div class="refsect1">
 176 <a name="gst-plugins-good-plugins-pulsesrc.details"></a><h2>Details</h2>
 177 <div class="refsect2">
 178 <a name="GstPulseSrc-struct"></a><h3>struct GstPulseSrc</h3>
 179 <pre class="programlisting">struct GstPulseSrc;</pre>
 180 <p>
 181 </p>
 182 </div>
 183 </div>
 184 <div class="refsect1">
 185 <a name="gst-plugins-good-plugins-pulsesrc.property-details"></a><h2>Property Details</h2>
 186 <div class="refsect2">
 187 <a name="GstPulseSrc--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 188 <pre class="programlisting">  "device"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 189 <p>The PulseAudio source device to connect to.</p>
 190 <p>Default value: NULL</p>
 191 </div>
 192 <hr>
 193 <div class="refsect2">
 194 <a name="GstPulseSrc--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 PulseAudio server to connect to.</p>
 197 <p>Default value: NULL</p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="GstPulseSrc--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 202 <pre class="programlisting">  "device-name"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 203 <p>Human-readable name of the sound device.</p>
 204 <p>Default value: NULL</p>
 205 </div>
 206 <hr>
 207 <div class="refsect2">
 208 <a name="GstPulseSrc--stream-properties"></a><h3>The <code class="literal">"stream-properties"</code> property</h3>
 209 <pre class="programlisting">  "stream-properties"        <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a>*         : Read / Write</pre>
 210 <p>
 211 List of pulseaudio stream properties. A list of defined properties can be
 212 found in the <a class="ulink" href="" target="_top">pulseaudio api docs</a>.
 213 </p>
 214 <p>
 215 Below is an example for registering as a music application to pulseaudio.
 216 </p>
 217 <div class="informalexample">
 218   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 219     <tbody>
 220       <tr>
 221         <td class="listing_lines" align="right"><pre>1
 222 2
 223 3
 224 4</pre></td>
 225         <td class="listing_code"><pre class="programlisting">GstStructure <span class="gtkdoc opt">*</span>props<span class="gtkdoc opt">;</span>
 226 props <span class="gtkdoc opt">=</span> <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#gst-structure-from-string">gst_structure_from_string</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;props,media.role=music&quot;</span><span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
 227 <span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-set">g_object_set</a></span> <span class="gtkdoc opt">(</span>pulse<span class="gtkdoc opt">,</span> <span class="string">&quot;stream-properties&quot;</span><span class="gtkdoc opt">,</span> props<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
 228 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#gst-structure-free">gst_structure_free</a></span> <span class="gtkdoc opt">(</span>props<span class="gtkdoc opt">);</span></pre></td>
 229       </tr>
 230     </tbody>
 231   </table>
 232 </div>
 233
 234 <p>
 235 </p>
 236 <p class="since">Since 0.10.26</p>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="GstPulseSrc--client"></a><h3>The <code class="literal">"client"</code> property</h3>
 241 <pre class="programlisting">  "client"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 242 <p>The PulseAudio client_name_to_use.</p>
 243 <p>Default value: "&lt;unknown&gt;"</p>
 244 </div>
 245 </div>
 246 <div class="refsect1">
 247 <a name="gst-plugins-good-plugins-pulsesrc.see-also"></a><h2>See Also</h2>
 248 pulsesink, pulsemixer
 249 </div>
 250 </div>
 251 <div class="footer">
 252 <hr>
 253           Generated by GTK-Doc V1.17</div>
 254 </body>
 255 </html>