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.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-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.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-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 <div class="refsynopsisdiv">
  81 <h2>Synopsis</h2>
  82 <div class="refsect2">
  83 <a name="idp11610048"></a><h3>Element Information</h3>
  84 <div class="variablelist"><table border="0">
  85 <col align="left" valign="top">
  86 <tbody>
  87 <tr>
  88 <td><p><span class="term">plugin</span></p></td>
  89 <td>
  90             <a class="link" href="gst-plugins-good-plugins-plugin-pulseaudio.html#plugin-pulseaudio">pulseaudio</a>
  91           </td>
  92 </tr>
  93 <tr>
  94 <td><p><span class="term">author</span></p></td>
  95 <td>Lennart Poettering</td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term">class</span></p></td>
  99 <td>Sink/Audio</td>
 100 </tr>
 101 </tbody>
 102 </table></div>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="idp18308432"></a><h3>Element Pads</h3>
 107 <div class="variablelist"><table border="0">
 108 <col align="left" valign="top">
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term">name</span></p></td>
 112 <td>sink</td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">direction</span></p></td>
 116 <td>sink</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">presence</span></p></td>
 120 <td>always</td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term">details</span></p></td>
 124 <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>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term"></span></p></td>
 128 <td> audio/x-raw-float, endianness=(int){ 1234, 4321 }, width=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term"></span></p></td>
 132 <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>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term"></span></p></td>
 136 <td> audio/x-raw-int, signed=(boolean)false, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term"></span></p></td>
 140 <td> audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"></span></p></td>
 144 <td> audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 32 ]</td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term"></span></p></td>
 148 <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>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term"></span></p></td>
 152 <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>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term"></span></p></td>
 156 <td> audio/x-ac3, framed=(boolean)true</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"></span></p></td>
 160 <td> audio/x-eac3, framed=(boolean)true</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"></span></p></td>
 164 <td> audio/x-dts, framed=(boolean)true, block-size=(int){ 512, 1024, 2048 }</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term"></span></p></td>
 168 <td> audio/mpeg, mpegversion=(int)1, mpegaudioversion=(int)[ 1, 2 ], parsed=(boolean)true</td>
 169 </tr>
 170 </tbody>
 171 </table></div>
 172 </div>
 173 </div>
 174 <p>
 175 </p>
 176 </div>
 177 <div class="refsect1">
 178 <a name="gst-plugins-good-plugins-pulsesink.details"></a><h2>Details</h2>
 179 <div class="refsect2">
 180 <a name="GstPulseSink-struct"></a><h3>struct GstPulseSink</h3>
 181 <pre class="programlisting">struct GstPulseSink;</pre>
 182 <p>
 183 </p>
 184 </div>
 185 </div>
 186 <div class="refsect1">
 187 <a name="gst-plugins-good-plugins-pulsesink.property-details"></a><h2>Property Details</h2>
 188 <div class="refsect2">
 189 <a name="GstPulseSink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 190 <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>
 191 <p>The PulseAudio sink device to connect to.</p>
 192 <p>Default value: NULL</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="GstPulseSink--server"></a><h3>The <code class="literal">"server"</code> property</h3>
 197 <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>
 198 <p>The PulseAudio server to connect to.</p>
 199 <p>Default value: NULL</p>
 200 </div>
 201 <hr>
 202 <div class="refsect2">
 203 <a name="GstPulseSink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 204 <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>
 205 <p>Human-readable name of the sound device.</p>
 206 <p>Default value: NULL</p>
 207 </div>
 208 <hr>
 209 <div class="refsect2">
 210 <a name="GstPulseSink--volume"></a><h3>The <code class="literal">"volume"</code> property</h3>
 211 <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>
 212 <p>Linear volume of this stream, 1.0=100%.</p>
 213 <p>Allowed values: [0,10]</p>
 214 <p>Default value: 1</p>
 215 </div>
 216 <hr>
 217 <div class="refsect2">
 218 <a name="GstPulseSink--mute"></a><h3>The <code class="literal">"mute"</code> property</h3>
 219 <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>
 220 <p>Mute state of this stream.</p>
 221 <p>Default value: FALSE</p>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="GstPulseSink--client"></a><h3>The <code class="literal">"client"</code> property</h3>
 226 <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>
 227 <p>The PulseAudio client name to use.</p>
 228 <p>Default value: "lt-gst-plugins-good-plugins-scan"</p>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="GstPulseSink--stream-properties"></a><h3>The <code class="literal">"stream-properties"</code> property</h3>
 233 <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>
 234 <p>list of pulseaudio stream properties.</p>
 235 </div>
 236 </div>
 237 </div>
 238 <div class="footer">
 239 <hr>
 240           Generated by GTK-Doc V1.18</div>
 241 </body>
 242 </html>