docs/plugins/html/gst-plugins-good-plugins-oss4sink.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>oss4sink</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-oss4mixer.html" title="oss4mixer">
  10 <link rel="next" href="gst-plugins-good-plugins-oss4src.html" title="oss4src">
  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-oss4mixer.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-oss4src.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-oss4sink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-oss4sink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-oss4sink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-oss4sink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-oss4sink.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-oss4sink"></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-oss4sink.top_of_page"></a>oss4sink</span></h2>
  40 <p>oss4sink — Output to a sound card via OSS version 4</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-oss4sink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstOss4Sink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-oss4sink.html#GstOss4Sink-struct" title="struct GstOss4Sink">GstOss4Sink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-oss4sink.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                            +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiosink.html#GstAudioSink">GstAudioSink</a>
  58                                  +----GstOss4Sink
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-good-plugins-oss4sink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  63 <p>
  64 GstOss4Sink implements
  65  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gststreamvolume.html#GstStreamVolume">GstStreamVolume</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>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-good-plugins-oss4sink.properties"></a><h2>Properties</h2>
  69 <pre class="synopsis">
  70   "<a class="link" href="gst-plugins-good-plugins-oss4sink.html#GstOss4Sink--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
  71   "<a class="link" href="gst-plugins-good-plugins-oss4sink.html#GstOss4Sink--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-oss4sink.html#GstOss4Sink--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
  73   "<a class="link" href="gst-plugins-good-plugins-oss4sink.html#GstOss4Sink--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
  74 </pre>
  75 </div>
  76 <div class="refsect1">
  77 <a name="gst-plugins-good-plugins-oss4sink.description"></a><h2>Description</h2>
  78 <p>
  79 This element lets you output sound using the Open Sound System (OSS)
  80 version 4.
  81 </p>
  82 <p>
  83 Note that you should almost always use generic audio conversion elements
  84 like audioconvert and audioresample in front of an audiosink to make sure
  85 your pipeline works under all circumstances (those conversion elements will
  86 act in passthrough-mode if no conversion is necessary).
  87 </p>
  88 <p>
  89 </p>
  90 <div class="refsect2">
  91 <a name="idp18884144"></a><h3>Example pipelines</h3>
  92 <div class="informalexample">
  93   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  94     <tbody>
  95       <tr>
  96         <td class="listing_lines" align="right"><pre>1</pre></td>
  97         <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.1</span> <span class="gtkdoc opt">!</span> oss4sink</pre></td>
  98       </tr>
  99     </tbody>
 100   </table>
 101 </div>
 102  will output a sine wave (continuous beep sound) to your sound card (with
 103 a very low volume as precaution).
 104 <div class="informalexample">
 105   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 106     <tbody>
 107       <tr>
 108         <td class="listing_lines" align="right"><pre>1</pre></td>
 109         <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>music<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> oss4sink</pre></td>
 110       </tr>
 111     </tbody>
 112   </table>
 113 </div>
 114  will play an Ogg/Vorbis audio file and output it using the Open Sound System
 115 version 4.
 116 </div>
 117 <p>
 118 </p>
 119 <div class="refsynopsisdiv">
 120 <h2>Synopsis</h2>
 121 <div class="refsect2">
 122 <a name="idp19118944"></a><h3>Element Information</h3>
 123 <div class="variablelist"><table border="0">
 124 <col align="left" valign="top">
 125 <tbody>
 126 <tr>
 127 <td><p><span class="term">plugin</span></p></td>
 128 <td>
 129             <a class="link" href="gst-plugins-good-plugins-plugin-oss4.html#plugin-oss4">oss4</a>
 130           </td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term">author</span></p></td>
 134 <td>Tim-Philipp Müller &lt;tim centricular net&gt;</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">class</span></p></td>
 138 <td>Sink/Audio</td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="idp17830256"></a><h3>Element Pads</h3>
 146 <div class="variablelist"><table border="0">
 147 <col align="left" valign="top">
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term">name</span></p></td>
 151 <td>sink</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term">direction</span></p></td>
 155 <td>sink</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">presence</span></p></td>
 159 <td>always</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term">details</span></p></td>
 163 <td>audio/x-alaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"></span></p></td>
 167 <td> audio/x-mulaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"></span></p></td>
 171 <td> audio/x-raw-int, width=(int)32, depth=(int)32, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"></span></p></td>
 175 <td> audio/x-raw-int, width=(int)32, depth=(int){ 32, 24 }, signed=(boolean)true, endianness=(int)4321, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"></span></p></td>
 179 <td> audio/x-raw-int, width=(int){ 32, 24 }, depth=(int)24, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term"></span></p></td>
 183 <td> audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean){ false, true }, endianness=(int){ 1234, 4321 }, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"></span></p></td>
 187 <td> audio/x-raw-int, width=(int)8, depth=(int)8, signed=(boolean){ true, false }, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 188 </tr>
 189 </tbody>
 190 </table></div>
 191 </div>
 192 </div>
 193 <p>
 194 </p>
 195 </div>
 196 <div class="refsect1">
 197 <a name="gst-plugins-good-plugins-oss4sink.details"></a><h2>Details</h2>
 198 <div class="refsect2">
 199 <a name="GstOss4Sink-struct"></a><h3>struct GstOss4Sink</h3>
 200 <pre class="programlisting">struct GstOss4Sink;</pre>
 201 <p>
 202 </p>
 203 </div>
 204 </div>
 205 <div class="refsect1">
 206 <a name="gst-plugins-good-plugins-oss4sink.property-details"></a><h2>Property Details</h2>
 207 <div class="refsect2">
 208 <a name="GstOss4Sink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 209 <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>
 210 <p>OSS4 device (e.g. /dev/oss/hdaudio0/pcm0 or /dev/dspN) (NULL = use first available playback device).</p>
 211 <p>Default value: NULL</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="GstOss4Sink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 216 <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>
 217 <p>Human-readable name of the sound device.</p>
 218 <p>Default value: NULL</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstOss4Sink--mute"></a><h3>The <code class="literal">"mute"</code> property</h3>
 223 <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>
 224 <p>Mute state of this stream.</p>
 225 <p>Default value: FALSE</p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="GstOss4Sink--volume"></a><h3>The <code class="literal">"volume"</code> property</h3>
 230 <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>
 231 <p>Linear volume of this stream, 1.0=100%.</p>
 232 <p>Allowed values: [0,10]</p>
 233 <p>Default value: 1</p>
 234 </div>
 235 </div>
 236 </div>
 237 <div class="footer">
 238 <hr>
 239           Generated by GTK-Doc V1.17</div>
 240 </body>
 241 </html>