gstreamer0.10-plugins-bad-doc 0.10.23-7.2ubuntu1 / usr / share / gtk-doc / html / gst-plugins-bad-libs-0.10 / gst-plugins-bad-libs-GstBaseVideoEncoder.html

This file is indexed.

/usr/share/gtk-doc/html/gst-plugins-bad-libs-0.10/gst-plugins-bad-libs-GstBaseVideoEncoder.html is in gstreamer0.10-plugins-bad-doc 0.10.23-7.2ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GStreamer Bad Plugins 0.10 Library Reference Manual: GstBaseVideoEncoder</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Library Reference Manual">
<link rel="up" href="video.html" title="Base video element classes">
<link rel="prev" href="gst-plugins-bad-libs-GstBaseVideoDecoder.html" title="GstBaseVideoDecoder">
<link rel="next" href="gst-plugins-bad-libs-gstbasevideoutils.html" title="gstbasevideoutils">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-libs-GstBaseVideoEncoder.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-libs-GstBaseVideoEncoder.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="video.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-libs-GstBaseVideoDecoder.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-libs-gstbasevideoutils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-libs-GstBaseVideoEncoder.top_of_page"></a>GstBaseVideoEncoder</span></h2>
<p>GstBaseVideoEncoder — Base class for video encoders</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoState" title="struct GstVideoState"><span class="returnvalue">GstVideoState</span></a> *
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#gst-base-video-encoder-get-state" title="gst_base_video_encoder_get_state ()">gst_base_video_encoder_get_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoFrame" title="struct GstVideoFrame"><span class="returnvalue">GstVideoFrame</span></a> *
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#gst-base-video-encoder-get-oldest-frame" title="gst_base_video_encoder_get_oldest_frame ()">gst_base_video_encoder_get_oldest_frame</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#gst-base-video-encoder-finish-frame" title="gst_base_video_encoder_finish_frame ()">gst_base_video_encoder_finish_frame</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#gst-base-video-encoder-set-latency" title="gst_base_video_encoder_set_latency ()">gst_base_video_encoder_set_latency</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#gst-base-video-encoder-set-latency-fields" title="gst_base_video_encoder_set_latency_fields ()">gst_base_video_encoder_set_latency_fields</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GST-BASE-VIDEO-ENCODER-SINK-NAME:CAPS" title="GST_BASE_VIDEO_ENCODER_SINK_NAME">GST_BASE_VIDEO_ENCODER_SINK_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GST-BASE-VIDEO-ENCODER-SRC-NAME:CAPS" title="GST_BASE_VIDEO_ENCODER_SRC_NAME">GST_BASE_VIDEO_ENCODER_SRC_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GST-BASE-VIDEO-ENCODER-FLOW-DROPPED:CAPS" title="GST_BASE_VIDEO_ENCODER_FLOW_DROPPED">GST_BASE_VIDEO_ENCODER_FLOW_DROPPED</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder">GstBaseVideoEncoder</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoderClass" title="struct GstBaseVideoEncoderClass">GstBaseVideoEncoderClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder.description"></a><h2>Description</h2>
<p>This base class is for video encoders turning raw video into
encoded video data.</p>
<p>GstBaseVideoEncoder and subclass should cooperate as follows.</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><div class="itemizedlist">
<p class="title"><b>Configuration</b></p>
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
    Initially, GstBaseVideoEncoder calls <em class="parameter"><code>start</code></em> when the encoder element
    is activated, which allows subclass to perform any global setup.
  </p></li>
<li class="listitem"><p>
    GstBaseVideoEncoder calls <em class="parameter"><code>set_format</code></em> to inform subclass of the format
    of input video data that it is about to receive.  Subclass should
    setup for encoding and configure base class as appropriate
    (e.g. latency). While unlikely, it might be called more than once,
    if changing input parameters require reconfiguration.  Baseclass
    will ensure that processing of current configuration is finished.
  </p></li>
<li class="listitem"><p>
    GstBaseVideoEncoder calls <em class="parameter"><code>stop</code></em> at end of all processing.
  </p></li>
</ul>
</div></li>
<li class="listitem"><div class="itemizedlist">
<p class="title"><b>Data processing</b></p>
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
      Base class collects input data and metadata into a frame and hands
      this to subclass' <em class="parameter"><code>handle_frame</code></em>.
    </p></li>
<li class="listitem"><p>
      If codec processing results in encoded data, subclass should call
      <em class="parameter"><code>gst_base_video_encoder_finish_frame</code></em> to have encoded data pushed
      downstream.
    </p></li>
