<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>vorbisenc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
<link rel="prev" href="gst-plugins-base-plugins-vorbisdec.html" title="vorbisdec">
<link rel="next" href="gst-plugins-base-plugins-vorbisparse.html" title="vorbisparse">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="gst-plugins-base Elements">
<link rel="chapter" href="ch02.html" title="gst-plugins-base Plugins">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<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>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
<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>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2618260" class="shortcut">Top</a>
 | 
<a href="#id2596390" class="shortcut">Description</a>
 | 
<a href="#id2618219" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2618190" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2602712" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gst-plugins-base-plugins-vorbisenc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2618260"></a><span class="refentrytitle">vorbisenc</span>
</h2>
<p>vorbisenc — an encoder that encodes audio to Vorbis</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GstVorbisEnc"></a><pre class="synopsis">
<a href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc-struct">GstVorbisEnc</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2618219"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GstObject
+----GstElement
+----GstVorbisEnc
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2618190"></a><h2>Implemented Interfaces</h2>
<p>
GstVorbisEnc implements
GstTagSetter.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2602712"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--bitrate">bitrate</a>" gint : Read / Write
"<a href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--last-message">last-message</a>" gchar* : Read
"<a href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--managed">managed</a>" gboolean : Read / Write
"<a href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--max-bitrate">max-bitrate</a>" gint : Read / Write
"<a href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--min-bitrate">min-bitrate</a>" gint : Read / Write
"<a href="gst-plugins-base-plugins-vorbisenc.html#GstVorbisEnc--quality">quality</a>" gfloat : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2596390"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2" lang="en">
<a name="id2620159"></a><p>
This element encodes raw float audio into a Vorbis stream.
<a href="http://www.vorbis.com/" target="_top">Vorbis</a> is a royalty-free
audio codec maintained by the <a href="http://www.xiph.org/" target="_top">Xiph.org
Foundation</a>.
</p>
<h3>Example pipelines</h3>
<p>
Encode a test sine signal to Ogg/Vorbis. Note that the resulting file
will be really small because a sine signal compresses very well.
</p>
<pre class="programlisting">
gst-launch -v audiotestsrc wave=sine num-buffers=100 ! audioconvert ! vorbisenc ! oggmux ! filesink location=sine.ogg
</pre>
<p>
Record from a sound card using ALSA and encode to Ogg/Vorbis.
</p>
<pre class="programlisting">
gst-launch -v alsasrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=alsasrc.ogg
</pre>
</div>
<p>
</p>
<p>
Last reviewed on 2006-03-01 (0.10.4)</p>
<div class="refsect2" lang="en">
<a name="id2620214"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">plugin</span></td>
<td>
<a href="gst-plugins-base-plugins-plugin-vorbis.html#plugin-vorbis">vorbis</a>
</td>
</tr>
<tr>
<td><span class="term">author</span></td>
<td>Monty <monty@xiph.org>, Wim Taymans <wim@fluendo.com></td>
</tr>
<tr>
<td><span class="term">class</span></td>
<td>Codec/Encoder/Audio</td>
</tr>
</tbody>
</table></div>
<h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">name</span></td>
<td>sink</td>
</tr>
<tr>
<td><span class="term">direction</span></td>
<td>sink</td>
</tr>
<tr>
<td><span class="term">presence</span></td>
<td>always</td>
</tr>
<tr>
<td><span class="term">details</span></td>
<td>audio/x-raw-float, rate=(int)[ 1, 200000 ], channels=(int)[ 1, 256 ], endianness=(int)1234, width=(int)32</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">name</span></td>
<td>src</td>
</tr>
<tr>
<td><span class="term">direction</span></td>
<td>source</td>
</tr>
<tr>
<td><span class="term">presence</span></td>
<td>always</td>
</tr>
<tr>
<td><span class="term">details</span></td>
<td>audio/x-vorbis</td>
</tr>
</tbody>
</table></div>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2620416"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2620427"></a><h3>
<a name="GstVorbisEnc-struct"></a>GstVorbisEnc</h3>
<a class="indexterm" name="id2620439"></a><pre class="programlisting">typedef struct _GstVorbisEnc GstVorbisEnc;</pre>
<p>
Opaque data structure.</p>
<p>
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2620460"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2620470"></a><h3>
<a name="GstVorbisEnc--bitrate"></a>The "<code class="literal">bitrate</code>" property</h3>
<a class="indexterm" name="id2620484"></a><pre class="programlisting"> "bitrate" gint : Read / Write</pre>
<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>
<p>Allowed values: [-1,250001]</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618268"></a><h3>
<a name="GstVorbisEnc--last-message"></a>The "<code class="literal">last-message</code>" property</h3>
<a class="indexterm" name="id2618282"></a><pre class="programlisting"> "last-message" gchar* : Read</pre>
<p>The last status message.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618307"></a><h3>
<a name="GstVorbisEnc--managed"></a>The "<code class="literal">managed</code>" property</h3>
<a class="indexterm" name="id2618320"></a><pre class="programlisting"> "managed" gboolean : Read / Write</pre>
<p>Enable bitrate management engine.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618344"></a><h3>
<a name="GstVorbisEnc--max-bitrate"></a>The "<code class="literal">max-bitrate</code>" property</h3>
<a class="indexterm" name="id2618358"></a><pre class="programlisting"> "max-bitrate" gint : Read / Write</pre>
<p>Specify a maximum bitrate (in bps). Useful for streaming applications. (-1 == disabled).</p>
<p>Allowed values: [-1,250001]</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618389"></a><h3>
<a name="GstVorbisEnc--min-bitrate"></a>The "<code class="literal">min-bitrate</code>" property</h3>
<a class="indexterm" name="id2618403"></a><pre class="programlisting"> "min-bitrate" gint : Read / Write</pre>
<p>Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled).</p>
<p>Allowed values: [-1,250001]</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618434"></a><h3>
<a name="GstVorbisEnc--quality"></a>The "<code class="literal">quality</code>" property</h3>
<a class="indexterm" name="id2618448"></a><pre class="programlisting"> "quality" gfloat : Read / Write</pre>
<p>Specify quality instead of specifying a particular bitrate.</p>
<p>Allowed values: [-0.1,1]</p>
<p>Default value: 0.3</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2618479"></a><h2>See Also</h2>
vorbisdec, oggmux
</div>
</div>
</body>
</html>
