docs/plugins/html/gst-plugins-good-plugins-osssink.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>osssink</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-ossmixer.html" title="ossmixer">
  10 <link rel="next" href="gst-plugins-good-plugins-osssrc.html" title="osssrc">
  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-ossmixer.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-osssrc.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-osssink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-osssink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-osssink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-osssink.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-osssink"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-osssink.top_of_page"></a>osssink</span></h2>
  38 <p>osssink — Output to a sound card via OSS</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-osssink.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstOssSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-osssink.html#GstOssSink-struct" title="struct GstOssSink">GstOssSink</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-osssink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink">GstBaseAudioSink</a>
  55                            +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiosink.html#GstAudioSink">GstAudioSink</a>
  56                                  +----GstOssSink
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-good-plugins-osssink.properties"></a><h2>Properties</h2>
  61 <pre class="synopsis">
  62   "<a class="link" href="gst-plugins-good-plugins-osssink.html#GstOssSink--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
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-good-plugins-osssink.description"></a><h2>Description</h2>
  67 <p>
  68 This element lets you output sound using the Open Sound System (OSS).
  69 </p>
  70 <p>
  71 Note that you should almost always use generic audio conversion elements
  72 like audioconvert and audioresample in front of an audiosink to make sure
  73 your pipeline works under all circumstances (those conversion elements will
  74 act in passthrough-mode if no conversion is necessary).
  75 </p>
  76 <p>
  77 </p>
  78 <div class="refsect2">
  79 <a name="idp20084464"></a><h3>Example pipelines</h3>
  80 <div class="informalexample">
  81   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  82     <tbody>
  83       <tr>
  84         <td class="listing_lines" align="right"><pre>1</pre></td>
  85         <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> osssink</pre></td>
  86       </tr>
  87     </tbody>
  88   </table>
  89 </div>
  90  will output a sine wave (continuous beep sound) to your sound card (with
  91 a very low volume as precaution).
  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 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> osssink</pre></td>
  98       </tr>
  99     </tbody>
 100   </table>
 101 </div>
 102  will play an Ogg/Vorbis audio file and output it using the Open Sound System.
 103 </div>
 104 <p>
 105 </p>
 106 <div class="refsynopsisdiv">
 107 <h2>Synopsis</h2>
 108 <div class="refsect2">
 109 <a name="idp19999792"></a><h3>Element Information</h3>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term">plugin</span></p></td>
 115 <td>
 116             <a class="link" href="gst-plugins-good-plugins-plugin-ossaudio.html#plugin-ossaudio">ossaudio</a>
 117           </td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">author</span></p></td>
 121 <td>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;, Wim Taymans &lt;wim.taymans@chello.be&gt;</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">class</span></p></td>
 125 <td>Sink/Audio</td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="idp18635520"></a><h3>Element Pads</h3>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term">name</span></p></td>
 138 <td>sink</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">direction</span></p></td>
 142 <td>sink</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">presence</span></p></td>
 146 <td>always</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term">details</span></p></td>
 150 <td>audio/x-raw-int, endianness=(int){ 1234 }, signed=(boolean){ true, false }, width=(int)16, depth=(int)16, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2 ]</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"></span></p></td>
 154 <td> audio/x-raw-int, signed=(boolean){ true, false }, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2 ]</td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 </div>
 159 </div>
 160 <p>
 161 </p>
 162 </div>
 163 <div class="refsect1">
 164 <a name="gst-plugins-good-plugins-osssink.details"></a><h2>Details</h2>
 165 <div class="refsect2">
 166 <a name="GstOssSink-struct"></a><h3>struct GstOssSink</h3>
 167 <pre class="programlisting">struct GstOssSink;</pre>
 168 <p>
 169 </p>
 170 </div>
 171 </div>
 172 <div class="refsect1">
 173 <a name="gst-plugins-good-plugins-osssink.property-details"></a><h2>Property Details</h2>
 174 <div class="refsect2">
 175 <a name="GstOssSink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 176 <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>
 177 <p>OSS device (usually /dev/dspN).</p>
 178 <p>Default value: "/dev/dsp"</p>
 179 </div>
 180 </div>
 181 </div>
 182 <div class="footer">
 183 <hr>
 184           Generated by GTK-Doc V1.17</div>
 185 </body>
 186 </html>