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>opusdec: 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-ogmvideoparse.html" title="ogmvideoparse"> 10<link rel="next" href="gst-plugins-base-plugins-opusenc.html" title="opusenc"> 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-base-plugins-opusdec.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-opusdec.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-opusdec.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-ogmvideoparse.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-opusenc.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-opusdec"></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-opusdec.top_of_page"></a>opusdec</span></h2> 32<p>opusdec</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-opusdec.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#gboolean"><span class="type">gboolean</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusdec.html#GstOpusDec--apply-gain" title="The “apply-gain” property">apply-gain</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusdec.html#GstOpusDec--use-inband-fec" title="The “use-inband-fec” property">use-inband-fec</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusdec.html#GstOpusDec--phase-inversion" title="The “phase-inversion” property">phase-inversion</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60</tbody> 61</table></div> 62</div> 63<a name="GstOpusDec"></a><div class="refsect1"> 64<a name="gst-plugins-base-plugins-opusdec.other"></a><h2>Types and Values</h2> 65<div class="informaltable"><table class="informaltable" width="100%" border="0"> 66<colgroup> 67<col width="150px" class="name"> 68<col class="description"> 69</colgroup> 70<tbody><tr> 71<td class="datatype_keyword">struct</td> 72<td class="function_name"><a class="link" href="gst-plugins-base-plugins-opusdec.html#GstOpusDec-struct" title="struct GstOpusDec">GstOpusDec</a></td> 73</tr></tbody> 74</table></div> 75</div> 76<div class="refsect1"> 77<a name="gst-plugins-base-plugins-opusdec.object-hierarchy"></a><h2>Object Hierarchy</h2> 78<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 79 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 80 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 82 <span class="lineart">╰──</span> <a href="../html/GstAudioDecoder.html#GstAudioDecoder-struct">GstAudioDecoder</a> 83 <span class="lineart">╰──</span> GstOpusDec 84</pre> 85</div> 86<div class="refsect1"> 87<a name="gst-plugins-base-plugins-opusdec.description"></a><h2>Description</h2> 88<p>This element decodes a OPUS stream to raw integer audio.</p> 89<div class="refsect3"> 90<a name="id-1.2.79.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 filesrc location<span class="gtkdoc opt">=</span>opus<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> opusdec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> alsasink</pre></td> 97 </tr> 98 </tbody> 99 </table> 100</div> 101 102<p> 103Decode an Ogg/Opus file. To create an Ogg/Opus file refer to the documentation of opusenc.</p> 104</div> 105<div class="refsynopsisdiv"> 106<h2>Synopsis</h2> 107<div class="refsect2"> 108<a name="id-1.2.79.7.4.1"></a><h3>Element Information</h3> 109<div class="variablelist"><table border="0" class="variablelist"> 110<colgroup> 111<col align="left" valign="top"> 112<col> 113</colgroup> 114<tbody> 115<tr> 116<td><p><span class="term">plugin</span></p></td> 117<td> 118 <a class="link" href="gst-plugins-base-plugins-plugin-opus.html#plugin-opus">opus</a> 119 </td> 120</tr> 121<tr> 122<td><p><span class="term">author</span></p></td> 123<td>Vincent Penquerc'h <vincent.penquerch@collabora.co.uk></td> 124</tr> 125<tr> 126<td><p><span class="term">class</span></p></td> 127<td>Codec/Decoder/Audio</td> 128</tr> 129</tbody> 130</table></div> 131</div> 132<hr> 133<div class="refsect2"> 134<a name="id-1.2.79.7.4.2"></a><h3>Element Pads</h3> 135<div class="variablelist"><table border="0" class="variablelist"> 136<colgroup> 137<col align="left" valign="top"> 138<col> 139</colgroup> 140<tbody> 141<tr> 142<td><p><span class="term">name</span></p></td> 143<td>sink</td> 144</tr> 145<tr> 146<td><p><span class="term">direction</span></p></td> 147<td>sink</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>audio/x-opus, channel-mapping-family=(int)0</td> 156</tr> 157<tr> 158<td><p><span class="term"></span></p></td> 159<td> audio/x-opus, channel-mapping-family=(int)[ 1, 255 ], channels=(int)[ 1, 255 ], stream-count=(int)[ 1, 255 ], coupled-count=(int)[ 0, 255 ]</td> 160</tr> 161</tbody> 162</table></div> 163<div class="variablelist"><table border="0" class="variablelist"> 164<colgroup> 165<col align="left" valign="top"> 166<col> 167</colgroup> 168<tbody> 169<tr> 170<td><p><span class="term">name</span></p></td> 171<td>src</td> 172</tr> 173<tr> 174<td><p><span class="term">direction</span></p></td> 175<td>source</td> 176</tr> 177<tr> 178<td><p><span class="term">presence</span></p></td> 179<td>always</td> 180</tr> 181<tr> 182<td><p><span class="term">details</span></p></td> 183<td>audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 48000, 24000, 16000, 12000, 8000 }, channels=(int)[ 1, 8 ]</td> 184</tr> 185</tbody> 186</table></div> 187</div> 188</div> 189</div> 190<div class="refsect1"> 191<a name="gst-plugins-base-plugins-opusdec.functions_details"></a><h2>Functions</h2> 192<p></p> 193</div> 194<div class="refsect1"> 195<a name="gst-plugins-base-plugins-opusdec.other_details"></a><h2>Types and Values</h2> 196<div class="refsect2"> 197<a name="GstOpusDec-struct"></a><h3>struct GstOpusDec</h3> 198<pre class="programlisting">struct GstOpusDec;</pre> 199</div> 200</div> 201<div class="refsect1"> 202<a name="gst-plugins-base-plugins-opusdec.property-details"></a><h2>Property Details</h2> 203<div class="refsect2"> 204<a name="GstOpusDec--apply-gain"></a><h3>The <code class="literal">“apply-gain”</code> property</h3> 205<pre class="programlisting"> “apply-gain” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 206<p>Apply gain if any is specified in the header.</p> 207<p>Flags: Read / Write</p> 208<p>Default value: TRUE</p> 209</div> 210<hr> 211<div class="refsect2"> 212<a name="GstOpusDec--use-inband-fec"></a><h3>The <code class="literal">“use-inband-fec”</code> property</h3> 213<pre class="programlisting"> “use-inband-fec” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 214<p>Use forward error correction if available (needs PLC enabled).</p> 215<p>Flags: Read / Write</p> 216<p>Default value: FALSE</p> 217</div> 218<hr> 219<div class="refsect2"> 220<a name="GstOpusDec--phase-inversion"></a><h3>The <code class="literal">“phase-inversion”</code> property</h3> 221<pre class="programlisting"> “phase-inversion” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 222<p>Set to true to enable phase inversion, this will slightly improve stereo quality, but will have side effects when downmixed to mono.</p> 223<p>Flags: Read / Write</p> 224<p>Default value: FALSE</p> 225</div> 226</div> 227<div class="refsect1"> 228<a name="gst-plugins-base-plugins-opusdec.see-also"></a><h2>See Also</h2> 229<p>opusenc, oggdemux</p> 230</div> 231</div> 232<div class="footer"> 233<hr>Generated by GTK-Doc V1.28</div> 234</body> 235</html>
