Git init
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-halaudiosrc.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>halaudiosrc</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-halaudiosink.html" title="halaudiosink">
10 <link rel="next" href="gst-plugins-good-plugins-hdv1394src.html" title="hdv1394src">
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-halaudiosink.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-hdv1394src.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-halaudiosrc.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-halaudiosrc.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-halaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-halaudiosrc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-good-plugins-halaudiosrc.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="gst-plugins-good-plugins-halaudiosrc"></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-halaudiosrc.top_of_page"></a>halaudiosrc</span></h2>
40 <p>halaudiosrc — Audio source for sound device access via HAL</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-halaudiosrc.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstHalAudioSrc"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-good-plugins-halaudiosrc.html#GstHalAudioSrc-struct" title="GstHalAudioSrc">GstHalAudioSrc</a>;
47 </pre>
48 </div>
49 <div class="refsect1">
50 <a name="gst-plugins-good-plugins-halaudiosrc.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                      +----GstHalAudioSrc
57 </pre>
58 </div>
59 <div class="refsect1">
60 <a name="gst-plugins-good-plugins-halaudiosrc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
61 <p>
62 GstHalAudioSrc 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-halaudiosrc.properties"></a><h2>Properties</h2>
67 <pre class="synopsis">
68   "<a class="link" href="gst-plugins-good-plugins-halaudiosrc.html#GstHalAudioSrc--udi" title='The "udi" property'>udi</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
69 </pre>
70 </div>
71 <div class="refsect1">
72 <a name="gst-plugins-good-plugins-halaudiosrc.description"></a><h2>Description</h2>
73 <p>
74 HalAudioSrc allows access to input of sound devices by specifying the
75 corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction
76 Layer (HAL) in the <a class="link" href="gst-plugins-good-plugins-halaudiosrc.html#GstHalAudioSrc--udi" title='The "udi" property'><span class="type">"udi"</span></a> property.
77 It currently always embeds alsasrc or osssrc as HAL doesn't support other
78 sound systems yet. You can also specify the UDI of a device that has ALSA or
79 OSS subdevices. If both are present ALSA is preferred.
80 </p>
81 <p>
82 </p>
83 <div class="refsect2">
84 <a name="idp14007328"></a><h3>Examples</h3>
85 <div class="informalexample">
86   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
87     <tbody>
88       <tr>
89         <td class="listing_lines" align="right"><pre>1</pre></td>
90         <td class="listing_code"><pre class="programlisting">hal<span class="gtkdoc opt">-</span>find<span class="gtkdoc opt">-</span>by<span class="gtkdoc opt">-</span>property <span class="gtkdoc opt">--</span>key alsa<span class="gtkdoc opt">.</span>type <span class="gtkdoc opt">--</span>string capture</pre></td>
91       </tr>
92     </tbody>
93   </table>
94 </div>
95  list the UDIs of all your ALSA input devices
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>v halaudiosrc udi<span class="gtkdoc opt">=/</span>org<span class="gtkdoc opt">/</span>freedesktop<span class="gtkdoc opt">/</span>Hal<span class="gtkdoc opt">/</span>devices<span class="gtkdoc opt">/</span>pci_8086_27d8_alsa_capture_0 <span class="gtkdoc opt">!</span> autoaudiosink</pre></td>
102       </tr>
103     </tbody>
104   </table>
105 </div>
106  You should now hear yourself with a small delay if you have a microphone
107 connected to the specified sound device.
108 </div>
109 <p>
110 </p>
111 <div class="refsynopsisdiv">
112 <h2>Synopsis</h2>
113 <div class="refsect2">
114 <a name="idp15346416"></a><h3>Element Information</h3>
115 <div class="variablelist"><table border="0">
116 <col align="left" valign="top">
117 <tbody>
118 <tr>
119 <td><p><span class="term">plugin</span></p></td>
120 <td>
121             <a class="link" href="gst-plugins-good-plugins-plugin-halelements.html#plugin-halelements">halelements</a>
122           </td>
123 </tr>
124 <tr>
125 <td><p><span class="term">author</span></p></td>
126 <td>Jürg Billeter &lt;j@bitron.ch&gt;</td>
127 </tr>
128 <tr>
129 <td><p><span class="term">class</span></p></td>
130 <td>Source/Audio</td>
131 </tr>
132 </tbody>
133 </table></div>
134 </div>
135 <hr>
136 <div class="refsect2">
137 <a name="idm4528"></a><h3>Element Pads</h3>
138 <div class="variablelist"><table border="0">
139 <col align="left" valign="top">
140 <tbody>
141 <tr>
142 <td><p><span class="term">name</span></p></td>
143 <td>src</td>
144 </tr>
145 <tr>
146 <td><p><span class="term">direction</span></p></td>
147 <td>source</td>
148 </tr>
149 <tr>
150 <td><p><span class="term">presence</span></p></td>
151 <td>always</td>
152 </tr>
153 <tr>
154 <td><p><span class="term">details</span></p></td>
155 <td>ANY</td>
156 </tr>
157 </tbody>
158 </table></div>
159 </div>
160 </div>
161 <p>
162 </p>
163 </div>
164 <div class="refsect1">
165 <a name="gst-plugins-good-plugins-halaudiosrc.details"></a><h2>Details</h2>
166 <div class="refsect2">
167 <a name="GstHalAudioSrc-struct"></a><h3>GstHalAudioSrc</h3>
168 <pre class="programlisting">typedef struct _GstHalAudioSrc GstHalAudioSrc;</pre>
169 <p>
170 </p>
171 </div>
172 </div>
173 <div class="refsect1">
174 <a name="gst-plugins-good-plugins-halaudiosrc.property-details"></a><h2>Property Details</h2>
175 <div class="refsect2">
176 <a name="GstHalAudioSrc--udi"></a><h3>The <code class="literal">"udi"</code> property</h3>
177 <pre class="programlisting">  "udi"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
178 <p>Unique Device Id.</p>
179 <p>Default value: NULL</p>
180 </div>
181 </div>
182 </div>
183 <div class="footer">
184 <hr>
185           Generated by GTK-Doc V1.17</div>
186 </body>
187 </html>