docs/plugins/html/gst-plugins-good-plugins-pulsesink.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>pulsesink</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-progressreport.html" title="progressreport">
  10 <link rel="next" href="gst-plugins-good-plugins-pulsesrc.html" title="pulsesrc">
  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-progressreport.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-pulsesrc.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-pulsesink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-pulsesink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-pulsesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-pulsesink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-pulsesink.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-pulsesink"></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-pulsesink.top_of_page"></a>pulsesink</span></h2>
  40 <p>pulsesink — Plays audio to 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-pulsesink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstPulseSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink-struct" title="struct GstPulseSink">GstPulseSink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-pulsesink.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/GstBaseSink.html">GstBaseSink</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink">GstBaseAudioSink</a>
  57                            +----GstPulseSink
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gst-plugins-good-plugins-pulsesink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  62 <p>
  63 GstPulseSink implements
  64  <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> 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>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-good-plugins-pulsesink.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink--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
  70   "<a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink--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
  71   "<a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink--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
  72   "<a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink--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
  73   "<a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink--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
  74   "<a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink--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
  75   "<a class="link" href="gst-plugins-good-plugins-pulsesink.html#GstPulseSink--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
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="gst-plugins-good-plugins-pulsesink.description"></a><h2>Description</h2>
  80 <p>
  81 This element outputs audio to 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="idp19660528"></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 filesrc location<span class="gtkdoc opt">=</span>sine<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisdec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> pulsesink</pre></td>
  94       </tr>
  95     </tbody>
  96   </table>
  97 </div>
  98  Play an Ogg/Vorbis file.
  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 <span class="gtkdoc opt">-</span>v audiotestsrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> volume volume<span class="gtkdoc opt">=</span><span class="number">0.4</span> <span class="gtkdoc opt">!</span> pulsesink</pre></td>
 105       </tr>
 106     </tbody>
 107   </table>
 108 </div>
 109  Play a 440Hz sine wave.
 110 <div class="informalexample">
 111   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 112     <tbody>
 113       <tr>
 114         <td class="listing_lines" align="right"><pre>1</pre></td>
 115         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v audiotestsrc <span class="gtkdoc opt">!</span> pulsesink stream<span class="gtkdoc opt">-</span>properties<span class="gtkdoc opt">=</span><span class="string">&quot;props,media.title=test&quot;</span></pre></td>
 116       </tr>
 117     </tbody>
 118   </table>
 119 </div>
 120  Play a sine wave and set a stream property. The property can be checked
 121 with "pactl list".
 122 </div>
 123 <p>
 124 </p>
 125 <div class="refsynopsisdiv">
 126 <h2>Synopsis</h2>
 127 <div class="refsect2">
 128 <a name="idp17451952"></a><h3>Element Information</h3>
 129 <div class="variablelist"><table border="0">
 130 <col align="left" valign="top">
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term">plugin</span></p></td>
 134 <td>
 135             <a class="link" href="gst-plugins-good-plugins-plugin-pulseaudio.html#plugin-pulseaudio">pulseaudio</a>
 136           </td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term">author</span></p></td>
 140 <td>Lennart Poettering</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term">class</span></p></td>
 144 <td>Sink/Audio</td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="idp17326288"></a><h3>Element Pads</h3>
 152 <div class="variablelist"><table border="0">
 153 <col align="left" valign="top">
 154 <tbody>
 155 <tr>
 156 <td><p><span class="term">name</span></p></td>
 157 <td>sink</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term">direction</span></p></td>
 161 <td>sink</td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term">presence</span></p></td>
 165 <td>always</td>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term">details</span></p></td>
 169 <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>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"></span></p></td>
 173 <td> audio/x-raw-float, endianness=(int){ 1234, 4321 }, width=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term"></span></p></td>
 177 <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>
 178 </tr>
 179 <tr>
 180 <td><p><span class="term"></span></p></td>
 181 <td> audio/x-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean)true, width=(int)24, depth=(int)24, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 182 </tr>
 183 <tr>
 184 <td><p><span class="term"></span></p></td>
 185 <td> audio/x-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean)true, width=(int)32, depth=(int)24, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term"></span></p></td>
 189 <td> audio/x-raw-int, signed=(boolean)false, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 190 </tr>
 191 <tr>
 192 <td><p><span class="term"></span></p></td>
 193 <td> audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term"></span></p></td>
 197 <td> audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 </div>
 202 </div>
 203 <p>
 204 </p>
 205 </div>
 206 <div class="refsect1">
 207 <a name="gst-plugins-good-plugins-pulsesink.details"></a><h2>Details</h2>
 208 <div class="refsect2">
 209 <a name="GstPulseSink-struct"></a><h3>struct GstPulseSink</h3>
 210 <pre class="programlisting">struct GstPulseSink;</pre>
 211 <p>
 212 </p>
 213 </div>
 214 </div>
 215 <div class="refsect1">
 216 <a name="gst-plugins-good-plugins-pulsesink.property-details"></a><h2>Property Details</h2>
 217 <div class="refsect2">
 218 <a name="GstPulseSink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 219 <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>
 220 <p>The PulseAudio sink device to connect to.</p>
 221 <p>Default value: NULL</p>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="GstPulseSink--server"></a><h3>The <code class="literal">"server"</code> property</h3>
 226 <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>
 227 <p>The PulseAudio server to connect to.</p>
 228 <p>Default value: NULL</p>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="GstPulseSink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 233 <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>
 234 <p>Human-readable name of the sound device.</p>
 235 <p>Default value: NULL</p>
 236 </div>
 237 <hr>
 238 <div class="refsect2">
 239 <a name="GstPulseSink--volume"></a><h3>The <code class="literal">"volume"</code> property</h3>
 240 <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>
 241 <p>Linear volume of this stream, 1.0=100%.</p>
 242 <p>Allowed values: [0,10]</p>
 243 <p>Default value: 1</p>
 244 </div>
 245 <hr>
 246 <div class="refsect2">
 247 <a name="GstPulseSink--mute"></a><h3>The <code class="literal">"mute"</code> property</h3>
 248 <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>
 249 <p>Mute state of this stream.</p>
 250 <p>Default value: FALSE</p>
 251 </div>
 252 <hr>
 253 <div class="refsect2">
 254 <a name="GstPulseSink--client"></a><h3>The <code class="literal">"client"</code> property</h3>
 255 <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>
 256 <p>
 257 The PulseAudio client name to use.
 258 </p>
 259 <p>Default value: "&lt;unknown&gt;"</p>
 260 <p class="since">Since 0.10.27</p>
 261 </div>
 262 <hr>
 263 <div class="refsect2">
 264 <a name="GstPulseSink--stream-properties"></a><h3>The <code class="literal">"stream-properties"</code> property</h3>
 265 <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>
 266 <p>
 267 List of pulseaudio stream properties. A list of defined properties can be
 268 found in the <a class="ulink" href="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html" target="_top">pulseaudio api docs</a>.
 269 </p>
 270 <p>
 271 Below is an example for registering as a music application to pulseaudio.
 272 </p>
 273 <div class="informalexample">
 274   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 275     <tbody>
 276       <tr>
 277         <td class="listing_lines" align="right"><pre>1
 278 2
 279 3
 280 4</pre></td>
 281         <td class="listing_code"><pre class="programlisting">GstStructure <span class="gtkdoc opt">*</span>props<span class="gtkdoc opt">;</span>
 282 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>
 283 <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>
 284 gst_structure_free</pre></td>
 285       </tr>
 286     </tbody>
 287   </table>
 288 </div>
 289
 290 <p>
 291 </p>
 292 <p class="since">Since 0.10.26</p>
 293 </div>
 294 </div>
 295 <div class="refsect1">
 296 <a name="gst-plugins-good-plugins-pulsesink.see-also"></a><h2>See Also</h2>
 297 pulsesrc, pulsemixer
 298 </div>
 299 </div>
 300 <div class="footer">
 301 <hr>
 302           Generated by GTK-Doc V1.17</div>
 303 </body>
 304 </html>