• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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: GStreamer Base Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
9<link rel="prev" href="gst-plugins-base-plugins-alsamidisrc.html" title="alsamidisrc">
10<link rel="next" href="gst-plugins-base-plugins-appsink.html" title="appsink">
11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#gst-plugins-base-plugins-alsasink.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-base-plugins-alsasink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-base-plugins-alsasink.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-base-plugins-alsamidisrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-base-plugins-appsink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-base-plugins-alsasink"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-alsasink.top_of_page"></a>alsasink</span></h2>
32<p>alsasink</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-base-plugins-alsasink.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type">
47<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
48<td class="property_name"><a class="link" href="gst-plugins-base-plugins-alsasink.html#GstAlsaSink--card-name" title="The “card-name” property">card-name</a></td>
49<td class="property_flags">Read</td>
50</tr>
51<tr>
52<td class="property_type">
53<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
54<td class="property_name"><a class="link" href="gst-plugins-base-plugins-alsasink.html#GstAlsaSink--device" title="The “device” property">device</a></td>
55<td class="property_flags">Read / Write</td>
56</tr>
57<tr>
58<td class="property_type">
59<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
60<td class="property_name"><a class="link" href="gst-plugins-base-plugins-alsasink.html#GstAlsaSink--device-name" title="The “device-name” property">device-name</a></td>
61<td class="property_flags">Read</td>
62</tr>
63</tbody>
64</table></div>
65</div>
66<a name="GstAlsaSink"></a><div class="refsect1">
67<a name="gst-plugins-base-plugins-alsasink.other"></a><h2>Types and Values</h2>
68<div class="informaltable"><table class="informaltable" width="100%" border="0">
69<colgroup>
70<col width="150px" class="name">
71<col class="description">
72</colgroup>
73<tbody><tr>
74<td class="datatype_keyword">struct</td>
75<td class="function_name"><a class="link" href="gst-plugins-base-plugins-alsasink.html#GstAlsaSink-struct" title="struct GstAlsaSink">GstAlsaSink</a></td>
76</tr></tbody>
77</table></div>
78</div>
79<div class="refsect1">
80<a name="gst-plugins-base-plugins-alsasink.object-hierarchy"></a><h2>Object Hierarchy</h2>
81<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
82    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
83        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
84            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
85                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a>
86                    <span class="lineart">╰──</span> <a href="../html/GstAudioBaseSink.html#GstAudioBaseSink-struct">GstAudioBaseSink</a>
87                        <span class="lineart">╰──</span> <a href="../html/GstAudioSink.html#GstAudioSink-struct">GstAudioSink</a>
88                            <span class="lineart">╰──</span> GstAlsaSink
89</pre>
90</div>
91<div class="refsect1">
92<a name="gst-plugins-base-plugins-alsasink.description"></a><h2>Description</h2>
93<p>This element renders audio samples using the ALSA audio API.</p>
94<div class="refsect3">
95<a name="id-1.2.4.7.3"></a><h4>Example pipelines</h4>
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><span class="number">1.0</span> <span class="gtkdoc opt">-</span>v uridecodebin uri<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">:</span><span class="gtkdoc slc">///path/to/audio.ogg ! audioconvert ! audioresample ! autoaudiosink</span></pre></td>
102      </tr>
103    </tbody>
104  </table>
105</div>
106
107<p></p>
108<p>Play an Ogg/Vorbis file and output audio via ALSA.</p>
109</div>
110<div class="refsynopsisdiv">
111<h2>Synopsis</h2>
112<div class="refsect2">
113<a name="id-1.2.4.7.4.1"></a><h3>Element Information</h3>
114<div class="variablelist"><table border="0" class="variablelist">
115<colgroup>
116<col align="left" valign="top">
117<col>
118</colgroup>
119<tbody>
120<tr>
121<td><p><span class="term">plugin</span></p></td>
122<td>
123            <a class="link" href="gst-plugins-base-plugins-plugin-alsa.html#plugin-alsa">alsa</a>
124          </td>
125</tr>
126<tr>
127<td><p><span class="term">author</span></p></td>
128<td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
129</tr>
130<tr>
131<td><p><span class="term">class</span></p></td>
132<td>Sink/Audio</td>
133</tr>
134</tbody>
135</table></div>
136</div>
137<hr>
138<div class="refsect2">
139<a name="id-1.2.4.7.4.2"></a><h3>Element Pads</h3>
140<div class="variablelist"><table border="0" class="variablelist">
141<colgroup>
142<col align="left" valign="top">
143<col>
144</colgroup>
145<tbody>
146<tr>
147<td><p><span class="term">name</span></p></td>
148<td>sink</td>
149</tr>
150<tr>
151<td><p><span class="term">direction</span></p></td>
152<td>sink</td>
153</tr>
154<tr>
155<td><p><span class="term">presence</span></p></td>
156<td>always</td>
157</tr>
158<tr>
159<td><p><span class="term">details</span></p></td>
160<td>audio/x-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE }, layout=(string)interleaved, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
161</tr>
162<tr>
163<td><p><span class="term"></span></p></td>
164<td> audio/x-ac3, framed=(boolean)true</td>
165</tr>
166<tr>
167<td><p><span class="term"></span></p></td>
168<td> audio/x-eac3, framed=(boolean)true</td>
169</tr>
170<tr>
171<td><p><span class="term"></span></p></td>
172<td> audio/x-dts, framed=(boolean)true, block-size=(int){ 512, 1024, 2048 }</td>
173</tr>
174<tr>
175<td><p><span class="term"></span></p></td>
176<td> audio/mpeg, mpegversion=(int)1, mpegaudioversion=(int)[ 1, 3 ], parsed=(boolean)true</td>
177</tr>
178</tbody>
179</table></div>
180</div>
181</div>
182</div>
183<div class="refsect1">
184<a name="gst-plugins-base-plugins-alsasink.functions_details"></a><h2>Functions</h2>
185<p></p>
186</div>
187<div class="refsect1">
188<a name="gst-plugins-base-plugins-alsasink.other_details"></a><h2>Types and Values</h2>
189<div class="refsect2">
190<a name="GstAlsaSink-struct"></a><h3>struct GstAlsaSink</h3>
191<pre class="programlisting">struct GstAlsaSink;</pre>
192<p>Opaque data structure</p>
193</div>
194</div>
195<div class="refsect1">
196<a name="gst-plugins-base-plugins-alsasink.property-details"></a><h2>Property Details</h2>
197<div class="refsect2">
198<a name="GstAlsaSink--card-name"></a><h3>The <code class="literal">“card-name”</code> property</h3>
199<pre class="programlisting">  “card-name”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
200<p>Human-readable name of the sound card.</p>
201<p>Flags: Read</p>
202<p>Default value: ""</p>
203</div>
204<hr>
205<div class="refsect2">
206<a name="GstAlsaSink--device"></a><h3>The <code class="literal">“device”</code> property</h3>
207<pre class="programlisting">  “device”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
208<p>ALSA device, as defined in an asound configuration file.</p>
209<p>Flags: Read / Write</p>
210<p>Default value: "default"</p>
211</div>
212<hr>
213<div class="refsect2">
214<a name="GstAlsaSink--device-name"></a><h3>The <code class="literal">“device-name”</code> property</h3>
215<pre class="programlisting">  “device-name”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
216<p>Human-readable name of the sound device.</p>
217<p>Flags: Read</p>
218<p>Default value: ""</p>
219</div>
220</div>
221<div class="refsect1">
222<a name="gst-plugins-base-plugins-alsasink.see-also"></a><h2>See Also</h2>
223<p>alsasrc</p>
224</div>
225</div>
226<div class="footer">
227<hr>Generated by GTK-Doc V1.28</div>
228</body>
229</html>