docs/plugins/html/gst-plugins-base-plugins-vorbisenc.html

   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</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 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.17 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-plugins-vorbisdec.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-vorbisparse.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-plugins-vorbisenc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-vorbisenc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-vorbisenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-vorbisenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-vorbisenc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-vorbisenc"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-vorbisenc.top_of_page"></a>vorbisenc</span></h2>
  40 <p>vorbisenc — Encodes audio in Vorbis format</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-base-plugins-vorbisenc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstVorbisEnc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc-struct" title="struct GstVorbisEnc">GstVorbisEnc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-plugins-vorbisenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----GstVorbisEnc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-base-plugins-vorbisenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  60 <p>
  61 GstVorbisEnc implements
  62  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a> and  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-base-plugins-vorbisenc.properties"></a><h2>Properties</h2>
  66 <pre class="synopsis">
  67   "<a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--bitrate" title='The "bitrate" property'>bitrate</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  68   "<a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--last-message" title='The "last-message" property'>last-message</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  69   "<a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--managed" title='The "managed" property'>managed</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  70   "<a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--max-bitrate" title='The "max-bitrate" property'>max-bitrate</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  71   "<a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--min-bitrate" title='The "min-bitrate" property'>min-bitrate</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  72   "<a class="link" href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--quality" title='The "quality" property'>quality</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="gst-plugins-base-plugins-vorbisenc.description"></a><h2>Description</h2>
  77 <p>
  78 This element encodes raw float audio into a Vorbis stream.
  79 <a class="ulink" href="http://www.vorbis.com/" target="_top">Vorbis</a> is a royalty-free
  80 audio codec maintained by the <a class="ulink" href="http://www.xiph.org/" target="_top">Xiph.org
  81 Foundation</a>.
  82 </p>
  83 <p>
  84 </p>
  85 <div class="refsect2">
  86 <a name="idp15009216"></a><h3>Example pipelines</h3>
  87 <div class="informalexample">
  88   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  89     <tbody>
  90       <tr>
  91         <td class="listing_lines" align="right"><pre>1</pre></td>
  92         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <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>
  93       </tr>
  94     </tbody>
  95   </table>
  96 </div>
  97  Encode a test sine signal to Ogg/Vorbis.  Note that the resulting file
  98 will be really small because a sine signal compresses very well.
  99 <div class="informalexample">
 100   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 101     <tbody>
 102       <tr>
 103         <td class="listing_lines" align="right"><pre>1</pre></td>
 104         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v alsasrc <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>
 105       </tr>
 106     </tbody>
 107   </table>
 108 </div>
 109  Record from a sound card using ALSA and encode to Ogg/Vorbis.
 110 </div>
 111 <p>
 112 </p>
 113 <p>
 114 Last reviewed on 2006-03-01 (0.10.4)
 115 </p>
 116 <div class="refsynopsisdiv">
 117 <h2>Synopsis</h2>
 118 <div class="refsect2">
 119 <a name="idp15013472"></a><h3>Element Information</h3>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody>
 123 <tr>
 124 <td><p><span class="term">plugin</span></p></td>
 125 <td>
 126             <a class="link" href="gst-plugins-base-plugins-plugin-vorbis.html#plugin-vorbis">vorbis</a>
 127           </td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term">author</span></p></td>
 131 <td>Monty &lt;monty@xiph.org&gt;, Wim Taymans &lt;wim@fluendo.com&gt;</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term">class</span></p></td>
 135 <td>Codec/Encoder/Audio</td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="idp15020880"></a><h3>Element Pads</h3>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term">name</span></p></td>
 148 <td>sink</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term">direction</span></p></td>
 152 <td>sink</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term">presence</span></p></td>
 156 <td>always</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term">details</span></p></td>
 160 <td>audio/x-raw-float, rate=(int)[ 1, 200000 ], channels=(int)[ 1, 256 ], endianness=(int)1234, width=(int)32</td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 <div class="variablelist"><table border="0">
 165 <col align="left" valign="top">
 166 <tbody>
 167 <tr>
 168 <td><p><span class="term">name</span></p></td>
 169 <td>src</td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term">direction</span></p></td>
 173 <td>source</td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term">presence</span></p></td>
 177 <td>always</td>
 178 </tr>
 179 <tr>
 180 <td><p><span class="term">details</span></p></td>
 181 <td>audio/x-vorbis</td>
 182 </tr>
 183 </tbody>
 184 </table></div>
 185 </div>
 186 </div>
 187 <p>
 188 </p>
 189 </div>
 190 <div class="refsect1">
 191 <a name="gst-plugins-base-plugins-vorbisenc.details"></a><h2>Details</h2>
 192 <div class="refsect2">
 193 <a name="GstVorbisEnc-struct"></a><h3>struct GstVorbisEnc</h3>
 194 <pre class="programlisting">struct GstVorbisEnc;</pre>
 195 <p>
 196 Opaque data structure.
 197 </p>
 198 </div>
 199 </div>
 200 <div class="refsect1">
 201 <a name="gst-plugins-base-plugins-vorbisenc.property-details"></a><h2>Property Details</h2>
 202 <div class="refsect2">
 203 <a name="GstVorbisEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
 204 <pre class="programlisting">  "bitrate"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 205 <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>
 206 <p>Allowed values: [G_MAXULONG,250001]</p>
 207 <p>Default value: -1</p>
 208 </div>
 209 <hr>
 210 <div class="refsect2">
 211 <a name="GstVorbisEnc--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3>
 212 <pre class="programlisting">  "last-message"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 213 <p>The last status message.</p>
 214 <p>Default value: NULL</p>
 215 </div>
 216 <hr>
 217 <div class="refsect2">
 218 <a name="GstVorbisEnc--managed"></a><h3>The <code class="literal">"managed"</code> property</h3>
 219 <pre class="programlisting">  "managed"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 220 <p>Enable bitrate management engine.</p>
 221 <p>Default value: FALSE</p>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="GstVorbisEnc--max-bitrate"></a><h3>The <code class="literal">"max-bitrate"</code> property</h3>
 226 <pre class="programlisting">  "max-bitrate"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 227 <p>Specify a maximum bitrate (in bps). Useful for streaming applications. (-1 == disabled).</p>
 228 <p>Allowed values: [G_MAXULONG,250001]</p>
 229 <p>Default value: -1</p>
 230 </div>
 231 <hr>
 232 <div class="refsect2">
 233 <a name="GstVorbisEnc--min-bitrate"></a><h3>The <code class="literal">"min-bitrate"</code> property</h3>
 234 <pre class="programlisting">  "min-bitrate"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 235 <p>Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled).</p>
 236 <p>Allowed values: [G_MAXULONG,250001]</p>
 237 <p>Default value: -1</p>
 238 </div>
 239 <hr>
 240 <div class="refsect2">
 241 <a name="GstVorbisEnc--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
 242 <pre class="programlisting">  "quality"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 243 <p>Specify quality instead of specifying a particular bitrate.</p>
 244 <p>Allowed values: [-0.1,1]</p>
 245 <p>Default value: 0.3</p>
 246 </div>
 247 </div>
 248 <div class="refsect1">
 249 <a name="gst-plugins-base-plugins-vorbisenc.see-also"></a><h2>See Also</h2>
 250 vorbisdec, oggmux
 251 </div>
 252 </div>
 253 <div class="footer">
 254 <hr>
 255           Generated by GTK-Doc V1.17</div>
 256 </body>
 257 </html>