4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>vorbisenc</title>
5
<title>GStreamer Base Plugins 1.0 Plugins Reference Manual: vorbisenc</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
9
9
<link rel="prev" href="gst-plugins-base-plugins-vorbisdec.html" title="vorbisdec">
10
10
<link rel="next" href="gst-plugins-base-plugins-vorbisparse.html" title="vorbisparse">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
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">
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 1.0 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>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#gst-plugins-base-plugins-vorbisenc.synopsis" class="shortcut">Top</a>
26
<a href="#gst-plugins-base-plugins-vorbisenc.description" class="shortcut">Description</a>
28
<a href="#gst-plugins-base-plugins-vorbisenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#gst-plugins-base-plugins-vorbisenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#gst-plugins-base-plugins-vorbisenc.properties" class="shortcut">Properties</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><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>
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>
35
28
<div class="refentry">
36
29
<a name="gst-plugins-base-plugins-vorbisenc"></a><div class="titlepage"></div>
37
30
<div class="refnamediv"><table width="100%"><tr>
39
32
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-vorbisenc.top_of_page"></a>vorbisenc</span></h2>
40
33
<p>vorbisenc — Encodes audio in Vorbis format</p>
42
<td valign="top" align="right"></td>
35
<td class="gallery_image" valign="top" align="right"></td>
43
36
</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>;
37
<div class="refsect1">
38
<a name="gst-plugins-base-plugins-vorbisenc.properties"></a><h2>Properties</h2>
39
<div class="informaltable"><table border="0">
41
<col width="150px" class="properties_type">
42
<col width="300px" class="properties_name">
43
<col width="200px" class="properties_flags">
47
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/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>
52
<td class="property_type">
53
<a href="http://library.gnome.org/devel/glib/unstable/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>
58
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/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>
63
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/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>
68
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/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>
73
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/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>
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 width="100%" border="0">
84
<col width="150px" class="name">
85
<col class="description">
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>
49
93
<div class="refsect1">
50
94
<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://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
54
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
55
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
56
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudioencoder.html#GstAudioEncoder">GstAudioEncoder</a>
95
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
96
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
97
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
98
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
99
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudioencoder.html#GstAudioEncoder">GstAudioEncoder</a>
100
<span class="lineart">╰──</span> GstVorbisEnc
60
103
<div class="refsect1">
64
107
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a> and <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a>.</p>
66
109
<div class="refsect1">
67
<a name="gst-plugins-base-plugins-vorbisenc.properties"></a><h2>Properties</h2>
68
<pre class="synopsis">
69
"<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
70
"<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
71
"<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
72
"<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
73
"<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
74
"<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
77
<div class="refsect1">
78
110
<a name="gst-plugins-base-plugins-vorbisenc.description"></a><h2>Description</h2>
79
111
<div class="refsynopsisdiv">
81
113
<div class="refsect2">
82
<a name="id-1.2.42.7.2.1"></a><h3>Element Information</h3>
114
<a name="id-1.2.42.8.2.1"></a><h3>Element Information</h3>
83
115
<div class="variablelist"><table border="0" class="variablelist">
85
117
<col align="left" valign="top">
171
206
<div class="refsect1">
172
207
<a name="gst-plugins-base-plugins-vorbisenc.property-details"></a><h2>Property Details</h2>
173
208
<div class="refsect2">
174
<a name="GstVorbisEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
175
<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>
209
<a name="GstVorbisEnc--bitrate"></a><h3>The <code class="literal">“bitrate”</code> property</h3>
210
<pre class="programlisting"> “bitrate” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
176
211
<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>
212
<p>Flags: Read / Write</p>
177
213
<p>Allowed values: [G_MAXULONG,250001]</p>
178
214
<p>Default value: -1</p>
181
217
<div class="refsect2">
182
<a name="GstVorbisEnc--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3>
183
<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>
218
<a name="GstVorbisEnc--last-message"></a><h3>The <code class="literal">“last-message”</code> property</h3>
219
<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> *</pre>
184
220
<p>The last status message.</p>
185
222
<p>Default value: NULL</p>
188
225
<div class="refsect2">
189
<a name="GstVorbisEnc--managed"></a><h3>The <code class="literal">"managed"</code> property</h3>
190
<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>
226
<a name="GstVorbisEnc--managed"></a><h3>The <code class="literal">“managed”</code> property</h3>
227
<pre class="programlisting"> “managed” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
191
228
<p>Enable bitrate management engine.</p>
229
<p>Flags: Read / Write</p>
192
230
<p>Default value: FALSE</p>
195
233
<div class="refsect2">
196
<a name="GstVorbisEnc--max-bitrate"></a><h3>The <code class="literal">"max-bitrate"</code> property</h3>
197
<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>
234
<a name="GstVorbisEnc--max-bitrate"></a><h3>The <code class="literal">“max-bitrate”</code> property</h3>
235
<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></pre>
198
236
<p>Specify a maximum bitrate (in bps). Useful for streaming applications. (-1 == disabled).</p>
237
<p>Flags: Read / Write</p>
199
238
<p>Allowed values: [G_MAXULONG,250001]</p>
200
239
<p>Default value: -1</p>
203
242
<div class="refsect2">
204
<a name="GstVorbisEnc--min-bitrate"></a><h3>The <code class="literal">"min-bitrate"</code> property</h3>
205
<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>
243
<a name="GstVorbisEnc--min-bitrate"></a><h3>The <code class="literal">“min-bitrate”</code> property</h3>
244
<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></pre>
206
245
<p>Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled).</p>
246
<p>Flags: Read / Write</p>
207
247
<p>Allowed values: [G_MAXULONG,250001]</p>
208
248
<p>Default value: -1</p>
211
251
<div class="refsect2">
212
<a name="GstVorbisEnc--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
213
<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>
252
<a name="GstVorbisEnc--quality"></a><h3>The <code class="literal">“quality”</code> property</h3>
253
<pre class="programlisting"> “quality” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
214
254
<p>Specify quality instead of specifying a particular bitrate.</p>
255
<p>Flags: Read / Write</p>
215
256
<p>Allowed values: [-0.1,1]</p>
216
257
<p>Default value: 0.3</p>
added
removed
docs/plugins/html/gst-plugins-base-plugins-vorbisenc.html
