Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-autoaudiosink.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>autoaudiosink</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
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-auparse.html" title="auparse">
10 <link rel="next" href="gst-plugins-good-plugins-autoaudiosrc.html" title="autoaudiosrc">
11 <meta name="generator" content="GTK-Doc V1.18 (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-auparse.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-autoaudiosrc.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-autoaudiosink.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-autoaudiosink.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-autoaudiosink.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-autoaudiosink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-good-plugins-autoaudiosink.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="gst-plugins-good-plugins-autoaudiosink"></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-autoaudiosink.top_of_page"></a>autoaudiosink</span></h2>
40 <p>autoaudiosink — Wrapper audio sink for automatically detected audio sink</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-autoaudiosink.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstAutoAudioSink"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-good-plugins-autoaudiosink.html#GstAutoAudioSink-struct" title="GstAutoAudioSink">GstAutoAudioSink</a>;
47 </pre>
48 </div>
49 <div class="refsect1">
50 <a name="gst-plugins-good-plugins-autoaudiosink.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                      +----GstAutoAudioSink
57 </pre>
58 </div>
59 <div class="refsect1">
60 <a name="gst-plugins-good-plugins-autoaudiosink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
61 <p>
62 GstAutoAudioSink 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-autoaudiosink.properties"></a><h2>Properties</h2>
67 <pre class="synopsis">
68   "<a class="link" href="gst-plugins-good-plugins-autoaudiosink.html#GstAutoAudioSink--filter-caps" title='The "filter-caps" property'>filter-caps</a>"              <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write
69 </pre>
70 </div>
71 <div class="refsect1">
72 <a name="gst-plugins-good-plugins-autoaudiosink.description"></a><h2>Description</h2>
73 <p>
74 autoaudiosink is an audio sink that automatically detects an appropriate
75 audio sink to use.  It does so by scanning the registry for all elements
76 that have <span class="quote">“<span class="quote">Sink</span>”</span> and <span class="quote">“<span class="quote">Audio</span>”</span> in the class field
77 of their element information, and also have a non-zero autoplugging rank.
78 </p>
79 <p>
80 </p>
81 <div class="refsect2">
82 <a name="idp8711952"></a><h3>Example launch line</h3>
83 <div class="informalexample">
84   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
85     <tbody>
86       <tr>
87         <td class="listing_lines" align="right"><pre>1</pre></td>
88         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v <span class="gtkdoc opt">-</span>m audiotestsrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> autoaudiosink</pre></td>
89       </tr>
90     </tbody>
91   </table>
92 </div>
93
94 </div>
95 <p>
96 </p>
97 <div class="refsynopsisdiv">
98 <h2>Synopsis</h2>
99 <div class="refsect2">
100 <a name="idp10412752"></a><h3>Element Information</h3>
101 <div class="variablelist"><table border="0">
102 <col align="left" valign="top">
103 <tbody>
104 <tr>
105 <td><p><span class="term">plugin</span></p></td>
106 <td>
107             <a class="link" href="gst-plugins-good-plugins-plugin-autodetect.html#plugin-autodetect">autodetect</a>
108           </td>
109 </tr>
110 <tr>
111 <td><p><span class="term">author</span></p></td>
112 <td>Jan Schmidt &lt;thaytan@noraisin.net&gt;</td>
113 </tr>
114 <tr>
115 <td><p><span class="term">class</span></p></td>
116 <td>Sink/Audio</td>
117 </tr>
118 </tbody>
119 </table></div>
120 </div>
121 <hr>
122 <div class="refsect2">
123 <a name="idp6817808"></a><h3>Element Pads</h3>
124 <div class="variablelist"><table border="0">
125 <col align="left" valign="top">
126 <tbody>
127 <tr>
128 <td><p><span class="term">name</span></p></td>
129 <td>sink</td>
130 </tr>
131 <tr>
132 <td><p><span class="term">direction</span></p></td>
133 <td>sink</td>
134 </tr>
135 <tr>
136 <td><p><span class="term">presence</span></p></td>
137 <td>always</td>
138 </tr>
139 <tr>
140 <td><p><span class="term">details</span></p></td>
141 <td>ANY</td>
142 </tr>
143 </tbody>
144 </table></div>
145 </div>
146 </div>
147 <p>
148 </p>
149 </div>
150 <div class="refsect1">
151 <a name="gst-plugins-good-plugins-autoaudiosink.details"></a><h2>Details</h2>
152 <div class="refsect2">
153 <a name="GstAutoAudioSink-struct"></a><h3>GstAutoAudioSink</h3>
154 <pre class="programlisting">typedef struct _GstAutoAudioSink GstAutoAudioSink;</pre>
155 <p>
156 </p>
157 </div>
158 </div>
159 <div class="refsect1">
160 <a name="gst-plugins-good-plugins-autoaudiosink.property-details"></a><h2>Property Details</h2>
161 <div class="refsect2">
162 <a name="GstAutoAudioSink--filter-caps"></a><h3>The <code class="literal">"filter-caps"</code> property</h3>
163 <pre class="programlisting">  "filter-caps"              <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write</pre>
164 <p>
165 This property will filter out candidate sinks that can handle the specified
166 caps. By default only audio sinks that support raw floating point and
167 integer audio are selected.
168 </p>
169 <p>
170 This property can only be set before the element goes to the READY state.
171 </p>
172 <p class="since">Since 0.10.7</p>
173 </div>
174 </div>
175 <div class="refsect1">
176 <a name="gst-plugins-good-plugins-autoaudiosink.see-also"></a><h2>See Also</h2>
177 autovideosink, alsasink, osssink
178 </div>
179 </div>
180 <div class="footer">
181 <hr>
182           Generated by GTK-Doc V1.18</div>
183 </body>
184 </html>