• 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>alsasrc: 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-appsink.html" title="appsink">
10<link rel="next" href="gst-plugins-base-plugins-appsrc.html" title="appsrc">
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-alsasrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-base-plugins-alsasrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-base-plugins-alsasrc.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-appsink.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-appsrc.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-alsasrc"></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-alsasrc.top_of_page"></a>alsasrc</span></h2>
32<p>alsasrc</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-alsasrc.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-alsasrc.html#GstAlsaSrc--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-alsasrc.html#GstAlsaSrc--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-alsasrc.html#GstAlsaSrc--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="GstAlsaSrc"></a><div class="refsect1">
67<a name="gst-plugins-base-plugins-alsasrc.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-alsasrc.html#GstAlsaSrc-struct" title="struct GstAlsaSrc">GstAlsaSrc</a></td>
76</tr></tbody>
77</table></div>
78</div>
79<div class="refsect1">
80<a name="gst-plugins-base-plugins-alsasrc.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/GstBaseSrc.html#GstBaseSrc-struct">GstBaseSrc</a>
86                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstPushSrc.html#GstPushSrc-struct">GstPushSrc</a>
87                        <span class="lineart">╰──</span> <a href="../html/GstAudioBaseSrc.html#GstAudioBaseSrc-struct">GstAudioBaseSrc</a>
88                            <span class="lineart">╰──</span> <a href="../html/GstAudioSrc.html#GstAudioSrc-struct">GstAudioSrc</a>
89                                <span class="lineart">╰──</span> GstAlsaSrc
90</pre>
91</div>
92<div class="refsect1">
93<a name="gst-plugins-base-plugins-alsasrc.description"></a><h2>Description</h2>
94<p>This element reads data from an audio card using the ALSA API.</p>
95<div class="refsect3">
96<a name="id-1.2.6.7.3"></a><h4>Example pipelines</h4>
97<div class="informalexample">
98  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
99    <tbody>
100      <tr>
101        <td class="listing_lines" align="right"><pre>1</pre></td>
102        <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 alsasrc <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> vorbisenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>alsasrc<span class="gtkdoc opt">.</span>ogg</pre></td>
103      </tr>
104    </tbody>
105  </table>
106</div>
107
108<p>
109 Record from a sound card using ALSA and encode to Ogg/Vorbis.</p>
110</div>
111<div class="refsynopsisdiv">
112<h2>Synopsis</h2>
113<div class="refsect2">
114<a name="id-1.2.6.7.4.1"></a><h3>Element Information</h3>
115<div class="variablelist"><table border="0" class="variablelist">
116<colgroup>
117<col align="left" valign="top">
118<col>
119</colgroup>
120<tbody>
121<tr>
122<td><p><span class="term">plugin</span></p></td>
123<td>
124            <a class="link" href="gst-plugins-base-plugins-plugin-alsa.html#plugin-alsa">alsa</a>
125          </td>
126</tr>
127<tr>
128<td><p><span class="term">author</span></p></td>
129<td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
130</tr>
131<tr>
132<td><p><span class="term">class</span></p></td>
133<td>Source/Audio</td>
134</tr>
135</tbody>
136</table></div>
137</div>
138<hr>
139<div class="refsect2">
140<a name="id-1.2.6.7.4.2"></a><h3>Element Pads</h3>
141<div class="variablelist"><table border="0" class="variablelist">
142<colgroup>
143<col align="left" valign="top">
144<col>
145</colgroup>
146<tbody>
147<tr>
148<td><p><span class="term">name</span></p></td>
149<td>src</td>
150</tr>
151<tr>
152<td><p><span class="term">direction</span></p></td>
153<td>source</td>
154</tr>
155<tr>
156<td><p><span class="term">presence</span></p></td>
157<td>always</td>
158</tr>
159<tr>
160<td><p><span class="term">details</span></p></td>
161<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>
162</tr>
163</tbody>
164</table></div>
165</div>
166</div>
167</div>
168<div class="refsect1">
169<a name="gst-plugins-base-plugins-alsasrc.functions_details"></a><h2>Functions</h2>
170<p></p>
171</div>
172<div class="refsect1">
173<a name="gst-plugins-base-plugins-alsasrc.other_details"></a><h2>Types and Values</h2>
174<div class="refsect2">
175<a name="GstAlsaSrc-struct"></a><h3>struct GstAlsaSrc</h3>
176<pre class="programlisting">struct GstAlsaSrc;</pre>
177<p>Opaque data structure</p>
178</div>
179</div>
180<div class="refsect1">
181<a name="gst-plugins-base-plugins-alsasrc.property-details"></a><h2>Property Details</h2>
182<div class="refsect2">
183<a name="GstAlsaSrc--card-name"></a><h3>The <code class="literal">“card-name”</code> property</h3>
184<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>
185<p>Human-readable name of the sound card.</p>
186<p>Flags: Read</p>
187<p>Default value: ""</p>
188</div>
189<hr>
190<div class="refsect2">
191<a name="GstAlsaSrc--device"></a><h3>The <code class="literal">“device”</code> property</h3>
192<pre class="programlisting">  “device”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
193<p>ALSA device, as defined in an asound configuration file.</p>
194<p>Flags: Read / Write</p>
195<p>Default value: "default"</p>
196</div>
197<hr>
198<div class="refsect2">
199<a name="GstAlsaSrc--device-name"></a><h3>The <code class="literal">“device-name”</code> property</h3>
200<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>
201<p>Human-readable name of the sound device.</p>
202<p>Flags: Read</p>
203<p>Default value: ""</p>
204</div>
205</div>
206<div class="refsect1">
207<a name="gst-plugins-base-plugins-alsasrc.see-also"></a><h2>See Also</h2>
208<p>alsasink</p>
209</div>
210</div>
211<div class="footer">
212<hr>Generated by GTK-Doc V1.28</div>
213</body>
214</html>