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>openalsrc: GStreamer Bad 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 Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-openalsink.html" title="openalsink"> 10<link rel="next" href="gst-plugins-bad-plugins-opencvtextoverlay.html" title="opencvtextoverlay"> 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">|</span> 18 <a href="#gst-plugins-bad-plugins-openalsrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-openalsrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-openalsrc.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-bad-plugins-openalsink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-bad-plugins-opencvtextoverlay.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-bad-plugins-openalsrc"></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-bad-plugins-openalsrc.top_of_page"></a>openalsrc</span></h2> 32<p>openalsrc — capture raw audio samples through OpenAL</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-bad-plugins-openalsrc.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-bad-plugins-openalsrc.html#GstOpenalSrc--device" title="The “device” property">device</a></td> 49<td class="property_flags">Read / Write</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-bad-plugins-openalsrc.html#GstOpenalSrc--device-name" title="The “device-name” property">device-name</a></td> 55<td class="property_flags">Read</td> 56</tr> 57</tbody> 58</table></div> 59</div> 60<a name="GstOpenalSrc"></a><div class="refsect1"> 61<a name="gst-plugins-bad-plugins-openalsrc.other"></a><h2>Types and Values</h2> 62<div class="informaltable"><table class="informaltable" width="100%" border="0"> 63<colgroup> 64<col width="150px" class="name"> 65<col class="description"> 66</colgroup> 67<tbody><tr> 68<td class="datatype_keyword">struct</td> 69<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-openalsrc.html#GstOpenalSrc-struct" title="struct GstOpenalSrc">GstOpenalSrc</a></td> 70</tr></tbody> 71</table></div> 72</div> 73<div class="refsect1"> 74<a name="gst-plugins-bad-plugins-openalsrc.object-hierarchy"></a><h2>Object Hierarchy</h2> 75<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 77 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 78 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 79 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSrc.html#GstBaseSrc-struct">GstBaseSrc</a> 80 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstPushSrc.html#GstPushSrc-struct">GstPushSrc</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioBaseSrc.html#GstAudioBaseSrc-struct">GstAudioBaseSrc</a> 82 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioSrc.html#GstAudioSrc-struct">GstAudioSrc</a> 83 <span class="lineart">╰──</span> GstOpenalSrc 84</pre> 85</div> 86<div class="refsect1"> 87<a name="gst-plugins-bad-plugins-openalsrc.description"></a><h2>Description</h2> 88<p>This element captures raw audio samples through OpenAL.</p> 89<div class="refsect3"> 90<a name="id-1.2.157.7.3"></a><h4>Example pipelines</h4> 91<div class="informalexample"> 92 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 93 <tbody> 94 <tr> 95 <td class="listing_lines" align="right"><pre>1</pre></td> 96 <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 openalsrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> wavenc <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>stream<span class="gtkdoc opt">.</span>wav</pre></td> 97 </tr> 98 </tbody> 99 </table> 100</div> 101 102<p> * will capture sound through OpenAL and encode it to a wav file.</p> 103<div class="informalexample"> 104 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 105 <tbody> 106 <tr> 107 <td class="listing_lines" align="right"><pre>1</pre></td> 108 <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> openalsrc <span class="gtkdoc opt">!</span> <span class="string">"audio/x-raw,format=S16LE,rate=44100"</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> volume volume<span class="gtkdoc opt">=</span><span class="number">0.25</span> <span class="gtkdoc opt">!</span> openalsink</pre></td> 109 </tr> 110 </tbody> 111 </table> 112</div> 113 114<p> will capture and play audio through OpenAL.</p> 115</div> 116<div class="refsynopsisdiv"> 117<h2>Synopsis</h2> 118<div class="refsect2"> 119<a name="id-1.2.157.7.4.1"></a><h3>Element Information</h3> 120<div class="variablelist"><table border="0" class="variablelist"> 121<colgroup> 122<col align="left" valign="top"> 123<col> 124</colgroup> 125<tbody> 126<tr> 127<td><p><span class="term">plugin</span></p></td> 128<td> 129 <a class="link" href="gst-plugins-bad-plugins-plugin-openal.html#plugin-openal">openal</a> 130 </td> 131</tr> 132<tr> 133<td><p><span class="term">author</span></p></td> 134<td>Juan Manuel Borges Caño <juanmabcmail@gmail.com></td> 135</tr> 136<tr> 137<td><p><span class="term">class</span></p></td> 138<td>Source/Audio</td> 139</tr> 140</tbody> 141</table></div> 142</div> 143<hr> 144<div class="refsect2"> 145<a name="id-1.2.157.7.4.2"></a><h3>Element Pads</h3> 146<div class="variablelist"><table border="0" class="variablelist"> 147<colgroup> 148<col align="left" valign="top"> 149<col> 150</colgroup> 151<tbody> 152<tr> 153<td><p><span class="term">name</span></p></td> 154<td>src</td> 155</tr> 156<tr> 157<td><p><span class="term">direction</span></p></td> 158<td>source</td> 159</tr> 160<tr> 161<td><p><span class="term">presence</span></p></td> 162<td>always</td> 163</tr> 164<tr> 165<td><p><span class="term">details</span></p></td> 166<td>audio/x-raw, format=(string)S16LE, rate=(int)[ 1, 2147483647 ], channels=(int)1</td> 167</tr> 168<tr> 169<td><p><span class="term"></span></p></td> 170<td> audio/x-raw, format=(string)U8, rate=(int)[ 1, 2147483647 ], channels=(int)1</td> 171</tr> 172</tbody> 173</table></div> 174</div> 175</div> 176</div> 177<div class="refsect1"> 178<a name="gst-plugins-bad-plugins-openalsrc.functions_details"></a><h2>Functions</h2> 179<p></p> 180</div> 181<div class="refsect1"> 182<a name="gst-plugins-bad-plugins-openalsrc.other_details"></a><h2>Types and Values</h2> 183<div class="refsect2"> 184<a name="GstOpenalSrc-struct"></a><h3>struct GstOpenalSrc</h3> 185<pre class="programlisting">struct GstOpenalSrc;</pre> 186</div> 187</div> 188<div class="refsect1"> 189<a name="gst-plugins-bad-plugins-openalsrc.property-details"></a><h2>Property Details</h2> 190<div class="refsect2"> 191<a name="GstOpenalSrc--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>User device, default device if NULL.</p> 194<p>Flags: Read / Write</p> 195<p>Default value: NULL</p> 196</div> 197<hr> 198<div class="refsect2"> 199<a name="GstOpenalSrc--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 device.</p> 202<p>Flags: Read</p> 203<p>Default value: NULL</p> 204</div> 205</div> 206<div class="refsect1"> 207<a name="gst-plugins-bad-plugins-openalsrc.see-also"></a><h2>See Also</h2> 208<p>openalsink</p> 209</div> 210</div> 211<div class="footer"> 212<hr>Generated by GTK-Doc V1.28</div> 213</body> 214</html>
