← Back to branch summary

~ubuntu-branches/ubuntu/precise/gst-plugins-bad0.10/precise-proposed

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-bad-plugins-vp8enc.html

  • Committer: Bazaar Package Importer
  • Author(s): Ken VanDine
  • Date: 2011-07-19 14:32:43 UTC
  • mfrom: (18.4.21 sid)
  • Revision ID: james.westby@ubuntu.com-20110719143243-p7pnkh45akfp0ihk
Tags: 0.10.22-2ubuntu1
* Rebased on debian unstable, remaining changes:
  - debian/gstreamer-plugins-bad.install
    * don't include dtmf, liveadder, rtpmux, autoconvert and shm, we include 
      them in -good

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plugins/html/gst-plugins-bad-plugins-vp8enc.html
8
8
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9
9
<link rel="prev" href="gst-plugins-bad-plugins-vp8dec.html" title="vp8dec">
10
10
<link rel="next" href="ch02.html" title="gst-plugins-bad Plugins">
11
 
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
32
32
                  <a href="#gst-plugins-bad-plugins-vp8enc.properties" class="shortcut">Properties</a>
33
33
</td></tr>
34
34
</table>
35
 
<div class="refentry" title="vp8enc">
 
35
<div class="refentry">
36
36
<a name="gst-plugins-bad-plugins-vp8enc"></a><div class="titlepage"></div>
37
37
<div class="refnamediv"><table width="100%"><tr>
38
38
<td valign="top">
41
41
</td>
42
42
<td valign="top" align="right"></td>
43
43
</tr></table></div>
44
 
<div class="refsynopsisdiv" title="Synopsis">
 
44
<div class="refsynopsisdiv">
45
45
<a name="gst-plugins-bad-plugins-vp8enc.synopsis"></a><h2>Synopsis</h2>
46
 
<a name="GstVP8Enc"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-vp8enc.html#GstVP8Enc-struct" title="GstVP8Enc">GstVP8Enc</a>;
 
46
<a name="GstVP8Enc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-bad-plugins-vp8enc.html#GstVP8Enc-struct" title="struct GstVP8Enc">GstVP8Enc</a>;
47
47
</pre>
48
48
</div>
49
 
<div class="refsect1" title="Object Hierarchy">
 
49
<div class="refsect1">
50
50
<a name="gst-plugins-bad-plugins-vp8enc.object-hierarchy"></a><h2>Object Hierarchy</h2>
51
51
<pre class="synopsis">
52
52
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
57
57
                           +----GstVP8Enc
58
58
</pre>
59
59
</div>
60
 
<div class="refsect1" title="Implemented Interfaces">
 
60
<div class="refsect1">
61
61
<a name="gst-plugins-bad-plugins-vp8enc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
62
62
<p>
63
63
GstVP8Enc implements
64
64
 <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>
65
65
</div>
66
 
<div class="refsect1" title="Properties">
 
66
<div class="refsect1">
67
67
<a name="gst-plugins-bad-plugins-vp8enc.properties"></a><h2>Properties</h2>
68
68
<pre class="synopsis">
69
69
  "<a class="link" href="gst-plugins-bad-plugins-vp8enc.html#GstVP8Enc--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
79
79
  "<a class="link" href="gst-plugins-bad-plugins-vp8enc.html#GstVP8Enc--auto-alt-ref-frames" title='The "auto-alt-ref-frames" property'>auto-alt-ref-frames</a>"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
80
80
</pre>
81
81
</div>
82
 
<div class="refsect1" title="Description">
 
82
<div class="refsect1">
83
83
<a name="gst-plugins-bad-plugins-vp8enc.description"></a><h2>Description</h2>
84
84
<p>
85
85
This element encodes raw video into a VP8 stream.
95
95
bitrate (CBR) stream while setting the quality property will produce a
96
96
variable bitrate (VBR) stream.
97
97
</p>
98
 
<div class="refsect2" title="Example pipeline">
99
 
<a name="id665600"></a><h3>Example pipeline</h3>
 
98
<p>
 
99
</p>
 
100
<div class="refsect2">
 
101
<a name="idp19679664"></a><h3>Example pipeline</h3>
100
102
<div class="informalexample">
101
103
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
102
104
    <tbody>
103
105
      <tr>
104
106
        <td class="listing_lines" align="right"><pre>1</pre></td>
105
 
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch <span class="symbol">-</span>v videotestsrc num<span class="symbol">-</span>buffers<span class="symbol">=</span><span class="number">1000</span> <span class="symbol">!</span> vp8enc <span class="symbol">!</span> webmmux <span class="symbol">!</span> filesink location<span class="symbol">=</span>videotestsrc<span class="symbol">.</span>webm</pre></td>
 
