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>openalsink: 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-ofa.html" title="ofa"> 10<link rel="next" href="gst-plugins-bad-plugins-openalsrc.html" title="openalsrc"> 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-openalsink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-openalsink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-openalsink.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-ofa.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-openalsrc.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-openalsink"></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-openalsink.top_of_page"></a>openalsink</span></h2> 32<p>openalsink — 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-openalsink.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"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--context-handle" title="The “context-handle” property">context-handle</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"> 52<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--device" title="The “device” property">device</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--device-handle" title="The “device-handle” property">device-handle</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"> 63<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 64<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--device-name" title="The “device-name” property">device-name</a></td> 65<td class="property_flags">Read</td> 66</tr> 67<tr> 68<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 69<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--source-id" title="The “source-id” property">source-id</a></td> 70<td class="property_flags">Read / Write</td> 71</tr> 72<tr> 73<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> 74<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--user-context" title="The “user-context” property">user-context</a></td> 75<td class="property_flags">Read / Write</td> 76</tr> 77<tr> 78<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> 79<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--user-device" title="The “user-device” property">user-device</a></td> 80<td class="property_flags">Read / Write</td> 81</tr> 82<tr> 83<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 84<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink--user-source" title="The “user-source” property">user-source</a></td> 85<td class="property_flags">Read / Write</td> 86</tr> 87</tbody> 88</table></div> 89</div> 90<a name="GstOpenALSink"></a><div class="refsect1"> 91<a name="gst-plugins-bad-plugins-openalsink.other"></a><h2>Types and Values</h2> 92<div class="informaltable"><table class="informaltable" width="100%" border="0"> 93<colgroup> 94<col width="150px" class="name"> 95<col class="description"> 96</colgroup> 97<tbody><tr> 98<td class="datatype_keyword">struct</td> 99<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-openalsink.html#GstOpenALSink-struct" title="struct GstOpenALSink">GstOpenALSink</a></td> 100</tr></tbody> 101</table></div> 102</div> 103<div class="refsect1"> 104<a name="gst-plugins-bad-plugins-openalsink.object-hierarchy"></a><h2>Object Hierarchy</h2> 105<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 106 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 107 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 108 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 109 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 110 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioBaseSink.html#GstAudioBaseSink-struct">GstAudioBaseSink</a> 111 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioSink.html#GstAudioSink-struct">GstAudioSink</a> 112 <span class="lineart">╰──</span> GstOpenALSink 113</pre> 114</div> 115<div class="refsect1"> 116<a name="gst-plugins-bad-plugins-openalsink.description"></a><h2>Description</h2> 117<p>This element plays raw audio samples through OpenAL.</p> 118<p>Unfortunately the capture API doesn't have a format enumeration/check. all you can do is try opening it and see if it works.</p> 119<div class="refsect3"> 120<a name="id-1.2.156.7.4"></a><h4>Example pipelines</h4> 121<div class="informalexample"> 122 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 123 <tbody> 124 <tr> 125 <td class="listing_lines" align="right"><pre>1</pre></td> 126 <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> audiotestsrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> volume volume<span class="gtkdoc opt">=</span><span class="number">0.5</span> <span class="gtkdoc opt">!</span> openalsink</pre></td> 127 </tr> 128 </tbody> 129 </table> 130</div> 131 132<p> will play a sine wave (continuous beep sound) through OpenAL.</p> 133<div class="informalexample"> 134 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 135 <tbody> 136 <tr> 137 <td class="listing_lines" align="right"><pre>1</pre></td> 138 <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> filesrc location<span class="gtkdoc opt">=</span>stream<span class="gtkdoc opt">.</span>wav <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> openalsink</pre></td> 139 </tr> 140 </tbody> 141 </table> 142</div> 143 144<p> will play a wav audio file through OpenAL.</p> 145<div class="informalexample"> 146 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 147 <tbody> 148 <tr> 149 <td class="listing_lines" align="right"><pre>1</pre></td> 150 <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> 151 </tr> 152 </tbody> 153 </table> 154</div> 155 156<p> will capture and play audio through OpenAL.</p> 157</div> 158<div class="refsynopsisdiv"> 159<h2>Synopsis</h2> 160<div class="refsect2"> 161<a name="id-1.2.156.7.5.1"></a><h3>Element Information</h3> 162<div class="variablelist"><table border="0" class="variablelist"> 163<colgroup> 164<col align="left" valign="top"> 165<col> 166</colgroup> 167<tbody> 168<tr> 169<td><p><span class="term">plugin</span></p></td> 170<td> 171 <a class="link" href="gst-plugins-bad-plugins-plugin-openal.html#plugin-openal">openal</a> 172 </td> 173</tr> 174<tr> 175<td><p><span class="term">author</span></p></td> 176<td>Juan Manuel Borges Caño <juanmabcmail@gmail.com></td> 177</tr> 178<tr> 179<td><p><span class="term">class</span></p></td> 180<td>Sink/Audio</td> 181</tr> 182</tbody> 183</table></div> 184</div> 185<hr> 186<div class="refsect2"> 187<a name="id-1.2.156.7.5.2"></a><h3>Element Pads</h3> 188<div class="variablelist"><table border="0" class="variablelist"> 189<colgroup> 190<col align="left" valign="top"> 191<col> 192</colgroup> 193<tbody> 194<tr> 195<td><p><span class="term">name</span></p></td> 196<td>sink</td> 197</tr> 198<tr> 199<td><p><span class="term">direction</span></p></td> 200<td>sink</td> 201</tr> 202<tr> 203<td><p><span class="term">presence</span></p></td> 204<td>always</td> 205</tr> 206<tr> 207<td><p><span class="term">details</span></p></td> 208<td>audio/x-raw, format=(string)F64LE, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2 ]</td> 209</tr> 210<tr> 211<td><p><span class="term"></span></p></td> 212<td> audio/x-raw, format=(string)F32LE, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td> 213</tr> 214<tr> 215<td><p><span class="term"></span></p></td> 216<td> audio/x-raw, format=(string)S16LE, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td> 217</tr> 218<tr> 219<td><p><span class="term"></span></p></td> 220<td> audio/x-raw, format=(string)U8, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td> 221</tr> 222</tbody> 223</table></div> 224</div> 225</div> 226</div> 227<div class="refsect1"> 228<a name="gst-plugins-bad-plugins-openalsink.functions_details"></a><h2>Functions</h2> 229<p></p> 230</div> 231<div class="refsect1"> 232<a name="gst-plugins-bad-plugins-openalsink.other_details"></a><h2>Types and Values</h2> 233<div class="refsect2"> 234<a name="GstOpenALSink-struct"></a><h3>struct GstOpenALSink</h3> 235<pre class="programlisting">struct GstOpenALSink;</pre> 236</div> 237</div> 238<div class="refsect1"> 239<a name="gst-plugins-bad-plugins-openalsink.property-details"></a><h2>Property Details</h2> 240<div class="refsect2"> 241<a name="GstOpenALSink--context-handle"></a><h3>The <code class="literal">“context-handle”</code> property</h3> 242<pre class="programlisting"> “context-handle” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> 243<p>Custom playback context.</p> 244<p>Flags: Read / Write</p> 245</div> 246<hr> 247<div class="refsect2"> 248<a name="GstOpenALSink--device"></a><h3>The <code class="literal">“device”</code> property</h3> 249<pre class="programlisting"> “device” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 250<p>Human-readable name of the device.</p> 251<p>Flags: Read / Write</p> 252<p>Default value: NULL</p> 253</div> 254<hr> 255<div class="refsect2"> 256<a name="GstOpenALSink--device-handle"></a><h3>The <code class="literal">“device-handle”</code> property</h3> 257<pre class="programlisting"> “device-handle” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> 258<p>Custom playback device.</p> 259<p>Flags: Read / Write</p> 260</div> 261<hr> 262<div class="refsect2"> 263<a name="GstOpenALSink--device-name"></a><h3>The <code class="literal">“device-name”</code> property</h3> 264<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> 265<p>Human-readable name of the opened device.</p> 266<p>Flags: Read</p> 267<p>Default value: ""</p> 268</div> 269<hr> 270<div class="refsect2"> 271<a name="GstOpenALSink--source-id"></a><h3>The <code class="literal">“source-id”</code> property</h3> 272<pre class="programlisting"> “source-id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 273<p>Custom playback sID.</p> 274<p>Flags: Read / Write</p> 275<p>Default value: 0</p> 276</div> 277<hr> 278<div class="refsect2"> 279<a name="GstOpenALSink--user-context"></a><h3>The <code class="literal">“user-context”</code> property</h3> 280<pre class="programlisting"> “user-context” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> 281<p>User context.</p> 282<p>Flags: Read / Write</p> 283</div> 284<hr> 285<div class="refsect2"> 286<a name="GstOpenALSink--user-device"></a><h3>The <code class="literal">“user-device”</code> property</h3> 287<pre class="programlisting"> “user-device” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> 288<p>User device.</p> 289<p>Flags: Read / Write</p> 290</div> 291<hr> 292<div class="refsect2"> 293<a name="GstOpenALSink--user-source"></a><h3>The <code class="literal">“user-source”</code> property</h3> 294<pre class="programlisting"> “user-source” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 295<p>User source.</p> 296<p>Flags: Read / Write</p> 297<p>Default value: 0</p> 298</div> 299</div> 300<div class="refsect1"> 301<a name="gst-plugins-bad-plugins-openalsink.see-also"></a><h2>See Also</h2> 302<p>openalsrc</p> 303</div> 304</div> 305<div class="footer"> 306<hr>Generated by GTK-Doc V1.28</div> 307</body> 308</html>
