docs/plugins/html/gst-plugins-good-plugins-oss4src.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>oss4src</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-oss4sink.html" title="oss4sink">
  10 <link rel="next" href="gst-plugins-good-plugins-ossmixer.html" title="ossmixer">
  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-oss4sink.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-ossmixer.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-oss4src.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-oss4src.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-oss4src.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-oss4src.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-oss4src.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-oss4src"></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-oss4src.top_of_page"></a>oss4src</span></h2>
  40 <p>oss4src — Capture from 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-oss4src.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstOss4Source"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-oss4src.html#GstOss4Source-struct" title="struct GstOss4Source">GstOss4Source</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-oss4src.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                                        +----GstOss4Source
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="gst-plugins-good-plugins-oss4src.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  64 <p>
  65 GstOss4Source implements
  66  <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-oss4src.properties"></a><h2>Properties</h2>
  70 <pre class="synopsis">
  71   "<a class="link" href="gst-plugins-good-plugins-oss4src.html#GstOss4Source--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-oss4src.html#GstOss4Source--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
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="gst-plugins-good-plugins-oss4src.description"></a><h2>Description</h2>
  77 <p>
  78 This element lets you record sound using the Open Sound System (OSS)
  79 version 4.
  80 </p>
  81 <p>
  82 </p>
  83 <div class="refsect2">
  84 <a name="idp18085824"></a><h3>Example pipelines</h3>
  85 <div class="informalexample">
  86   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  87     <tbody>
  88       <tr>
  89         <td class="listing_lines" align="right"><pre>1</pre></td>
  90         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v oss4src <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> vorbisenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>mymusic<span class="gtkdoc opt">.</span>ogg</pre></td>
  91       </tr>
  92     </tbody>
  93   </table>
  94 </div>
  95  will record sound from your sound card using OSS4 and encode it to an
  96 Ogg/Vorbis file (this will only work if your mixer settings are right
  97 and the right inputs areenabled etc.)
  98 </div>
  99 <p>
 100 </p>
 101 <div class="refsynopsisdiv">
 102 <h2>Synopsis</h2>
 103 <div class="refsect2">
 104 <a name="idp7960816"></a><h3>Element Information</h3>
 105 <div class="variablelist"><table border="0">
 106 <col align="left" valign="top">
 107 <tbody>
 108 <tr>
 109 <td><p><span class="term">plugin</span></p></td>
 110 <td>
 111             <a class="link" href="gst-plugins-good-plugins-plugin-oss4.html#plugin-oss4">oss4</a>
 112           </td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">author</span></p></td>
 116 <td>Tim-Philipp Müller &lt;tim centricular net&gt;</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">class</span></p></td>
 120 <td>Source/Audio</td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="idp15837104"></a><h3>Element Pads</h3>
 128 <div class="variablelist"><table border="0">
 129 <col align="left" valign="top">
 130 <tbody>
 131 <tr>
 132 <td><p><span class="term">name</span></p></td>
 133 <td>src</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">direction</span></p></td>
 137 <td>source</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">presence</span></p></td>
 141 <td>always</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">details</span></p></td>
 145 <td>audio/x-alaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term"></span></p></td>
 149 <td> audio/x-mulaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"></span></p></td>
 153 <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>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"></span></p></td>
 157 <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>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"></span></p></td>
 161 <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>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"></span></p></td>
 165 <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>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term"></span></p></td>
 169 <td> audio/x-raw-int, width=(int)8, depth=(int)8, signed=(boolean){ true, false }, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</td>
 170 </tr>
 171 </tbody>
 172 </table></div>
 173 </div>
 174 </div>
 175 <p>
 176 </p>
 177 </div>
 178 <div class="refsect1">
 179 <a name="gst-plugins-good-plugins-oss4src.details"></a><h2>Details</h2>
 180 <div class="refsect2">
 181 <a name="GstOss4Source-struct"></a><h3>struct GstOss4Source</h3>
 182 <pre class="programlisting">struct GstOss4Source;</pre>
 183 <p>
 184 </p>
 185 </div>
 186 </div>
 187 <div class="refsect1">
 188 <a name="gst-plugins-good-plugins-oss4src.property-details"></a><h2>Property Details</h2>
 189 <div class="refsect2">
 190 <a name="GstOss4Source--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 191 <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>
 192 <p>OSS4 device (e.g. /dev/oss/hdaudio0/pcm0 or /dev/dspN) (NULL = use first available device).</p>
 193 <p>Default value: NULL</p>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="GstOss4Source--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 198 <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>
 199 <p>Human-readable name of the sound device.</p>
 200 <p>Default value: NULL</p>
 201 </div>
 202 </div>
 203 </div>
 204 <div class="footer">
 205 <hr>
 206           Generated by GTK-Doc V1.17</div>
 207 </body>
 208 </html>