107
        <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> vp8enc <span class="gtkdoc opt">!</span> webmmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>videotestsrc<span class="gtkdoc opt">.</span>webm</pre></td>
106
108
      </tr>
107
109
    </tbody>
108
110
  </table>
110
112
 This example pipeline will encode a test video source to VP8 muxed in an
111
113
WebM container.
112
114
</div>
113
 
</div>
114
 
<div class="refsect1" title="Details">
 
115
<p>
 
116
</p>
 
117
<div class="refsynopsisdiv">
 
118
<h2>Synopsis</h2>
 
119
<div class="refsect2">
 
120
<a name="idp19682496"></a><h3>Element Information</h3>
 
121
<div class="variablelist"><table border="0">
 
122
<col align="left" valign="top">
 
123
<tbody>
 
124
<tr>
 
125
<td><p><span class="term">plugin</span></p></td>
 
126
<td>
 
127
            <a class="link" href="gst-plugins-bad-plugins-plugin-vp8.html#plugin-vp8">vp8</a>
 
128
          </td>
 
129
</tr>
 
130
<tr>
 
131
<td><p><span class="term">author</span></p></td>
 
132
<td>David Schleef &lt;ds@entropywave.com&gt;</td>
 
133
</tr>
 
134
<tr>
 
135
<td><p><span class="term">class</span></p></td>
 
136
<td>Codec/Encoder/Video</td>
 
137
</tr>
 
138
</tbody>
 
139
</table></div>
 
140
</div>
 
141
<hr>
 
142
<div class="refsect2">
 
143
<a name="idp19689952"></a><h3>Element Pads</h3>
 
144
<div class="variablelist"><table border="0">
 
145
<col align="left" valign="top">
 
146
<tbody>
 
147
<tr>
 
148
<td><p><span class="term">name</span></p></td>
 
149
<td>sink</td>
 
150
</tr>
 
151
<tr>
 
152
<td><p><span class="term">direction</span></p></td>
 
153
<td>sink</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term">presence</span></p></td>
 
157
<td>always</td>
 
158
</tr>
 
159
<tr>
 
160
<td><p><span class="term">details</span></p></td>
 
161
<td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
162
</tr>
 
163
</tbody>
 
164
</table></div>
 
165
<div class="variablelist"><table border="0">
 
166
<col align="left" valign="top">
 
167
<tbody>
 
168
<tr>
 
169
<td><p><span class="term">name</span></p></td>
 
170
<td>src</td>
 
171
</tr>
 
172
<tr>
 
173
<td><p><span class="term">direction</span></p></td>
 
174
<td>source</td>
 
175
</tr>
 
176
<tr>
 
177
<td><p><span class="term">presence</span></p></td>
 
178
<td>always</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term">details</span></p></td>
 
182
<td>video/x-vp8</td>
 
183
</tr>
 
184
</tbody>
 
185
</table></div>
 
186
</div>
 
187
</div>
 
188
<p>
 
189
</p>
 
190
</div>
 
191
<div class="refsect1">
115
192
<a name="gst-plugins-bad-plugins-vp8enc.details"></a><h2>Details</h2>
116
 
<div class="refsect2" title="GstVP8Enc">
117
 
<a name="GstVP8Enc-struct"></a><h3>GstVP8Enc</h3>
118
 
<pre class="programlisting">typedef struct _GstVP8Enc GstVP8Enc;</pre>
 
193
<div class="refsect2">
 
194
<a name="GstVP8Enc-struct"></a><h3>struct GstVP8Enc</h3>
 
195
<pre class="programlisting">struct GstVP8Enc;</pre>
119
196
<p>
120
197
</p>
121
198
</div>
122
199
</div>
123
 
<div class="refsect1" title="Property Details">
 
200
<div class="refsect1">
124
201
<a name="gst-plugins-bad-plugins-vp8enc.property-details"></a><h2>Property Details</h2>
125
 
<div class="refsect2" title='The "bitrate" property'>
 
202
<div class="refsect2">
126
203
<a name="GstVP8Enc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
127
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>
128
 
<p>Bit rate.</p>
 
205
<p>Bit rate (in bits/sec).</p>
129
206
<p>Allowed values: [0,1000000000]</p>
130
207
<p>Default value: 0</p>
131
208
</div>
132
209
<hr>
133
 
<div class="refsect2" title='The "error-resilient" property'>
 
