upload tizen1.0 source
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-esdsink.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>esdsink</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-equalizer-nbands.html" title="equalizer-nbands">
10 <link rel="next" href="gst-plugins-good-plugins-flacdec.html" title="flacdec">
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-equalizer-nbands.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-flacdec.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-esdsink.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-esdsink.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-esdsink.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-esdsink.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-esdsink"></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-esdsink.top_of_page"></a>esdsink</span></h2>
38 <p>esdsink — Plays audio to an esound server</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-esdsink.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstEsdSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-esdsink.html#GstEsdSink-struct" title="struct GstEsdSink">GstEsdSink</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-esdsink.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                                  +----GstEsdSink
57 </pre>
58 </div>
59 <div class="refsect1">
60 <a name="gst-plugins-good-plugins-esdsink.properties"></a><h2>Properties</h2>
61 <pre class="synopsis">
62   "<a class="link" href="gst-plugins-good-plugins-esdsink.html#GstEsdSink--host" title='The "host" property'>host</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-esdsink.description"></a><h2>Description</h2>
67 <p>
68 This element outputs sound to an already-running Enlightened Sound Daemon
69 (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned
70 through this element (regardless of the system configuration), since this
71 is actively prevented by the element. If you must use esd, you need to
72 make sure it is started automatically with your session or otherwise.
73 </p>
74 <p>
75 TODO: insert some comments about how sucky esd is and that all the cool
76 kids use pulseaudio or whatever these days.
77 </p>
78 <p>
79 </p>
80 <div class="refsect2">
81 <a name="idp10494944"></a><h3>Example launch line</h3>
82 <div class="informalexample">
83   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
84     <tbody>
85       <tr>
86         <td class="listing_lines" align="right"><pre>1</pre></td>
87         <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>foo<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> esdsink</pre></td>
88       </tr>
89     </tbody>
90   </table>
91 </div>
92  play an Ogg/Vorbis audio file via esd
93 </div>
94 <p>
95 </p>
96 <div class="refsynopsisdiv">
97 <h2>Synopsis</h2>
98 <div class="refsect2">
99 <a name="idp6800656"></a><h3>Element Information</h3>
100 <div class="variablelist"><table border="0">
101 <col align="left" valign="top">
102 <tbody>
103 <tr>
104 <td><p><span class="term">plugin</span></p></td>
105 <td>
106             <a class="link" href="gst-plugins-good-plugins-plugin-esdsink.html#plugin-esdsink">esdsink</a>
107           </td>
108 </tr>
109 <tr>
110 <td><p><span class="term">author</span></p></td>
111 <td>Arwed von Merkatz &lt;v.merkatz@gmx.net&gt;</td>
112 </tr>
113 <tr>
114 <td><p><span class="term">class</span></p></td>
115 <td>Sink/Audio</td>
116 </tr>
117 </tbody>
118 </table></div>
119 </div>
120 <hr>
121 <div class="refsect2">
122 <a name="idp13494000"></a><h3>Element Pads</h3>
123 <div class="variablelist"><table border="0">
124 <col align="left" valign="top">
125 <tbody>
126 <tr>
127 <td><p><span class="term">name</span></p></td>
128 <td>sink</td>
129 </tr>
130 <tr>
131 <td><p><span class="term">direction</span></p></td>
132 <td>sink</td>
133 </tr>
134 <tr>
135 <td><p><span class="term">presence</span></p></td>
136 <td>always</td>
137 </tr>
138 <tr>
139 <td><p><span class="term">details</span></p></td>
140 <td>audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int)16, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2 ]</td>
141 </tr>
142 <tr>
143 <td><p><span class="term"></span></p></td>
144 <td> audio/x-raw-int, signed=(boolean){ true, false }, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2 ]</td>
145 </tr>
146 </tbody>
147 </table></div>
148 </div>
149 </div>
150 <p>
151 </p>
152 </div>
153 <div class="refsect1">
154 <a name="gst-plugins-good-plugins-esdsink.details"></a><h2>Details</h2>
155 <div class="refsect2">
156 <a name="GstEsdSink-struct"></a><h3>struct GstEsdSink</h3>
157 <pre class="programlisting">struct GstEsdSink;</pre>
158 <p>
159 </p>
160 </div>
161 </div>
162 <div class="refsect1">
163 <a name="gst-plugins-good-plugins-esdsink.property-details"></a><h2>Property Details</h2>
164 <div class="refsect2">
165 <a name="GstEsdSink--host"></a><h3>The <code class="literal">"host"</code> property</h3>
166 <pre class="programlisting">  "host"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
167 <p>The host running the esound daemon.</p>
168 <p>Default value: NULL</p>
169 </div>
170 </div>
171 <div class="refsect1">
172 <a name="gst-plugins-good-plugins-esdsink.see-also"></a><h2>See Also</h2>
173 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-alsasink.html#GstAlsaSink"><span class="type">GstAlsaSink</span></a>, <a class="link" href="gst-plugins-good-plugins-autoaudiosink.html#GstAutoAudioSink"><span class="type">GstAutoAudioSink</span></a>
174 </div>
175 </div>
176 <div class="footer">
177 <hr>
178           Generated by GTK-Doc V1.17</div>
179 </body>
180 </html>