<li class="listitem"><p>
      If implemented, baseclass calls subclass <em class="parameter"><code>shape_output</code></em> which then sends
      data downstream in desired form.  Otherwise, it is sent as-is.
    </p></li>
<li class="listitem"><p>
      GstBaseVideoEncoderClass will handle both srcpad and sinkpad events.
      Sink events will be passed to subclass if <em class="parameter"><code>event</code></em> callback has been
      provided.
    </p></li>
</ul>
</div></li>
<li class="listitem"><div class="itemizedlist">
<p class="title"><b>Shutdown phase</b></p>
<ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
    GstBaseVideoEncoder class calls <em class="parameter"><code>stop</code></em> to inform the subclass that data
    parsing will be stopped.
  </p></li></ul>
</div></li>
</ol></div>
<p>Subclass is responsible for providing pad template caps for
source and sink pads. The pads need to be named "sink" and "src". It should
also be able to provide fixed src pad caps in <em class="parameter"><code>getcaps</code></em>
 by the time it calls
<em class="parameter"><code>gst_base_video_encoder_finish_frame</code></em>
.</p>
<p>Things that subclass need to take care of:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Provide pad templates</p></li>
<li class="listitem"><p>
     Provide source pad caps before pushing the first buffer
  </p></li>
<li class="listitem"><p>
     Accept data in <em class="parameter"><code>handle_frame</code></em> and provide encoded results to
     <em class="parameter"><code>gst_base_video_encoder_finish_frame</code></em>.
  </p></li>