210
<div class="refsect2">
134
211
<a name="GstVP8Enc--error-resilient"></a><h3>The <code class="literal">"error-resilient"</code> property</h3>
135
212
<pre class="programlisting">  "error-resilient"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
136
213
<p>Encode streams that are error resilient.</p>
137
214
<p>Default value: FALSE</p>
138
215
</div>
139
216
<hr>
140
 
<div class="refsect2" title='The "max-keyframe-distance" property'>
 
217
<div class="refsect2">
141
218
<a name="GstVP8Enc--max-keyframe-distance"></a><h3>The <code class="literal">"max-keyframe-distance"</code> property</h3>
142
219
<pre class="programlisting">  "max-keyframe-distance"    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
143
220
<p>Maximum distance between key frames.</p>
145
222
<p>Default value: 60</p>
146
223
</div>
147
224
<hr>
148
 
<div class="refsect2" title='The "max-latency" property'>
 
225
<div class="refsect2">
149
226
<a name="GstVP8Enc--max-latency"></a><h3>The <code class="literal">"max-latency"</code> property</h3>
150
227
<pre class="programlisting">  "max-latency"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
151
228
<p>Number of frames in encoder queue.</p>
153
230
<p>Default value: 10</p>
154
231
</div>
155
232
<hr>
156
 
<div class="refsect2" title='The "mode" property'>
 
233
<div class="refsect2">
157
234
<a name="GstVP8Enc--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
158
235
<pre class="programlisting">  "mode"                     <span class="type">GstVP8EncMode</span>         : Read / Write</pre>
159
236
<p>Mode.</p>
160
237
<p>Default value: Variable Bit Rate (VBR) mode</p>
161
238
</div>
162
239
<hr>
163
 
<div class="refsect2" title='The "quality" property'>
 
240
<div class="refsect2">
164
241
<a name="GstVP8Enc--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
165
242
<pre class="programlisting">  "quality"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
166
243
<p>Quality.</p>
168
245
<p>Default value: 5</p>
169
246
</div>
170
247
<hr>
171
 
<div class="refsect2" title='The "speed" property'>
 
248
<div class="refsect2">
172
249
<a name="GstVP8Enc--speed"></a><h3>The <code class="literal">"speed"</code> property</h3>
173
250
<pre class="programlisting">  "speed"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
174
251
<p>Speed.</p>
176
253
<p>Default value: 0</p>
177
254
</div>
178
255
<hr>
179
 
<div class="refsect2" title='The "threads" property'>
 
256
<div class="refsect2">
180
257
<a name="GstVP8Enc--threads"></a><h3>The <code class="literal">"threads"</code> property</h3>
181
258
<pre class="programlisting">  "threads"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
182
259
<p>Threads.</p>
184
261
<p>Default value: 1</p>
185
262
</div>
186
263
<hr>
187
 
<div class="refsect2" title='The "multipass-cache-file" property'>
 
264
<div class="refsect2">
188
265
<a name="GstVP8Enc--multipass-cache-file"></a><h3>The <code class="literal">"multipass-cache-file"</code> property</h3>
189
266
<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>
190
267
<p>Multipass cache file.</p>
191
268
<p>Default value: NULL</p>
192
269
</div>
193
270
<hr>
194
 
<div class="refsect2" title='The "multipass-mode" property'>
 
271
<div class="refsect2">
195
272
<a name="GstVP8Enc--multipass-mode"></a><h3>The <code class="literal">"multipass-mode"</code> property</h3>
196
273
<pre class="programlisting">  "multipass-mode"           <span class="type">GstVP8EncMultipassMode</span>  : Read / Write</pre>
197
274
<p>Multipass encode mode.</p>
198
275
<p>Default value: One pass encoding (default)</p>
199
276
</div>
200
277
<hr>
201
 
<div class="refsect2" title='The "auto-alt-ref-frames" property'>
 
278
<div class="refsect2">
202
279
<a name="GstVP8Enc--auto-alt-ref-frames"></a><h3>The <code class="literal">"auto-alt-ref-frames"</code> property</h3>
203
280
<pre class="programlisting">  "auto-alt-ref-frames"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
204
281
<p>Automatically create alternative reference frames.</p>
205
282
<p>Default value: FALSE</p>
206
283
</div>
207
284
</div>
208
 
<div class="refsect1" title="See Also">
 
285
<div class="refsect1">
209
286
<a name="gst-plugins-bad-plugins-vp8enc.see-also"></a><h2>See Also</h2>
210
287
vp8dec, webmmux, oggmux
211
288
</div>
212
289
</div>
213
290
<div class="footer">
214
291
<hr>
215
 
          Generated by GTK-Doc V1.15</div>
 
292
          Generated by GTK-Doc V1.17</div>
216
293
</body>
217
294
</html>
 
 
b'\\ No newline at end of file'