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.76.1">
   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.18 (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/gst-plugins-base-libs/html/gst-plugins-base-libs-gststreamvolume.html#GstStreamVolume">GstStreamVolume</a>,  <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   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--mute" title='The "mute" property'>mute</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  77   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--source-output-index" title='The "source-output-index" property'>source-output-index</a>"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  78   "<a class="link" href="gst-plugins-good-plugins-pulsesrc.html#GstPulseSrc--volume" title='The "volume" property'>volume</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  79 </pre>
  80 </div>
  81 <div class="refsect1">
  82 <a name="gst-plugins-good-plugins-pulsesrc.description"></a><h2>Description</h2>
  83 <div class="refsynopsisdiv">
  84 <h2>Synopsis</h2>
  85 <div class="refsect2">
  86 <a name="idp15171760"></a><h3>Element Information</h3>
  87 <div class="variablelist"><table border="0">
  88 <col align="left" valign="top">
  89 <tbody>
  90 <tr>
  91 <td><p><span class="term">plugin</span></p></td>
  92 <td>
  93             <a class="link" href="gst-plugins-good-plugins-plugin-pulseaudio.html#plugin-pulseaudio">pulseaudio</a>
  94           </td>
  95 </tr>
  96 <tr>
  97 <td><p><span class="term">author</span></p></td>
  98 <td>Lennart Poettering</td>
  99 </tr>
 100 <tr>
 101 <td><p><span class="term">class</span></p></td>
 102 <td>Source/Audio</td>
 103 </tr>
 104 </tbody>
 105 </table></div>
 106 </div>
 107 <hr>
 108 <div class="refsect2">
 109 <a name="idp20130912"></a><h3>Element Pads</h3>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term">name</span></p></td>
 115 <td>src</td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term">direction</span></p></td>
 119 <td>source</td>
 120 </tr>
 121 <tr>
 122 <td><p><span class="term">presence</span></p></td>
 123 <td>always</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term">details</span></p></td>
 127 <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>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"></span></p></td>
 131 <td> audio/x-raw-float, endianness=(int){ 1234, 4321 }, width=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"></span></p></td>
 135 <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>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"></span></p></td>
 139 <td> audio/x-raw-int, signed=(boolean)false, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"></span></p></td>
 143 <td> audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term"></span></p></td>
 147 <td> audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 </div>
 153 <p>
 154 </p>
 155 </div>
 156 <div class="refsect1">
 157 <a name="gst-plugins-good-plugins-pulsesrc.details"></a><h2>Details</h2>
 158 <div class="refsect2">
 159 <a name="GstPulseSrc-struct"></a><h3>struct GstPulseSrc</h3>
 160 <pre class="programlisting">struct GstPulseSrc;</pre>
 161 <p>
 162 </p>
 163 </div>
 164 </div>
 165 <div class="refsect1">
 166 <a name="gst-plugins-good-plugins-pulsesrc.property-details"></a><h2>Property Details</h2>
 167 <div class="refsect2">
 168 <a name="GstPulseSrc--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 169 <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>
 170 <p>The PulseAudio source device to connect to.</p>
 171 <p>Default value: NULL</p>
 172 </div>
 173 <hr>
 174 <div class="refsect2">
 175 <a name="GstPulseSrc--server"></a><h3>The <code class="literal">"server"</code> property</h3>
 176 <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>
 177 <p>The PulseAudio server to connect to.</p>
 178 <p>Default value: NULL</p>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="GstPulseSrc--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 183 <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>
 184 <p>Human-readable name of the sound device.</p>
 185 <p>Default value: NULL</p>
 186 </div>
 187 <hr>
 188 <div class="refsect2">
 189 <a name="GstPulseSrc--stream-properties"></a><h3>The <code class="literal">"stream-properties"</code> property</h3>
 190 <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>
 191 <p>list of pulseaudio stream properties.</p>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="GstPulseSrc--client"></a><h3>The <code class="literal">"client"</code> property</h3>
 196 <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>
 197 <p>The PulseAudio client_name_to_use.</p>
 198 <p>Default value: "lt-gst-plugins-good-plugins-scan"</p>
 199 </div>
 200 <hr>
 201 <div class="refsect2">
 202 <a name="GstPulseSrc--mute"></a><h3>The <code class="literal">"mute"</code> property</h3>
 203 <pre class="programlisting">  "mute"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 204 <p>Mute state of this stream.</p>
 205 <p>Default value: FALSE</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="GstPulseSrc--source-output-index"></a><h3>The <code class="literal">"source-output-index"</code> property</h3>
 210 <pre class="programlisting">  "source-output-index"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
 211 <p>The index of the PulseAudio source output corresponding to this record stream.</p>
 212 <p>Default value: 4294967295</p>
 213 </div>
 214 <hr>
 215 <div class="refsect2">
 216 <a name="GstPulseSrc--volume"></a><h3>The <code class="literal">"volume"</code> property</h3>
 217 <pre class="programlisting">  "volume"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 218 <p>Linear volume of this stream, 1.0=100%.</p>
 219 <p>Allowed values: [0,10]</p>
 220 <p>Default value: 1</p>
 221 </div>
 222 </div>
 223 </div>
 224 <div class="footer">
 225 <hr>
 226           Generated by GTK-Doc V1.18</div>
 227 </body>
 228 </html>