tizen 2.3 release
[framework/multimedia/gst-plugins-base0.10.git] / 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.76.1">
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.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-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 <div class="refsynopsisdiv">
78 <h2>Synopsis</h2>
79 <div class="refsect2">
80 <a name="idp6692992"></a><h3>Element Information</h3>
81 <div class="variablelist"><table border="0">
82 <col align="left" valign="top">
83 <tbody>
84 <tr>
85 <td><p><span class="term">plugin</span></p></td>
86 <td>
87             <a class="link" href="gst-plugins-base-plugins-plugin-alsa.html#plugin-alsa">alsa</a>
88           </td>
89 </tr>
90 <tr>
91 <td><p><span class="term">author</span></p></td>
92 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
93 </tr>
94 <tr>
95 <td><p><span class="term">class</span></p></td>
96 <td>Sink/Audio</td>
97 </tr>
98 </tbody>
99 </table></div>
100 </div>
101 <hr>
102 <div class="refsect2">
103 <a name="idp9721504"></a><h3>Element Pads</h3>
104 <div class="variablelist"><table border="0">
105 <col align="left" valign="top">
106 <tbody>
107 <tr>
108 <td><p><span class="term">name</span></p></td>
109 <td>sink</td>
110 </tr>
111 <tr>
112 <td><p><span class="term">direction</span></p></td>
113 <td>sink</td>
114 </tr>
115 <tr>
116 <td><p><span class="term">presence</span></p></td>
117 <td>always</td>
118 </tr>
119 <tr>
120 <td><p><span class="term">details</span></p></td>
121 <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>
122 </tr>
123 <tr>
124 <td><p><span class="term"></span></p></td>
125 <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>
126 </tr>
127 <tr>
128 <td><p><span class="term"></span></p></td>
129 <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>
130 </tr>
131 <tr>
132 <td><p><span class="term"></span></p></td>
133 <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>
134 </tr>
135 <tr>
136 <td><p><span class="term"></span></p></td>
137 <td> audio/x-raw-int, signed=(boolean){ true, false }, width=(int)8, depth=(int)8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
138 </tr>
139 <tr>
140 <td><p><span class="term"></span></p></td>
141 <td> audio/x-iec958</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-base-plugins-alsasink.details"></a><h2>Details</h2>
152 <div class="refsect2">
153 <a name="GstAlsaSink-struct"></a><h3>struct GstAlsaSink</h3>
154 <pre class="programlisting">struct GstAlsaSink;</pre>
155 <p>
156 </p>
157 </div>
158 </div>
159 <div class="refsect1">
160 <a name="gst-plugins-base-plugins-alsasink.property-details"></a><h2>Property Details</h2>
161 <div class="refsect2">
162 <a name="GstAlsaSink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
163 <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>
164 <p>ALSA device, as defined in an asound configuration file.</p>
165 <p>Default value: "default"</p>
166 </div>
167 <hr>
168 <div class="refsect2">
169 <a name="GstAlsaSink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
170 <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>
171 <p>Human-readable name of the sound device.</p>
172 <p>Default value: ""</p>
173 </div>
174 <hr>
175 <div class="refsect2">
176 <a name="GstAlsaSink--card-name"></a><h3>The <code class="literal">"card-name"</code> property</h3>
177 <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>
178 <p>Human-readable name of the sound card.</p>
179 <p>Default value: ""</p>
180 </div>
181 </div>
182 </div>
183 <div class="footer">
184 <hr>
185           Generated by GTK-Doc V1.18</div>
186 </body>
187 </html>