docs/plugins/html/gst-plugins-good-plugins-halaudiosink.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>halaudiosink</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-gstrtpssrcdemux.html" title="gstrtpssrcdemux">
  10 <link rel="next" href="gst-plugins-good-plugins-halaudiosrc.html" title="halaudiosrc">
  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-gstrtpssrcdemux.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-halaudiosrc.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-halaudiosink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-halaudiosink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-halaudiosink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-halaudiosink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-halaudiosink.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-halaudiosink"></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-halaudiosink.top_of_page"></a>halaudiosink</span></h2>
  40 <p>halaudiosink — Audio sink for sound device access via HAL</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-halaudiosink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstHalAudioSink"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-good-plugins-halaudiosink.html#GstHalAudioSink-struct" title="GstHalAudioSink">GstHalAudioSink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-halaudiosink.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/html/GstBin.html">GstBin</a>
  56                      +----GstHalAudioSink
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-good-plugins-halaudiosink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  61 <p>
  62 GstHalAudioSink implements
  63  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstChildProxy.html">GstChildProxy</a>.</p>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-good-plugins-halaudiosink.properties"></a><h2>Properties</h2>
  67 <pre class="synopsis">
  68   "<a class="link" href="gst-plugins-good-plugins-halaudiosink.html#GstHalAudioSink--udi" title='The "udi" property'>udi</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  69 </pre>
  70 </div>
  71 <div class="refsect1">
  72 <a name="gst-plugins-good-plugins-halaudiosink.description"></a><h2>Description</h2>
  73 <p>
  74 HalAudioSink allows access to output of sound devices by specifying the
  75 corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction
  76 Layer (HAL) in the <a class="link" href="gst-plugins-good-plugins-halaudiosink.html#GstHalAudioSink--udi" title='The "udi" property'><span class="type">"udi"</span></a> property.
  77 It currently always embeds alsasink or osssink as HAL doesn't support other
  78 sound systems yet. You can also specify the UDI of a device that has ALSA or
  79 OSS subdevices. If both are present ALSA is preferred.
  80 </p>
  81 <p>
  82 </p>
  83 <div class="refsect2">
  84 <a name="idp12437504"></a><h3>Examples</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">hal<span class="gtkdoc opt">-</span>find<span class="gtkdoc opt">-</span>by<span class="gtkdoc opt">-</span>property <span class="gtkdoc opt">--</span>key alsa<span class="gtkdoc opt">.</span>type <span class="gtkdoc opt">--</span>string playback</pre></td>
  91       </tr>
  92     </tbody>
  93   </table>
  94 </div>
  95  list the UDIs of all your ALSA output devices
  96 <div class="informalexample">
  97   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  98     <tbody>
  99       <tr>
 100         <td class="listing_lines" align="right"><pre>1</pre></td>
 101         <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> halaudiosink udi<span class="gtkdoc opt">=/</span>org<span class="gtkdoc opt">/</span>freedesktop<span class="gtkdoc opt">/</span>Hal<span class="gtkdoc opt">/</span>devices<span class="gtkdoc opt">/</span>pci_8086_27d8_alsa_playback_0</pre></td>
 102       </tr>
 103     </tbody>
 104   </table>
 105 </div>
 106  test your soundcard by playing a test signal on the specified sound device.
 107 </div>
 108 <p>
 109 </p>
 110 <div class="refsynopsisdiv">
 111 <h2>Synopsis</h2>
 112 <div class="refsect2">
 113 <a name="idp16682848"></a><h3>Element Information</h3>
 114 <div class="variablelist"><table border="0">
 115 <col align="left" valign="top">
 116 <tbody>
 117 <tr>
 118 <td><p><span class="term">plugin</span></p></td>
 119 <td>
 120             <a class="link" href="gst-plugins-good-plugins-plugin-halelements.html#plugin-halelements">halelements</a>
 121           </td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">author</span></p></td>
 125 <td>Jürg Billeter &lt;j@bitron.ch&gt;</td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term">class</span></p></td>
 129 <td>Sink/Audio</td>
 130 </tr>
 131 </tbody>
 132 </table></div>
 133 </div>
 134 <hr>
 135 <div class="refsect2">
 136 <a name="idp13276128"></a><h3>Element Pads</h3>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term">name</span></p></td>
 142 <td>sink</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">direction</span></p></td>
 146 <td>sink</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term">presence</span></p></td>
 150 <td>always</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term">details</span></p></td>
 154 <td>ANY</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-halaudiosink.details"></a><h2>Details</h2>
 165 <div class="refsect2">
 166 <a name="GstHalAudioSink-struct"></a><h3>GstHalAudioSink</h3>
 167 <pre class="programlisting">typedef struct _GstHalAudioSink GstHalAudioSink;</pre>
 168 <p>
 169 </p>
 170 </div>
 171 </div>
 172 <div class="refsect1">
 173 <a name="gst-plugins-good-plugins-halaudiosink.property-details"></a><h2>Property Details</h2>
 174 <div class="refsect2">
 175 <a name="GstHalAudioSink--udi"></a><h3>The <code class="literal">"udi"</code> property</h3>
 176 <pre class="programlisting">  "udi"                      <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>Unique Device Id.</p>
 178 <p>Default value: NULL</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>