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>vorbisenc: 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-vorbisdec.html" title="vorbisdec"> 10<link rel="next" href="gst-plugins-base-plugins-vorbisparse.html" title="vorbisparse"> 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-vorbisenc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-vorbisenc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-vorbisenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-base-plugins-vorbisenc.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-vorbisdec.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-vorbisparse.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-vorbisenc"></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-vorbisenc.top_of_page"></a>vorbisenc</span></h2> 33<p>vorbisenc</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-vorbisenc.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#gint"><span class="type">gint</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--bitrate" title="The “bitrate” property">bitrate</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-base-plugins-vorbisenc.html#GstVorbisEnc--last-message" title="The “last-message” property">last-message</a></td> 55<td class="property_flags">Read</td> 56</tr> 57<tr> 58<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 59<td class="property_name"><a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--managed" title="The “managed” property">managed</a></td> 60<td class="property_flags">Read / Write</td> 61</tr> 62<tr> 63<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 64<td class="property_name"><a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--max-bitrate" title="The “max-bitrate” property">max-bitrate</a></td> 65<td class="property_flags">Read / Write</td> 66</tr> 67<tr> 68<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 69<td class="property_name"><a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--min-bitrate" title="The “min-bitrate” property">min-bitrate</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#gfloat"><span class="type">gfloat</span></a></td> 74<td class="property_name"><a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--quality" title="The “quality” property">quality</a></td> 75<td class="property_flags">Read / Write</td> 76</tr> 77</tbody> 78</table></div> 79</div> 80<a name="GstVorbisEnc"></a><div class="refsect1"> 81<a name="gst-plugins-base-plugins-vorbisenc.other"></a><h2>Types and Values</h2> 82<div class="informaltable"><table class="informaltable" width="100%" border="0"> 83<colgroup> 84<col width="150px" class="name"> 85<col class="description"> 86</colgroup> 87<tbody><tr> 88<td class="datatype_keyword">struct</td> 89<td class="function_name"><a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc-struct" title="struct GstVorbisEnc">GstVorbisEnc</a></td> 90</tr></tbody> 91</table></div> 92</div> 93<div class="refsect1"> 94<a name="gst-plugins-base-plugins-vorbisenc.object-hierarchy"></a><h2>Object Hierarchy</h2> 95<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 96 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 97 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 98 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 99 <span class="lineart">╰──</span> <a href="../html/GstAudioEncoder.html#GstAudioEncoder-struct">GstAudioEncoder</a> 100 <span class="lineart">╰──</span> GstVorbisEnc 101</pre> 102</div> 103<div class="refsect1"> 104<a name="gst-plugins-base-plugins-vorbisenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 105<p> 106GstVorbisEnc implements 107 <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> 108</div> 109<div class="refsect1"> 110<a name="gst-plugins-base-plugins-vorbisenc.description"></a><h2>Description</h2> 111<p>This element encodes raw float audio into a Vorbis stream.</p> 112<a class="ulink" href="http://www.vorbis.com/" target="_top">Vorbis</a> is a royalty-free 113<p>audio codec maintained by the <a class="ulink" href="http://www.xiph.org/" target="_top">Xiph.org 114Foundation</a>.</p> 115<div class="refsect3"> 116<a name="id-1.2.113.8.5"></a><h4>Example pipelines</h4> 117<div class="informalexample"> 118 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 119 <tbody> 120 <tr> 121 <td class="listing_lines" align="right"><pre>1</pre></td> 122 <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> vorbisenc <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> 123 </tr> 124 </tbody> 125 </table> 126</div> 127 128<p> 129 Encode a test sine signal to Ogg/Vorbis. Note that the resulting file 130will be really small because a sine signal compresses very well.</p> 131<div class="informalexample"> 132 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 133 <tbody> 134 <tr> 135 <td class="listing_lines" align="right"><pre>1</pre></td> 136 <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 autoaudiosrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> vorbisenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>alsasrc<span class="gtkdoc opt">.</span>ogg</pre></td> 137 </tr> 138 </tbody> 139 </table> 140</div> 141 142<p> 143 Record from a sound card and encode to Ogg/Vorbis.</p> 144</div> 145<div class="refsynopsisdiv"> 146<h2>Synopsis</h2> 147<div class="refsect2"> 148<a name="id-1.2.113.8.6.1"></a><h3>Element Information</h3> 149<div class="variablelist"><table border="0" class="variablelist"> 150<colgroup> 151<col align="left" valign="top"> 152<col> 153</colgroup> 154<tbody> 155<tr> 156<td><p><span class="term">plugin</span></p></td> 157<td> 158 <a class="link" href="gst-plugins-base-plugins-plugin-vorbis.html#plugin-vorbis">vorbis</a> 159 </td> 160</tr> 161<tr> 162<td><p><span class="term">author</span></p></td> 163<td>Monty <monty@xiph.org>, Wim Taymans <wim@fluendo.com></td> 164</tr> 165<tr> 166<td><p><span class="term">class</span></p></td> 167<td>Codec/Encoder/Audio</td> 168</tr> 169</tbody> 170</table></div> 171</div> 172<hr> 173<div class="refsect2"> 174<a name="id-1.2.113.8.6.2"></a><h3>Element Pads</h3> 175<div class="variablelist"><table border="0" class="variablelist"> 176<colgroup> 177<col align="left" valign="top"> 178<col> 179</colgroup> 180<tbody> 181<tr> 182<td><p><span class="term">name</span></p></td> 183<td>sink</td> 184</tr> 185<tr> 186<td><p><span class="term">direction</span></p></td> 187<td>sink</td> 188</tr> 189<tr> 190<td><p><span class="term">presence</span></p></td> 191<td>always</td> 192</tr> 193<tr> 194<td><p><span class="term">details</span></p></td> 195<td>audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)1</td> 196</tr> 197<tr> 198<td><p><span class="term"></span></p></td> 199<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)2, channel-mask=(bitmask)0x0000000000000003</td> 200</tr> 201<tr> 202<td><p><span class="term"></span></p></td> 203<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)3, channel-mask=(bitmask)0x0000000000000007</td> 204</tr> 205<tr> 206<td><p><span class="term"></span></p></td> 207<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)4, channel-mask=(bitmask)0x0000000000000033</td> 208</tr> 209<tr> 210<td><p><span class="term"></span></p></td> 211<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)5, channel-mask=(bitmask)0x0000000000000037</td> 212</tr> 213<tr> 214<td><p><span class="term"></span></p></td> 215<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)6, channel-mask=(bitmask)0x000000000000003f</td> 216</tr> 217<tr> 218<td><p><span class="term"></span></p></td> 219<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)7, channel-mask=(bitmask)0x0000000000000d0f</td> 220</tr> 221<tr> 222<td><p><span class="term"></span></p></td> 223<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)8, channel-mask=(bitmask)0x0000000000000c3f</td> 224</tr> 225<tr> 226<td><p><span class="term"></span></p></td> 227<td> audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 200000 ], channels=(int)[ 9, 255 ], channel-mask=(bitmask)0x0000000000000000</td> 228</tr> 229</tbody> 230</table></div> 231<div class="variablelist"><table border="0" class="variablelist"> 232<colgroup> 233<col align="left" valign="top"> 234<col> 235</colgroup> 236<tbody> 237<tr> 238<td><p><span class="term">name</span></p></td> 239<td>src</td> 240</tr> 241<tr> 242<td><p><span class="term">direction</span></p></td> 243<td>source</td> 244</tr> 245<tr> 246<td><p><span class="term">presence</span></p></td> 247<td>always</td> 248</tr> 249<tr> 250<td><p><span class="term">details</span></p></td> 251<td>audio/x-vorbis, rate=(int)[ 1, 200000 ], channels=(int)[ 1, 255 ]</td> 252</tr> 253</tbody> 254</table></div> 255</div> 256</div> 257</div> 258<div class="refsect1"> 259<a name="gst-plugins-base-plugins-vorbisenc.functions_details"></a><h2>Functions</h2> 260<p></p> 261</div> 262<div class="refsect1"> 263<a name="gst-plugins-base-plugins-vorbisenc.other_details"></a><h2>Types and Values</h2> 264<div class="refsect2"> 265<a name="GstVorbisEnc-struct"></a><h3>struct GstVorbisEnc</h3> 266<pre class="programlisting">struct GstVorbisEnc;</pre> 267<p>Opaque data structure.</p> 268</div> 269</div> 270<div class="refsect1"> 271<a name="gst-plugins-base-plugins-vorbisenc.property-details"></a><h2>Property Details</h2> 272<div class="refsect2"> 273<a name="GstVorbisEnc--bitrate"></a><h3>The <code class="literal">“bitrate”</code> property</h3> 274<pre class="programlisting"> “bitrate” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 275<p>Attempt to encode at a bitrate averaging this (in bps). This uses the bitrate management engine, and is not recommended for most users. Quality is a better alternative. (-1 == disabled).</p> 276<p>Flags: Read / Write</p> 277<p>Allowed values: [G_MAXULONG,250001]</p> 278<p>Default value: -1</p> 279</div> 280<hr> 281<div class="refsect2"> 282<a name="GstVorbisEnc--last-message"></a><h3>The <code class="literal">“last-message”</code> property</h3> 283<pre class="programlisting"> “last-message” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 284<p>The last status message.</p> 285<p>Flags: Read</p> 286<p>Default value: NULL</p> 287</div> 288<hr> 289<div class="refsect2"> 290<a name="GstVorbisEnc--managed"></a><h3>The <code class="literal">“managed”</code> property</h3> 291<pre class="programlisting"> “managed” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 292<p>Enable bitrate management engine.</p> 293<p>Flags: Read / Write</p> 294<p>Default value: FALSE</p> 295</div> 296<hr> 297<div class="refsect2"> 298<a name="GstVorbisEnc--max-bitrate"></a><h3>The <code class="literal">“max-bitrate”</code> property</h3> 299<pre class="programlisting"> “max-bitrate” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 300<p>Specify a maximum bitrate (in bps). Useful for streaming applications. (-1 == disabled).</p> 301<p>Flags: Read / Write</p> 302<p>Allowed values: [G_MAXULONG,250001]</p> 303<p>Default value: -1</p> 304</div> 305<hr> 306<div class="refsect2"> 307<a name="GstVorbisEnc--min-bitrate"></a><h3>The <code class="literal">“min-bitrate”</code> property</h3> 308<pre class="programlisting"> “min-bitrate” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 309<p>Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled).</p> 310<p>Flags: Read / Write</p> 311<p>Allowed values: [G_MAXULONG,250001]</p> 312<p>Default value: -1</p> 313</div> 314<hr> 315<div class="refsect2"> 316<a name="GstVorbisEnc--quality"></a><h3>The <code class="literal">“quality”</code> property</h3> 317<pre class="programlisting"> “quality” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 318<p>Specify quality instead of specifying a particular bitrate.</p> 319<p>Flags: Read / Write</p> 320<p>Allowed values: [-0.1,1]</p> 321<p>Default value: 0.3</p> 322</div> 323</div> 324<div class="refsect1"> 325<a name="gst-plugins-base-plugins-vorbisenc.see-also"></a><h2>See Also</h2> 326<p>vorbisdec, oggmux</p> 327</div> 328</div> 329<div class="footer"> 330<hr>Generated by GTK-Doc V1.28</div> 331</body> 332</html>
