docs/plugins/html/gst-plugins-base-plugins-alsasink.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>alsasink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-alsamixer.html" title="alsamixer">
  10 <link rel="next" href="gst-plugins-base-plugins-alsasrc.html" title="alsasrc">
  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-base-plugins-alsamixer.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 Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-alsasrc.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-base-plugins-alsasink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-alsasink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-alsasink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-alsasink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-alsasink.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-alsasink"></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-base-plugins-alsasink.top_of_page"></a>alsasink</span></h2>
  40 <p>alsasink — Output to a sound card via ALSA</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-base-plugins-alsasink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstAlsaSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-alsasink.html#GstAlsaSink-struct" title="struct GstAlsaSink">GstAlsaSink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-plugins-alsasink.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                                  +----GstAlsaSink
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-base-plugins-alsasink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  63 <p>
  64 GstAlsaSink implements
  65  <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-base-plugins-alsasink.properties"></a><h2>Properties</h2>
  69 <pre class="synopsis">
  70   "<a class="link" href="gst-plugins-base-plugins-alsasink.html#GstAlsaSink--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-base-plugins-alsasink.html#GstAlsaSink--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-base-plugins-alsasink.html#GstAlsaSink--card-name" title='The "card-name" property'>card-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-base-plugins-alsasink.description"></a><h2>Description</h2>
  77 <p>
  78 This element renders raw audio samples using the ALSA api.
  79 </p>
  80 <p>
  81 </p>
  82 <div class="refsect2">
  83 <a name="idp6507408"></a><h3>Example pipelines</h3>
  84 <div class="informalexample">
  85   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  86     <tbody>
  87       <tr>
  88         <td class="listing_lines" align="right"><pre>1</pre></td>
  89         <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> alsasink</pre></td>
  90       </tr>
  91     </tbody>
  92   </table>
  93 </div>
  94  Play an Ogg/Vorbis file.
  95 </div>
  96 <p>
  97 </p>
  98 <p>
  99 Last reviewed on 2006-03-01 (0.10.4)
 100 </p>
 101 <div class="refsynopsisdiv">
 102 <h2>Synopsis</h2>
 103 <div class="refsect2">
 104 <a name="idp7524000"></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-base-plugins-plugin-alsa.html#plugin-alsa">alsa</a>
 112           </td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">author</span></p></td>
 116 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">class</span></p></td>
 120 <td>Sink/Audio</td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="idp7531456"></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>sink</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">direction</span></p></td>
 137 <td>sink</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-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean){ true, false }, width=(int)32, depth=(int)32, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term"></span></p></td>
 149 <td> audio/x-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean){ true, false }, width=(int)24, depth=(int)24, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"></span></p></td>
 153 <td> audio/x-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean){ true, false }, width=(int)32, depth=(int)24, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"></span></p></td>
 157 <td> audio/x-raw-int, endianness=(int){ 1234, 4321 }, signed=(boolean){ true, false }, width=(int)16, depth=(int)16, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"></span></p></td>
 161 <td> audio/x-raw-int, signed=(boolean){ true, false }, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"></span></p></td>
 165 <td> audio/x-iec958</td>
 166 </tr>
 167 </tbody>
 168 </table></div>
 169 </div>
 170 </div>
 171 <p>
 172 </p>
 173 </div>
 174 <div class="refsect1">
 175 <a name="gst-plugins-base-plugins-alsasink.details"></a><h2>Details</h2>
 176 <div class="refsect2">
 177 <a name="GstAlsaSink-struct"></a><h3>struct GstAlsaSink</h3>
 178 <pre class="programlisting">struct GstAlsaSink;</pre>
 179 <p>
 180 Opaque data structure
 181 </p>
 182 </div>
 183 </div>
 184 <div class="refsect1">
 185 <a name="gst-plugins-base-plugins-alsasink.property-details"></a><h2>Property Details</h2>
 186 <div class="refsect2">
 187 <a name="GstAlsaSink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 188 <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>
 189 <p>ALSA device, as defined in an asound configuration file.</p>
 190 <p>Default value: "default"</p>
 191 </div>
 192 <hr>
 193 <div class="refsect2">
 194 <a name="GstAlsaSink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 195 <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>
 196 <p>Human-readable name of the sound device.</p>
 197 <p>Default value: ""</p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="GstAlsaSink--card-name"></a><h3>The <code class="literal">"card-name"</code> property</h3>
 202 <pre class="programlisting">  "card-name"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 203 <p>Human-readable name of the sound card.</p>
 204 <p>Default value: ""</p>
 205 </div>
 206 </div>
 207 <div class="refsect1">
 208 <a name="gst-plugins-base-plugins-alsasink.see-also"></a><h2>See Also</h2>
 209 alsasrc, alsamixer
 210 </div>
 211 </div>
 212 <div class="footer">
 213 <hr>
 214           Generated by GTK-Doc V1.17</div>
 215 </body>
 216 </html>