</ul></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-base-video-encoder-get-state"></a><h3>gst_base_video_encoder_get_state ()</h3>
<pre class="programlisting">const <a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoState" title="struct GstVideoState"><span class="returnvalue">GstVideoState</span></a> *
gst_base_video_encoder_get_state (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a> *coder</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.5.4.7.2.4"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>base_video_encoder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.4.7.2.5"></a><h4>Returns</h4>
<p> <a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoState" title="struct GstVideoState"><span class="type">GstVideoState</span></a> describing format of video data.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-base-video-encoder-get-oldest-frame"></a><h3>gst_base_video_encoder_get_oldest_frame ()</h3>
<pre class="programlisting"><a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoFrame" title="struct GstVideoFrame"><span class="returnvalue">GstVideoFrame</span></a> *
gst_base_video_encoder_get_oldest_frame
                               (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a> *coder</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.5.4.7.3.4"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>base_video_encoder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.4.7.3.5"></a><h4>Returns</h4>
<p> oldest unfinished pending <a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-base-video-encoder-finish-frame"></a><h3>gst_base_video_encoder_finish_frame ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
gst_base_video_encoder_finish_frame (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a> *base_video_encoder</code></em>,
                                     <em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>);</pre>
<p><em class="parameter"><code>frame</code></em>
 must have a valid encoded data buffer, whose metadata fields
are then appropriately set according to frame data or no buffer at
all if the frame should be dropped.
It is subsequently pushed downstream or provided to <em class="parameter"><code>shape_output</code></em>
.
In any case, the frame is considered finished and released.</p>
<div class="refsect3">
<a name="id-1.2.5.4.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>base_video_encoder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>frame</p></td>
<td class="parameter_description"><p>an encoded <a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.4.7.4.6"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a> resulting from sending data downstream</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-base-video-encoder-set-latency"></a><h3>gst_base_video_encoder_set_latency ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_base_video_encoder_set_latency (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a> *base_video_encoder</code></em>,
                                    <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> min_latency</code></em>,
                                    <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> max_latency</code></em>);</pre>
<p>Informs baseclass of encoding latency.</p>
<div class="refsect3">
<a name="id-1.2.5.4.7.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>base_video_encoder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>min_latency</p></td>
<td class="parameter_description"><p>minimum latency</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_latency</p></td>
<td class="parameter_description"><p>maximum latency</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-base-video-encoder-set-latency-fields"></a><h3>gst_base_video_encoder_set_latency_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_base_video_encoder_set_latency_fields
                               (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a> *base_video_encoder</code></em>,
                                <em class="parameter"><code><span class="type">int</span> n_fields</code></em>);</pre>
<p>Informs baseclass of encoding latency in terms of fields (both min
and max latency).</p>
<div class="refsect3">
<a name="id-1.2.5.4.7.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>base_video_encoder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fields</p></td>
<td class="parameter_description"><p>latency in fields</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GST-BASE-VIDEO-ENCODER-SINK-NAME:CAPS"></a><h3>GST_BASE_VIDEO_ENCODER_SINK_NAME</h3>
<pre class="programlisting">#define GST_BASE_VIDEO_ENCODER_SINK_NAME    "sink"
</pre>
<p>The name of the templates for the sink pad.</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-BASE-VIDEO-ENCODER-SRC-NAME:CAPS"></a><h3>GST_BASE_VIDEO_ENCODER_SRC_NAME</h3>
<pre class="programlisting">#define GST_BASE_VIDEO_ENCODER_SRC_NAME     "src"
</pre>
<p>The name of the templates for the source pad.</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-BASE-VIDEO-ENCODER-FLOW-DROPPED:CAPS"></a><h3>GST_BASE_VIDEO_ENCODER_FLOW_DROPPED</h3>
<pre class="programlisting">#define GST_BASE_VIDEO_ENCODER_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS_1
</pre>
<p>Returned when the event/buffer should be dropped.</p>
</div>
<hr>
<div class="refsect2">
<a name="GstBaseVideoEncoder"></a><h3>struct GstBaseVideoEncoder</h3>
<pre class="programlisting">struct GstBaseVideoEncoder {
  GstBaseVideoCodec base_video_codec;
};
</pre>
<p>The opaque <a class="link" href="gst-plugins-bad-libs-GstBaseVideoEncoder.html#GstBaseVideoEncoder" title="struct GstBaseVideoEncoder"><span class="type">GstBaseVideoEncoder</span></a> data structure.</p>
<div class="refsect3">
<a name="id-1.2.5.4.8.5.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstBaseVideoCodec" title="struct GstBaseVideoCodec"><span class="type">GstBaseVideoCodec</span></a> <em class="structfield"><code><a name="GstBaseVideoEncoder.base-video-codec"></a>base_video_codec</code></em>;</p></td>
<td> </td>
<td> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GstBaseVideoEncoderClass"></a><h3>struct GstBaseVideoEncoderClass</h3>
<pre class="programlisting">struct GstBaseVideoEncoderClass {
  GstBaseVideoCodecClass              base_video_codec_class;

  /* virtual methods for subclasses */

  gboolean      (*start)              (GstBaseVideoEncoder *coder);

  gboolean      (*stop)               (GstBaseVideoEncoder *coder);

  gboolean      (*set_format)         (GstBaseVideoEncoder *coder,
                                       GstVideoState *state);

  GstFlowReturn (*handle_frame)       (GstBaseVideoEncoder *coder,
                                       GstVideoFrame *frame);

  gboolean      (*reset)              (GstBaseVideoEncoder *coder);
  GstFlowReturn (*finish)             (GstBaseVideoEncoder *coder);

  GstFlowReturn (*shape_output)       (GstBaseVideoEncoder *coder,
                                       GstVideoFrame *frame);

  gboolean      (*event)              (GstBaseVideoEncoder *coder,
                                       GstEvent *event);
};
</pre>
<p>Subclasses can override any of the available virtual methods or not, as
needed. At minimum <em class="parameter"><code>handle_frame</code></em>
 needs to be overridden, and <em class="parameter"><code>set_format</code></em>

and <em class="parameter"><code>get_caps</code></em>
 are likely needed as well.</p>
<div class="refsect3">
<a name="id-1.2.5.4.8.6.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="gst-plugins-bad-libs-GstBaseVideoCodec.html#GstBaseVideoCodecClass" title="struct GstBaseVideoCodecClass"><span class="type">GstBaseVideoCodecClass</span></a> <em class="structfield"><code><a name="GstBaseVideoEncoderClass.base-video-codec-class"></a>base_video_codec_class</code></em>;</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.start"></a>start</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional.
Called when the element starts processing.
Allows opening external resources.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.stop"></a>stop</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional.
Called when the element stops processing.
Allows closing external resources.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.set-format"></a>set_format</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional.
Notifies subclass of incoming data format.
GstVideoState fields have already been
set according to provided caps.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.handle-frame"></a>handle_frame</code></em> ()</p></td>
<td class="struct_member_description"><p>Provides input frame to subclass.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.reset"></a>reset</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.finish"></a>finish</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional.
Called to request subclass to dispatch any pending remaining
data (e.g. at EOS).</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.shape-output"></a>shape_output</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional.
Allows subclass to push frame downstream in whatever
shape or form it deems appropriate.  If not provided,
provided encoded frame data is simply pushed downstream.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBaseVideoEncoderClass.event"></a>event</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional.
Event handler on the sink pad. This function should return
TRUE if the event was handled and should be discarded
(i.e. not unref'ed).</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstBaseVideoEncoder.see-also"></a><h2>See Also</h2>
<p><a href="/usr/share/gtk-doc/html/gstreamer-libs-0.10/GstBaseTransform.html"><span class="type">GstBaseTransform</span></a></p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.