Git init
[framework/multimedia/gst-plugins-base0.10.git] / docs / plugins / html / gst-plugins-base-plugins-theoraenc.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>theoraenc</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-theoradec.html" title="theoradec">
10 <link rel="next" href="gst-plugins-base-plugins-theoraparse.html" title="theoraparse">
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-theoradec.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-theoraparse.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-theoraenc.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-plugins-theoraenc.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-base-plugins-theoraenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-base-plugins-theoraenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-base-plugins-theoraenc.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="gst-plugins-base-plugins-theoraenc"></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-theoraenc.top_of_page"></a>theoraenc</span></h2>
40 <p>theoraenc — encode raw YUV video to a theora stream</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-theoraenc.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstTheoraEnc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc-struct" title="struct GstTheoraEnc">GstTheoraEnc</a>;
47 enum                <a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEncBorderMode" title="enum GstTheoraEncBorderMode">GstTheoraEncBorderMode</a>;
48 </pre>
49 </div>
50 <div class="refsect1">
51 <a name="gst-plugins-base-plugins-theoraenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
52 <pre class="synopsis">
53   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</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                +----GstTheoraEnc
57 </pre>
58 </div>
59 <div class="refsect1">
60 <a name="gst-plugins-base-plugins-theoraenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
61 <p>
62 GstTheoraEnc implements
63  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
64 </div>
65 <div class="refsect1">
66 <a name="gst-plugins-base-plugins-theoraenc.properties"></a><h2>Properties</h2>
67 <pre class="synopsis">
68   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--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
69   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--border" title='The "border" property'>border</a>"                   <a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEncBorderMode" title="enum GstTheoraEncBorderMode"><span class="type">GstTheoraEncBorderMode</span></a>  : Read / Write
70   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--center" title='The "center" property'>center</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
71   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--keyframe-auto" title='The "keyframe-auto" property'>keyframe-auto</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-theoraenc.html#GstTheoraEnc--keyframe-force" title='The "keyframe-force" property'>keyframe-force</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-theoraenc.html#GstTheoraEnc--keyframe-freq" title='The "keyframe-freq" property'>keyframe-freq</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-theoraenc.html#GstTheoraEnc--keyframe-mindistance" title='The "keyframe-mindistance" property'>keyframe-mindistance</a>"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
75   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--keyframe-threshold" title='The "keyframe-threshold" property'>keyframe-threshold</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
76   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--noise-sensitivity" title='The "noise-sensitivity" property'>noise-sensitivity</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
77   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--quality" title='The "quality" property'>quality</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
78   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--quick" title='The "quick" property'>quick</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
79   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--sharpness" title='The "sharpness" property'>sharpness</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
80   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--speed-level" title='The "speed-level" property'>speed-level</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
81   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--cap-overflow" title='The "cap-overflow" property'>cap-overflow</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
82   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--cap-underflow" title='The "cap-underflow" property'>cap-underflow</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
83   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--drop-frames" title='The "drop-frames" property'>drop-frames</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
84   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--rate-buffer" title='The "rate-buffer" property'>rate-buffer</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
85   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--vp3-compatible" title='The "vp3-compatible" property'>vp3-compatible</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
86   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--multipass-cache-file" title='The "multipass-cache-file" property'>multipass-cache-file</a>"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
87   "<a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEnc--multipass-mode" title='The "multipass-mode" property'>multipass-mode</a>"           <span class="type">GstTheoraEncMultipassMode</span>  : Read / Write
88 </pre>
89 </div>
90 <div class="refsect1">
91 <a name="gst-plugins-base-plugins-theoraenc.description"></a><h2>Description</h2>
92 <p>
93 This element encodes raw video into a Theora stream.
94 <a class="ulink" href="http://www.theora.org/" target="_top">Theora</a> is a royalty-free
95 video codec maintained by the <a class="ulink" href="http://www.xiph.org/" target="_top">Xiph.org
96 Foundation</a>, based on the VP3 codec.
97 </p>
98 <p>
99 The theora codec internally only supports encoding of images that are a
100 multiple of 16 pixels in both X and Y direction. It is however perfectly
101 possible to encode images with other dimensions because an arbitrary
102 rectangular cropping region can be set up. This element will automatically
103 set up a correct cropping region if the dimensions are not multiples of 16
104 pixels.
105 </p>
106 <p>
107 To control the quality of the encoding, the <span class="type">"bitrate"</span> and
108 <span class="type">"quality"</span> properties can be used. These two properties are
109 mutualy exclusive. Setting the bitrate property will produce a constant
110 bitrate (CBR) stream while setting the quality property will produce a
111 variable bitrate (VBR) stream.
112 </p>
113 <p>
114 </p>
115 <div class="refsect2">
116 <a name="idp14365920"></a><h3>Example pipeline</h3>
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>v videotestsrc num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">1000</span> <span class="gtkdoc opt">!</span> theoraenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>videotestsrc<span class="gtkdoc opt">.</span>ogg</pre></td>
123       </tr>
124     </tbody>
125   </table>
126 </div>
127  This example pipeline will encode a test video source to theora muxed in an
128 ogg container. Refer to the theoradec documentation to decode the create
129 stream.
130 </div>
131 <p>
132 </p>
133 <p>
134 Last reviewed on 2006-03-01 (0.10.4)
135 </p>
136 <div class="refsynopsisdiv">
137 <h2>Synopsis</h2>
138 <div class="refsect2">
139 <a name="idp14369280"></a><h3>Element Information</h3>
140 <div class="variablelist"><table border="0">
141 <col align="left" valign="top">
142 <tbody>
143 <tr>
144 <td><p><span class="term">plugin</span></p></td>
145 <td>
146             <a class="link" href="gst-plugins-base-plugins-plugin-theora.html#plugin-theora">theora</a>
147           </td>
148 </tr>
149 <tr>
150 <td><p><span class="term">author</span></p></td>
151 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
152 </tr>
153 <tr>
154 <td><p><span class="term">class</span></p></td>
155 <td>Codec/Encoder/Video</td>
156 </tr>
157 </tbody>
158 </table></div>
159 </div>
160 <hr>
161 <div class="refsect2">
162 <a name="idp14376736"></a><h3>Element Pads</h3>
163 <div class="variablelist"><table border="0">
164 <col align="left" valign="top">
165 <tbody>
166 <tr>
167 <td><p><span class="term">name</span></p></td>
168 <td>sink</td>
169 </tr>
170 <tr>
171 <td><p><span class="term">direction</span></p></td>
172 <td>sink</td>
173 </tr>
174 <tr>
175 <td><p><span class="term">presence</span></p></td>
176 <td>always</td>
177 </tr>
178 <tr>
179 <td><p><span class="term">details</span></p></td>
180 <td>video/x-raw-yuv, format=(fourcc){ I420, Y42B, Y444 }, framerate=(fraction)[ 1/2147483647, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]</td>
181 </tr>
182 </tbody>
183 </table></div>
184 <div class="variablelist"><table border="0">
185 <col align="left" valign="top">
186 <tbody>
187 <tr>
188 <td><p><span class="term">name</span></p></td>
189 <td>src</td>
190 </tr>
191 <tr>
192 <td><p><span class="term">direction</span></p></td>
193 <td>source</td>
194 </tr>
195 <tr>
196 <td><p><span class="term">presence</span></p></td>
197 <td>always</td>
198 </tr>
199 <tr>
200 <td><p><span class="term">details</span></p></td>
201 <td>video/x-theora</td>
202 </tr>
203 </tbody>
204 </table></div>
205 </div>
206 </div>
207 <p>
208 </p>
209 </div>
210 <div class="refsect1">
211 <a name="gst-plugins-base-plugins-theoraenc.details"></a><h2>Details</h2>
212 <div class="refsect2">
213 <a name="GstTheoraEnc-struct"></a><h3>struct GstTheoraEnc</h3>
214 <pre class="programlisting">struct GstTheoraEnc;</pre>
215 <p>
216 Opaque data structure.
217 </p>
218 </div>
219 <hr>
220 <div class="refsect2">
221 <a name="GstTheoraEncBorderMode"></a><h3>enum GstTheoraEncBorderMode</h3>
222 <pre class="programlisting">typedef enum
223 {
224   BORDER_NONE,
225   BORDER_BLACK,
226   BORDER_MIRROR
227 }
228 GstTheoraEncBorderMode;
229 </pre>
230 <p>
231 Border color to add when sizes not multiple of 16.
232 </p>
233 <div class="variablelist"><table border="0">
234 <col align="left" valign="top">
235 <tbody>
236 <tr>
237 <td><p><a name="BORDER-NONE:CAPS"></a><span class="term"><code class="literal">BORDER_NONE</code></span></p></td>
238 <td>no border
239 </td>
240 </tr>
241 <tr>
242 <td><p><a name="BORDER-BLACK:CAPS"></a><span class="term"><code class="literal">BORDER_BLACK</code></span></p></td>
243 <td>black border
244 </td>
245 </tr>
246 <tr>
247 <td><p><a name="BORDER-MIRROR:CAPS"></a><span class="term"><code class="literal">BORDER_MIRROR</code></span></p></td>
248 <td>Mirror image in border
249 </td>
250 </tr>
251 </tbody>
252 </table></div>
253 </div>
254 </div>
255 <div class="refsect1">
256 <a name="gst-plugins-base-plugins-theoraenc.property-details"></a><h2>Property Details</h2>
257 <div class="refsect2">
258 <a name="GstTheoraEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
259 <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>
260 <p>Compressed video bitrate (kbps).</p>
261 <p>Allowed values: [0,16777215]</p>
262 <p>Default value: 0</p>
263 </div>
264 <hr>
265 <div class="refsect2">
266 <a name="GstTheoraEnc--border"></a><h3>The <code class="literal">"border"</code> property</h3>
267 <pre class="programlisting">  "border"                   <a class="link" href="gst-plugins-base-plugins-theoraenc.html#GstTheoraEncBorderMode" title="enum GstTheoraEncBorderMode"><span class="type">GstTheoraEncBorderMode</span></a>  : Read / Write</pre>
268 <p>ignored and kept for API compat only.</p>
269 <p>Default value: Black Border</p>
270 </div>
271 <hr>
272 <div class="refsect2">
273 <a name="GstTheoraEnc--center"></a><h3>The <code class="literal">"center"</code> property</h3>
274 <pre class="programlisting">  "center"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
275 <p>ignored and kept for API compat only.</p>
276 <p>Default value: TRUE</p>
277 </div>
278 <hr>
279 <div class="refsect2">
280 <a name="GstTheoraEnc--keyframe-auto"></a><h3>The <code class="literal">"keyframe-auto"</code> property</h3>
281 <pre class="programlisting">  "keyframe-auto"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
282 <p>Automatic keyframe detection.</p>
283 <p>Default value: TRUE</p>
284 </div>
285 <hr>
286 <div class="refsect2">
287 <a name="GstTheoraEnc--keyframe-force"></a><h3>The <code class="literal">"keyframe-force"</code> property</h3>
288 <pre class="programlisting">  "keyframe-force"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
289 <p>Force keyframe every N frames.</p>
290 <p>Allowed values: [1,32768]</p>
291 <p>Default value: 64</p>
292 </div>
293 <hr>
294 <div class="refsect2">
295 <a name="GstTheoraEnc--keyframe-freq"></a><h3>The <code class="literal">"keyframe-freq"</code> property</h3>
296 <pre class="programlisting">  "keyframe-freq"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
297 <p>Keyframe frequency.</p>
298 <p>Allowed values: [1,32768]</p>
299 <p>Default value: 64</p>
300 </div>
301 <hr>
302 <div class="refsect2">
303 <a name="GstTheoraEnc--keyframe-mindistance"></a><h3>The <code class="literal">"keyframe-mindistance"</code> property</h3>
304 <pre class="programlisting">  "keyframe-mindistance"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
305 <p>ignored and kept for API compat only.</p>
306 <p>Allowed values: [1,32768]</p>
307 <p>Default value: 8</p>
308 </div>
309 <hr>
310 <div class="refsect2">
311 <a name="GstTheoraEnc--keyframe-threshold"></a><h3>The <code class="literal">"keyframe-threshold"</code> property</h3>
312 <pre class="programlisting">  "keyframe-threshold"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
313 <p>ignored and kept for API compat only.</p>
314 <p>Allowed values: [0,32768]</p>
315 <p>Default value: 80</p>
316 </div>
317 <hr>
318 <div class="refsect2">
319 <a name="GstTheoraEnc--noise-sensitivity"></a><h3>The <code class="literal">"noise-sensitivity"</code> property</h3>
320 <pre class="programlisting">  "noise-sensitivity"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
321 <p>ignored and kept for API compat only.</p>
322 <p>Allowed values: [0,32768]</p>
323 <p>Default value: 1</p>
324 </div>
325 <hr>
326 <div class="refsect2">
327 <a name="GstTheoraEnc--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
328 <pre class="programlisting">  "quality"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
329 <p>Video quality.</p>
330 <p>Allowed values: [0,63]</p>
331 <p>Default value: 48</p>
332 </div>
333 <hr>
334 <div class="refsect2">
335 <a name="GstTheoraEnc--quick"></a><h3>The <code class="literal">"quick"</code> property</h3>
336 <pre class="programlisting">  "quick"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
337 <p>ignored and kept for API compat only.</p>
338 <p>Default value: TRUE</p>
339 </div>
340 <hr>
341 <div class="refsect2">
342 <a name="GstTheoraEnc--sharpness"></a><h3>The <code class="literal">"sharpness"</code> property</h3>
343 <pre class="programlisting">  "sharpness"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
344 <p>ignored and kept for API compat only.</p>
345 <p>Allowed values: [0,2]</p>
346 <p>Default value: 0</p>
347 </div>
348 <hr>
349 <div class="refsect2">
350 <a name="GstTheoraEnc--speed-level"></a><h3>The <code class="literal">"speed-level"</code> property</h3>
351 <pre class="programlisting">  "speed-level"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
352 <p>Controls the amount of analysis performed when encoding. Higher values trade compression quality for speed. This property requires libtheora version &gt;= 1.0, and the maximum value may vary based on encoder version.</p>
353 <p>Allowed values: [0,2]</p>
354 <p>Default value: 1</p>
355 </div>
356 <hr>
357 <div class="refsect2">
358 <a name="GstTheoraEnc--cap-overflow"></a><h3>The <code class="literal">"cap-overflow"</code> property</h3>
359 <pre class="programlisting">  "cap-overflow"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
360 <p>Enable capping of bit reservoir overflows.</p>
361 <p>Default value: TRUE</p>
362 </div>
363 <hr>
364 <div class="refsect2">
365 <a name="GstTheoraEnc--cap-underflow"></a><h3>The <code class="literal">"cap-underflow"</code> property</h3>
366 <pre class="programlisting">  "cap-underflow"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
367 <p>Enable capping of bit reservoir underflows.</p>
368 <p>Default value: FALSE</p>
369 </div>
370 <hr>
371 <div class="refsect2">
372 <a name="GstTheoraEnc--drop-frames"></a><h3>The <code class="literal">"drop-frames"</code> property</h3>
373 <pre class="programlisting">  "drop-frames"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
374 <p>Allow or disallow frame dropping.</p>
375 <p>Default value: TRUE</p>
376 </div>
377 <hr>
378 <div class="refsect2">
379 <a name="GstTheoraEnc--rate-buffer"></a><h3>The <code class="literal">"rate-buffer"</code> property</h3>
380 <pre class="programlisting">  "rate-buffer"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
381 <p>Sets the size of the rate control buffer, in units of frames.  The default value of 0 instructs the encoder to automatically select an appropriate value.</p>
382 <p>Allowed values: [0,1000]</p>
383 <p>Default value: 0</p>
384 </div>
385 <hr>
386 <div class="refsect2">
387 <a name="GstTheoraEnc--vp3-compatible"></a><h3>The <code class="literal">"vp3-compatible"</code> property</h3>
388 <pre class="programlisting">  "vp3-compatible"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
389 <p>Disables non-VP3 compatible features.</p>
390 <p>Default value: FALSE</p>
391 </div>
392 <hr>
393 <div class="refsect2">
394 <a name="GstTheoraEnc--multipass-cache-file"></a><h3>The <code class="literal">"multipass-cache-file"</code> property</h3>
395 <pre class="programlisting">  "multipass-cache-file"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
396 <p>Multipass cache file.</p>
397 <p>Default value: NULL</p>
398 </div>
399 <hr>
400 <div class="refsect2">
401 <a name="GstTheoraEnc--multipass-mode"></a><h3>The <code class="literal">"multipass-mode"</code> property</h3>
402 <pre class="programlisting">  "multipass-mode"           <span class="type">GstTheoraEncMultipassMode</span>  : Read / Write</pre>
403 <p>Single pass or first/second pass.</p>
404 <p>Default value: Single pass</p>
405 </div>
406 </div>
407 <div class="refsect1">
408 <a name="gst-plugins-base-plugins-theoraenc.see-also"></a><h2>See Also</h2>
409 theoradec, oggmux
410 </div>
411 </div>
412 <div class="footer">
413 <hr>
414           Generated by GTK-Doc V1.17</div>
415 </body>
416 </html>