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>opusenc: 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-opusdec.html" title="opusdec"> 10<link rel="next" href="gst-plugins-base-plugins-overlaycomposition.html" title="overlaycomposition"> 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-opusenc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-opusenc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-opusenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-base-plugins-opusenc.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-base-plugins-opusdec.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-base-plugins-overlaycomposition.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-base-plugins-opusenc"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-opusenc.top_of_page"></a>opusenc</span></h2> 33<p>opusenc</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-base-plugins-opusenc.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--audio" title="The “audio” property">audio</a></td> 49<td class="property_flags">Read / Write</td> 50</tr> 51<tr> 52<td class="property_type"><span class="type">GstOpusEncAudioType</span></td> 53<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--audio-type" title="The “audio-type” property">audio-type</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"><span class="type">GstOpusEncBandwidth</span></td> 58<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--bandwidth" title="The “bandwidth” property">bandwidth</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 63<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--bitrate" title="The “bitrate” property">bitrate</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66<tr> 67<td class="property_type"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEncBitrateType" title="enum GstOpusEncBitrateType"><span class="type">GstOpusEncBitrateType</span></a></td> 68<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--bitrate-type" title="The “bitrate-type” property">bitrate-type</a></td> 69<td class="property_flags">Read / Write</td> 70</tr> 71<tr> 72<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 73<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--cbr" title="The “cbr” property">cbr</a></td> 74<td class="property_flags">Read / Write</td> 75</tr> 76<tr> 77<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 78<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--complexity" title="The “complexity” property">complexity</a></td> 79<td class="property_flags">Read / Write</td> 80</tr> 81<tr> 82<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 83<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--constrained-vbr" title="The “constrained-vbr” property">constrained-vbr</a></td> 84<td class="property_flags">Read / Write</td> 85</tr> 86<tr> 87<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 88<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--dtx" title="The “dtx” property">dtx</a></td> 89<td class="property_flags">Read / Write</td> 90</tr> 91<tr> 92<td class="property_type"><span class="type">GstOpusEncFrameSize</span></td> 93<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--frame-size" title="The “frame-size” property">frame-size</a></td> 94<td class="property_flags">Read / Write</td> 95</tr> 96<tr> 97<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 98<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--inband-fec" title="The “inband-fec” property">inband-fec</a></td> 99<td class="property_flags">Read / Write</td> 100</tr> 101<tr> 102<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 103<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--max-payload-size" title="The “max-payload-size” property">max-payload-size</a></td> 104<td class="property_flags">Read / Write</td> 105</tr> 106<tr> 107<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 108<td class="property_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc--packet-loss-percentage" title="The “packet-loss-percentage” property">packet-loss-percentage</a></td> 109<td class="property_flags">Read / Write</td> 110</tr> 111</tbody> 112</table></div> 113</div> 114<a name="GstOpusEnc"></a><div class="refsect1"> 115<a name="gst-plugins-base-plugins-opusenc.other"></a><h2>Types and Values</h2> 116<div class="informaltable"><table class="informaltable" width="100%" border="0"> 117<colgroup> 118<col width="150px" class="name"> 119<col class="description"> 120</colgroup> 121<tbody> 122<tr> 123<td class="datatype_keyword">struct</td> 124<td class="function_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEnc-struct" title="struct GstOpusEnc">GstOpusEnc</a></td> 125</tr> 126<tr> 127<td class="datatype_keyword">enum</td> 128<td class="function_name"><a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEncBitrateType" title="enum GstOpusEncBitrateType">GstOpusEncBitrateType</a></td> 129</tr> 130</tbody> 131</table></div> 132</div> 133<div class="refsect1"> 134<a name="gst-plugins-base-plugins-opusenc.object-hierarchy"></a><h2>Object Hierarchy</h2> 135<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 136 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 137 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 138 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 139 <span class="lineart">╰──</span> <a href="../html/GstAudioEncoder.html#GstAudioEncoder-struct">GstAudioEncoder</a> 140 <span class="lineart">╰──</span> GstOpusEnc 141</pre> 142</div> 143<div class="refsect1"> 144<a name="gst-plugins-base-plugins-opusenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 145<p> 146GstOpusEnc implements 147 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPreset.html#GstPreset-struct">GstPreset</a> and <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstTagSetter.html#GstTagSetter-struct">GstTagSetter</a>.</p> 148</div> 149<div class="refsect1"> 150<a name="gst-plugins-base-plugins-opusenc.description"></a><h2>Description</h2> 151<p>This element encodes raw audio to OPUS.</p> 152<div class="refsect3"> 153<a name="id-1.2.80.8.3"></a><h4>Example pipelines</h4> 154<div class="informalexample"> 155 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 156 <tbody> 157 <tr> 158 <td class="listing_lines" align="right"><pre>1</pre></td> 159 <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 audiotestsrc wave<span class="gtkdoc opt">=</span>sine num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> opusenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>sine<span class="gtkdoc opt">.</span>ogg</pre></td> 160 </tr> 161 </tbody> 162 </table> 163</div> 164 165<p> 166Encode a test sine signal to Ogg/OPUS.</p> 167</div> 168<div class="refsynopsisdiv"> 169<h2>Synopsis</h2> 170<div class="refsect2"> 171<a name="id-1.2.80.8.4.1"></a><h3>Element Information</h3> 172<div class="variablelist"><table border="0" class="variablelist"> 173<colgroup> 174<col align="left" valign="top"> 175<col> 176</colgroup> 177<tbody> 178<tr> 179<td><p><span class="term">plugin</span></p></td> 180<td> 181 <a class="link" href="gst-plugins-base-plugins-plugin-opus.html#plugin-opus">opus</a> 182 </td> 183</tr> 184<tr> 185<td><p><span class="term">author</span></p></td> 186<td>Vincent Penquerc'h <vincent.penquerch@collabora.co.uk></td> 187</tr> 188<tr> 189<td><p><span class="term">class</span></p></td> 190<td>Codec/Encoder/Audio</td> 191</tr> 192</tbody> 193</table></div> 194</div> 195<hr> 196<div class="refsect2"> 197<a name="id-1.2.80.8.4.2"></a><h3>Element Pads</h3> 198<div class="variablelist"><table border="0" class="variablelist"> 199<colgroup> 200<col align="left" valign="top"> 201<col> 202</colgroup> 203<tbody> 204<tr> 205<td><p><span class="term">name</span></p></td> 206<td>sink</td> 207</tr> 208<tr> 209<td><p><span class="term">direction</span></p></td> 210<td>sink</td> 211</tr> 212<tr> 213<td><p><span class="term">presence</span></p></td> 214<td>always</td> 215</tr> 216<tr> 217<td><p><span class="term">details</span></p></td> 218<td>audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int)48000, channels=(int)[ 1, 8 ]</td> 219</tr> 220<tr> 221<td><p><span class="term"></span></p></td> 222<td> audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 12000, 16000, 24000 }, channels=(int)[ 1, 8 ]</td> 223</tr> 224</tbody> 225</table></div> 226<div class="variablelist"><table border="0" class="variablelist"> 227<colgroup> 228<col align="left" valign="top"> 229<col> 230</colgroup> 231<tbody> 232<tr> 233<td><p><span class="term">name</span></p></td> 234<td>src</td> 235</tr> 236<tr> 237<td><p><span class="term">direction</span></p></td> 238<td>source</td> 239</tr> 240<tr> 241<td><p><span class="term">presence</span></p></td> 242<td>always</td> 243</tr> 244<tr> 245<td><p><span class="term">details</span></p></td> 246<td>audio/x-opus</td> 247</tr> 248</tbody> 249</table></div> 250</div> 251</div> 252</div> 253<div class="refsect1"> 254<a name="gst-plugins-base-plugins-opusenc.functions_details"></a><h2>Functions</h2> 255<p></p> 256</div> 257<div class="refsect1"> 258<a name="gst-plugins-base-plugins-opusenc.other_details"></a><h2>Types and Values</h2> 259<div class="refsect2"> 260<a name="GstOpusEnc-struct"></a><h3>struct GstOpusEnc</h3> 261<pre class="programlisting">struct GstOpusEnc;</pre> 262</div> 263<hr> 264<div class="refsect2"> 265<a name="GstOpusEncBitrateType"></a><h3>enum GstOpusEncBitrateType</h3> 266<div class="refsect3"> 267<a name="GstOpusEncBitrateType.members"></a><h4>Members</h4> 268<div class="informaltable"><table class="informaltable" width="100%" border="0"> 269<colgroup> 270<col width="300px" class="enum_members_name"> 271<col class="enum_members_description"> 272<col width="200px" class="enum_members_annotations"> 273</colgroup> 274<tbody> 275<tr> 276<td class="enum_member_name"><p><a name="BITRATE-TYPE-CBR:CAPS"></a>BITRATE_TYPE_CBR</p></td> 277<td> </td> 278<td> </td> 279</tr> 280<tr> 281<td class="enum_member_name"><p><a name="BITRATE-TYPE-VBR:CAPS"></a>BITRATE_TYPE_VBR</p></td> 282<td> </td> 283<td> </td> 284</tr> 285<tr> 286<td class="enum_member_name"><p><a name="BITRATE-TYPE-CONSTRAINED-VBR:CAPS"></a>BITRATE_TYPE_CONSTRAINED_VBR</p></td> 287<td> </td> 288<td> </td> 289</tr> 290</tbody> 291</table></div> 292</div> 293</div> 294</div> 295<div class="refsect1"> 296<a name="gst-plugins-base-plugins-opusenc.property-details"></a><h2>Property Details</h2> 297<div class="refsect2"> 298<a name="GstOpusEnc--audio"></a><h3>The <code class="literal">“audio”</code> property</h3> 299<pre class="programlisting"> “audio” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 300<p>Audio or voice (DEPRECATED: use audio-type).</p> 301<p>Flags: Read / Write</p> 302<p>Default value: TRUE</p> 303</div> 304<hr> 305<div class="refsect2"> 306<a name="GstOpusEnc--audio-type"></a><h3>The <code class="literal">“audio-type”</code> property</h3> 307<pre class="programlisting"> “audio-type” <span class="type">GstOpusEncAudioType</span></pre> 308<p>What type of audio to optimize for.</p> 309<p>Flags: Read / Write</p> 310<p>Default value: Generic audio</p> 311</div> 312<hr> 313<div class="refsect2"> 314<a name="GstOpusEnc--bandwidth"></a><h3>The <code class="literal">“bandwidth”</code> property</h3> 315<pre class="programlisting"> “bandwidth” <span class="type">GstOpusEncBandwidth</span></pre> 316<p>Audio Band Width.</p> 317<p>Flags: Read / Write</p> 318<p>Default value: Full band</p> 319</div> 320<hr> 321<div class="refsect2"> 322<a name="GstOpusEnc--bitrate"></a><h3>The <code class="literal">“bitrate”</code> property</h3> 323<pre class="programlisting"> “bitrate” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 324<p>Specify an encoding bit-rate (in bps).</p> 325<p>Flags: Read / Write</p> 326<p>Allowed values: [4000,650000]</p> 327<p>Default value: 64000</p> 328</div> 329<hr> 330<div class="refsect2"> 331<a name="GstOpusEnc--bitrate-type"></a><h3>The <code class="literal">“bitrate-type”</code> property</h3> 332<pre class="programlisting"> “bitrate-type” <a class="link" href="gst-plugins-base-plugins-opusenc.html#GstOpusEncBitrateType" title="enum GstOpusEncBitrateType"><span class="type">GstOpusEncBitrateType</span></a></pre> 333<p>Bitrate type.</p> 334<p>Flags: Read / Write</p> 335<p>Default value: CBR</p> 336</div> 337<hr> 338<div class="refsect2"> 339<a name="GstOpusEnc--cbr"></a><h3>The <code class="literal">“cbr”</code> property</h3> 340<pre class="programlisting"> “cbr” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 341<p>Constant bit rate (DEPRECATED: use bitrate-type).</p> 342<p>Flags: Read / Write</p> 343<p>Default value: TRUE</p> 344</div> 345<hr> 346<div class="refsect2"> 347<a name="GstOpusEnc--complexity"></a><h3>The <code class="literal">“complexity”</code> property</h3> 348<pre class="programlisting"> “complexity” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 349<p>Complexity.</p> 350<p>Flags: Read / Write</p> 351<p>Allowed values: [0,10]</p> 352<p>Default value: 10</p> 353</div> 354<hr> 355<div class="refsect2"> 356<a name="GstOpusEnc--constrained-vbr"></a><h3>The <code class="literal">“constrained-vbr”</code> property</h3> 357<pre class="programlisting"> “constrained-vbr” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 358<p>Constrained VBR (DEPRECATED: use bitrate-type).</p> 359<p>Flags: Read / Write</p> 360<p>Default value: TRUE</p> 361</div> 362<hr> 363<div class="refsect2"> 364<a name="GstOpusEnc--dtx"></a><h3>The <code class="literal">“dtx”</code> property</h3> 365<pre class="programlisting"> “dtx” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 366<p>DTX.</p> 367<p>Flags: Read / Write</p> 368<p>Default value: FALSE</p> 369</div> 370<hr> 371<div class="refsect2"> 372<a name="GstOpusEnc--frame-size"></a><h3>The <code class="literal">“frame-size”</code> property</h3> 373<pre class="programlisting"> “frame-size” <span class="type">GstOpusEncFrameSize</span></pre> 374<p>The duration of an audio frame, in ms.</p> 375<p>Flags: Read / Write</p> 376<p>Default value: 20</p> 377</div> 378<hr> 379<div class="refsect2"> 380<a name="GstOpusEnc--inband-fec"></a><h3>The <code class="literal">“inband-fec”</code> property</h3> 381<pre class="programlisting"> “inband-fec” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 382<p>Enable forward error correction.</p> 383<p>Flags: Read / Write</p> 384<p>Default value: FALSE</p> 385</div> 386<hr> 387<div class="refsect2"> 388<a name="GstOpusEnc--max-payload-size"></a><h3>The <code class="literal">“max-payload-size”</code> property</h3> 389<pre class="programlisting"> “max-payload-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 390<p>Maximum payload size in bytes.</p> 391<p>Flags: Read / Write</p> 392<p>Allowed values: [2,4000]</p> 393<p>Default value: 4000</p> 394</div> 395<hr> 396<div class="refsect2"> 397<a name="GstOpusEnc--packet-loss-percentage"></a><h3>The <code class="literal">“packet-loss-percentage”</code> property</h3> 398<pre class="programlisting"> “packet-loss-percentage” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 399<p>Packet loss percentage.</p> 400<p>Flags: Read / Write</p> 401<p>Allowed values: [0,100]</p> 402<p>Default value: 0</p> 403</div> 404</div> 405<div class="refsect1"> 406<a name="gst-plugins-base-plugins-opusenc.see-also"></a><h2>See Also</h2> 407<p>opusdec, oggmux</p> 408</div> 409</div> 410<div class="footer"> 411<hr>Generated by GTK-Doc V1.28</div> 412</body> 413</html>
