/usr/share/gtk-doc/html/gst-plugins-base-libs-0.10/gst-plugins-base-libs-appsrc.html is in gstreamer0.10-plugins-base-doc 0.10.36-1ubuntu0.2.
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 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>appsrc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
<link rel="up" href="gstreamer-app.html" title="App Library">
<link rel="prev" href="gstreamer-app.html" title="App Library">
<link rel="next" href="gst-plugins-base-libs-appsink.html" title="appsink">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="gstreamer-app.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gstreamer-app.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 Library Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-base-libs-appsink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-base-libs-appsrc.synopsis" class="shortcut">Top</a>
|
<a href="#gst-plugins-base-libs-appsrc.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-base-libs-appsrc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-appsrc.top_of_page"></a>appsrc</span></h2>
<p>appsrc — Easy way for applications to inject buffers into a
pipeline</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-base-libs-appsrc.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gst/app/gstappsrc.h>
enum <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType">GstAppStreamType</a>;
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-caps" title="gst_app_src_set_caps ()">gst_app_src_set_caps</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-caps" title="gst_app_src_get_caps ()">gst_app_src_get_caps</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-latency" title="gst_app_src_get_latency ()">gst_app_src_get_latency</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">guint64</span> *min</code></em>,
<em class="parameter"><code><span class="type">guint64</span> *max</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-latency" title="gst_app_src_set_latency ()">gst_app_src_set_latency</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">guint64</span> min</code></em>,
<em class="parameter"><code><span class="type">guint64</span> max</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-size" title="gst_app_src_set_size ()">gst_app_src_set_size</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">gint64</span> size</code></em>);
<span class="returnvalue">gint64</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-size" title="gst_app_src_get_size ()">gst_app_src_get_size</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-stream-type" title="gst_app_src_set_stream_type ()">gst_app_src_set_stream_type</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType"><span class="type">GstAppStreamType</span></a> type</code></em>);
<a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType"><span class="returnvalue">GstAppStreamType</span></a> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-stream-type" title="gst_app_src_get_stream_type ()">gst_app_src_get_stream_type</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-max-bytes" title="gst_app_src_set_max_bytes ()">gst_app_src_set_max_bytes</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">guint64</span> max</code></em>);
<span class="returnvalue">guint64</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-max-bytes" title="gst_app_src_get_max_bytes ()">gst_app_src_get_max_bytes</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-emit-signals" title="gst_app_src_get_emit_signals ()">gst_app_src_get_emit_signals</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-emit-signals" title="gst_app_src_set_emit_signals ()">gst_app_src_set_emit_signals</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> emit</code></em>);
<a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrcCallbacks" title="GstAppSrcCallbacks">GstAppSrcCallbacks</a>;
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-callbacks" title="gst_app_src_set_callbacks ()">gst_app_src_set_callbacks</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrcCallbacks" title="GstAppSrcCallbacks"><span class="type">GstAppSrcCallbacks</span></a> *callbacks</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-push-buffer" title="gst_app_src_push_buffer ()">gst_app_src_push_buffer</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-end-of-stream" title="gst_app_src_end_of_stream ()">gst_app_src_end_of_stream</a> (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-appsrc.description"></a><h2>Description</h2>
<p>
The appsrc element can be used by applications to insert data into a
GStreamer pipeline. Unlike most GStreamer elements, Appsrc provides
external API functions.
</p>
<p>
appsrc can be used by linking with the libgstapp library to access the
methods directly or by using the appsrc action signals.
</p>
<p>
Before operating appsrc, the caps property must be set to a fixed caps
describing the format of the data that will be pushed with appsrc. An
exception to this is when pushing buffers with unknown caps, in which case no
caps should be set. This is typically true of file-like sources that push raw
byte buffers.
</p>
<p>
The main way of handing data to the appsrc element is by calling the
<a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-push-buffer" title="gst_app_src_push_buffer ()"><code class="function">gst_app_src_push_buffer()</code></a> method or by emitting the push-buffer action signal.
This will put the buffer onto a queue from which appsrc will read from in its
streaming thread. It is important to note that data transport will not happen
from the thread that performed the push-buffer call.
</p>
<p>
The "max-bytes" property controls how much data can be queued in appsrc
before appsrc considers the queue full. A filled internal queue will always
signal the "enough-data" signal, which signals the application that it should
stop pushing data into appsrc. The "block" property will cause appsrc to
block the push-buffer method until free data becomes available again.
</p>
<p>
When the internal queue is running out of data, the "need-data" signal is
emitted, which signals the application that it should start pushing more data
into appsrc.
</p>
<p>
In addition to the "need-data" and "enough-data" signals, appsrc can emit the
"seek-data" signal when the "stream-mode" property is set to "seekable" or
"random-access". The signal argument will contain the new desired position in
the stream expressed in the unit set with the "format" property. After
receiving the seek-data signal, the application should push-buffers from the
new position.
</p>
<p>
These signals allow the application to operate the appsrc in two different
ways:
</p>
<p>
The push model, in which the application repeatedly calls the push-buffer method
with a new buffer. Optionally, the queue size in the appsrc can be controlled
with the enough-data and need-data signals by respectively stopping/starting
the push-buffer calls. This is a typical mode of operation for the
stream-type "stream" and "seekable". Use this model when implementing various
network protocols or hardware devices.
</p>
<p>
The pull model where the need-data signal triggers the next push-buffer call.
This mode is typically used in the "random-access" stream-type. Use this
model for file access or other randomly accessable sources. In this mode, a
buffer of exactly the amount of bytes given by the need-data signal should be
pushed into appsrc.
</p>
<p>
In all modes, the size property on appsrc should contain the total stream
size in bytes. Setting this property is mandatory in the random-access mode.
For the stream and seekable modes, setting this property is optional but
recommended.
</p>
<p>
When the application is finished pushing data into appsrc, it should call
<a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-end-of-stream" title="gst_app_src_end_of_stream ()"><code class="function">gst_app_src_end_of_stream()</code></a> or emit the end-of-stream action signal. After
this call, no more buffers can be pushed into appsrc until a flushing seek
happened or the state of the appsrc has gone through READY.
</p>
<p>
Last reviewed on 2008-12-17 (0.10.10)
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-appsrc.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstAppStreamType"></a><h3>enum GstAppStreamType</h3>
<pre class="programlisting">typedef enum {
GST_APP_STREAM_TYPE_STREAM,
GST_APP_STREAM_TYPE_SEEKABLE,
GST_APP_STREAM_TYPE_RANDOM_ACCESS
} GstAppStreamType;
</pre>
<p>
The stream type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GST-APP-STREAM-TYPE-STREAM:CAPS"></a><span class="term"><code class="literal">GST_APP_STREAM_TYPE_STREAM</code></span></p></td>
<td>No seeking is supported in the stream, such as a
live stream.
</td>
</tr>
<tr>
<td><p><a name="GST-APP-STREAM-TYPE-SEEKABLE:CAPS"></a><span class="term"><code class="literal">GST_APP_STREAM_TYPE_SEEKABLE</code></span></p></td>
<td>The stream is seekable but seeking might not
be very fast, such as data from a webserver.
</td>
</tr>
<tr>
<td><p><a name="GST-APP-STREAM-TYPE-RANDOM-ACCESS:CAPS"></a><span class="term"><code class="literal">GST_APP_STREAM_TYPE_RANDOM_ACCESS</code></span></p></td>
<td>The stream is seekable and seeking is fast,
such as in a local file.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-set-caps"></a><h3>gst_app_src_set_caps ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_set_caps (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
<p>
Set the capabilities on the appsrc element. This function takes
a copy of the caps structure. After calling this method, the source will
only produce caps that match <em class="parameter"><code>caps</code></em>. <em class="parameter"><code>caps</code></em> must be fixed and the caps on the
buffers must match the caps or left NULL.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
<td>caps to set</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-get-caps"></a><h3>gst_app_src_get_caps ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * gst_app_src_get_caps (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);</pre>
<p>
Get the configured caps on <em class="parameter"><code>appsrc</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> produced by the source. <a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstCaps.html#gst-caps-unref"><code class="function">gst_caps_unref()</code></a> after usage.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-get-latency"></a><h3>gst_app_src_get_latency ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_get_latency (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">guint64</span> *min</code></em>,
<em class="parameter"><code><span class="type">guint64</span> *max</code></em>);</pre>
<p>
Retrieve the min and max latencies in <em class="parameter"><code>min</code></em> and <em class="parameter"><code>max</code></em> respectively.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
<td>the min latency</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>the min latency</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-set-latency"></a><h3>gst_app_src_set_latency ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_set_latency (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">guint64</span> min</code></em>,
<em class="parameter"><code><span class="type">guint64</span> max</code></em>);</pre>
<p>
Configure the <em class="parameter"><code>min</code></em> and <em class="parameter"><code>max</code></em> latency in <em class="parameter"><code>src</code></em>. If <em class="parameter"><code>min</code></em> is set to -1, the
default latency calculations for pseudo-live sources will be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
<td>the min latency</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>the min latency</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-set-size"></a><h3>gst_app_src_set_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_set_size (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">gint64</span> size</code></em>);</pre>
<p>
Set the size of the stream in bytes. A value of -1 means that the size is
not known.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>the size to set</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-get-size"></a><h3>gst_app_src_get_size ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span> gst_app_src_get_size (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);</pre>
<p>
Get the size of the stream in bytes. A value of -1 means that the size is
not known.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the size of the stream previously set with <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-size" title="gst_app_src_set_size ()"><code class="function">gst_app_src_set_size()</code></a>;</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-set-stream-type"></a><h3>gst_app_src_set_stream_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_set_stream_type (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType"><span class="type">GstAppStreamType</span></a> type</code></em>);</pre>
<p>
Set the stream type on <em class="parameter"><code>appsrc</code></em>. For seekable streams, the "seek" signal must
be connected to.
</p>
<p>
A stream_type stream
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the new state</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-get-stream-type"></a><h3>gst_app_src_get_stream_type ()</h3>
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType"><span class="returnvalue">GstAppStreamType</span></a> gst_app_src_get_stream_type (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);</pre>
<p>
Get the stream type. Control the stream type of <em class="parameter"><code>appsrc</code></em>
with <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-stream-type" title="gst_app_src_set_stream_type ()"><code class="function">gst_app_src_set_stream_type()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the stream type.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-set-max-bytes"></a><h3>gst_app_src_set_max_bytes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_set_max_bytes (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><span class="type">guint64</span> max</code></em>);</pre>
<p>
Set the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>.
After the maximum amount of bytes are queued, <em class="parameter"><code>appsrc</code></em> will emit the
"enough-data" signal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>the maximum number of bytes to queue</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-get-max-bytes"></a><h3>gst_app_src_get_max_bytes ()</h3>
<pre class="programlisting"><span class="returnvalue">guint64</span> gst_app_src_get_max_bytes (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);</pre>
<p>
Get the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The maximum amount of bytes that can be queued.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-get-emit-signals"></a><h3>gst_app_src_get_emit_signals ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_app_src_get_emit_signals (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);</pre>
<p>
Check if appsrc will emit the "new-preroll" and "new-buffer" signals.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>appsrc</code></em> is emitting the "new-preroll" and "new-buffer"
signals.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.23</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-set-emit-signals"></a><h3>gst_app_src_set_emit_signals ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_set_emit_signals (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> emit</code></em>);</pre>
<p>
Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is
by default disabled because signal emission is expensive and unneeded when
the application prefers to operate in pull mode.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>emit</code></em> :</span></p></td>
<td>the new state</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.23</p>
</div>
<hr>
<div class="refsect2">
<a name="GstAppSrcCallbacks"></a><h3>GstAppSrcCallbacks</h3>
<pre class="programlisting">typedef struct {
void (*need_data) (GstAppSrc *src, guint length, gpointer user_data);
void (*enough_data) (GstAppSrc *src, gpointer user_data);
gboolean (*seek_data) (GstAppSrc *src, guint64 offset, gpointer user_data);
} GstAppSrcCallbacks;
</pre>
<p>
A set of callbacks that can be installed on the appsrc with
<a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-set-callbacks" title="gst_app_src_set_callbacks ()"><code class="function">gst_app_src_set_callbacks()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.need-data"></a>need_data</code></em> ()</span></p></td>
<td>Called when the appsrc needs more data. A buffer or EOS should be
pushed to appsrc from this thread or another thread. <em class="parameter"><code>length</code></em> is just a hint
and when it is set to -1, any number of bytes can be pushed into <em class="parameter"><code>appsrc</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.enough-data"></a>enough_data</code></em> ()</span></p></td>
<td>Called when appsrc has enough data. It is recommended that the
application stops calling push-buffer until the need_data callback is
emitted again to avoid excessive buffer queueing.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.seek-data"></a>seek_data</code></em> ()</span></p></td>
<td>Called when a seek should be performed to the offset.
The next push-buffer should produce buffers from the new <em class="parameter"><code>offset</code></em>.
This callback is only called for seekable stream types.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.23</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-set-callbacks"></a><h3>gst_app_src_set_callbacks ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_app_src_set_callbacks (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrcCallbacks" title="GstAppSrcCallbacks"><span class="type">GstAppSrcCallbacks</span></a> *callbacks</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
<p>
Set callbacks which will be executed when data is needed, enough data has
been collected or when a seek should be performed.
This is an alternative to using the signals, it has lower overhead and is thus
less expensive, but also less flexible.
</p>
<p>
If callbacks are installed, no signals will be emitted for performance
reasons.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callbacks</code></em> :</span></p></td>
<td>the callbacks</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>a user_data argument for the callbacks</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
<td>a destroy notify function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.23</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-push-buffer"></a><h3>gst_app_src_push_buffer ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> gst_app_src_push_buffer (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
<p>
Adds a buffer to the queue of buffers that the appsrc element will
push to its source pad. This function takes ownership of the buffer.
</p>
<p>
When the block property is TRUE, this function can block until free
space becomes available in the queue.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> to push</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GST-FLOW-OK:CAPS"><span class="type">GST_FLOW_OK</span></a> when the buffer was successfuly queued.
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GST-FLOW-WRONG-STATE:CAPS"><span class="type">GST_FLOW_WRONG_STATE</span></a> when <em class="parameter"><code>appsrc</code></em> is not PAUSED or PLAYING.
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GST-FLOW-UNEXPECTED:CAPS"><span class="type">GST_FLOW_UNEXPECTED</span></a> when EOS occured.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-app-src-end-of-stream"></a><h3>gst_app_src_end_of_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> gst_app_src_end_of_stream (<em class="parameter"><code><span class="type">GstAppSrc</span> *appsrc</code></em>);</pre>
<p>
Indicates to the appsrc element that the last buffer queued in the
element is the last buffer of the stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
<td>a <span class="type">GstAppSrc</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GST-FLOW-OK:CAPS"><span class="type">GST_FLOW_OK</span></a> when the EOS was successfuly queued.
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstPad.html#GST-FLOW-WRONG-STATE:CAPS"><span class="type">GST_FLOW_WRONG_STATE</span></a> when <em class="parameter"><code>appsrc</code></em> is not PAUSED or PLAYING.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10.22</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-appsrc.see-also"></a><h2>See Also</h2>
<a href="/usr/share/gtk-doc/html/gstreamer-libs-0.10/GstBaseSrc.html"><span class="type">GstBaseSrc</span></a>, appsink
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|