1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
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-adder.html" title="adder">
10 <link rel="next" href="gst-plugins-base-plugins-appsink.html" title="appsink">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="gst-plugins-base-plugins-adder.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-appsink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-plugins-appsrc.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-plugins-appsrc.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-base-plugins-appsrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-base-plugins-appsrc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#gst-plugins-base-plugins-appsrc.properties" class="shortcut">Properties</a>
34 <a href="#gst-plugins-base-plugins-appsrc.signals" class="shortcut">Signals</a>
37 <div class="refentry">
38 <a name="gst-plugins-base-plugins-appsrc"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
41 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-appsrc.top_of_page"></a>appsrc</span></h2>
42 <p>appsrc — Allow the application to feed buffers to a pipeline</p>
44 <td valign="top" align="right"></td>
46 <div class="refsynopsisdiv">
47 <a name="gst-plugins-base-plugins-appsrc.synopsis"></a><h2>Synopsis</h2>
48 <a name="GstAppSrc"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc-struct" title="struct GstAppSrc">GstAppSrc</a>;
51 <div class="refsect1">
52 <a name="gst-plugins-base-plugins-appsrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
53 <pre class="synopsis">
54 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
55 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
56 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
57 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
61 <div class="refsect1">
62 <a name="gst-plugins-base-plugins-appsrc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
65 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
67 <div class="refsect1">
68 <a name="gst-plugins-base-plugins-appsrc.properties"></a><h2>Properties</h2>
69 <pre class="synopsis">
70 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--block" title='The "block" property'>block</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-appsrc.html#GstAppSrc--caps" title='The "caps" property'>caps</a>" <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>* : Read / Write
72 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--format" title='The "format" property'>format</a>" <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> : Read / Write
73 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--is-live" title='The "is-live" property'>is-live</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
74 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--max-bytes" title='The "max-bytes" property'>max-bytes</a>" <span class="type">guint64</span> : Read / Write
75 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--max-latency" title='The "max-latency" property'>max-latency</a>" <span class="type">gint64</span> : Read / Write
76 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--min-latency" title='The "min-latency" property'>min-latency</a>" <span class="type">gint64</span> : Read / Write
77 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--size" title='The "size" property'>size</a>" <span class="type">gint64</span> : Read / Write
78 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--stream-type" title='The "stream-type" property'>stream-type</a>" <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-appsrc.html#GstAppStreamType"><span class="type">GstAppStreamType</span></a> : Read / Write
79 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--emit-signals" title='The "emit-signals" property'>emit-signals</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
80 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc--min-percent" title='The "min-percent" property'>min-percent</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
83 <div class="refsect1">
84 <a name="gst-plugins-base-plugins-appsrc.signals"></a><h2>Signals</h2>
85 <pre class="synopsis">
86 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc-end-of-stream" title='The "end-of-stream" signal'>end-of-stream</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
87 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc-enough-data" title='The "enough-data" signal'>enough-data</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
88 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc-need-data" title='The "need-data" signal'>need-data</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
89 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc-push-buffer" title='The "push-buffer" signal'>push-buffer</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
90 "<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc-seek-data" title='The "seek-data" signal'>seek-data</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
93 <div class="refsect1">
94 <a name="gst-plugins-base-plugins-appsrc.description"></a><h2>Description</h2>
96 The appsrc element can be used by applications to insert data into a
97 GStreamer pipeline. Unlike most GStreamer elements, Appsrc provides
98 external API functions.
101 For the documentation of the API, please see the
102 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-appsrc.html">libgstapp</a> section in the
103 GStreamer Plugins Base Libraries documentation.
105 <div class="refsynopsisdiv">
107 <div class="refsect2">
108 <a name="idp8801728"></a><h3>Element Information</h3>
109 <div class="variablelist"><table border="0">
110 <col align="left" valign="top">
113 <td><p><span class="term">plugin</span></p></td>
115 <a class="link" href="gst-plugins-base-plugins-plugin-app.html#plugin-app">app</a>
119 <td><p><span class="term">author</span></p></td>
120 <td>David Schleef <ds@schleef.org>, Wim Taymans <wim.taymans@gmail.com></td>
123 <td><p><span class="term">class</span></p></td>
124 <td>Generic/Source</td>
130 <div class="refsect2">
131 <a name="idp8809136"></a><h3>Element Pads</h3>
132 <div class="variablelist"><table border="0">
133 <col align="left" valign="top">
136 <td><p><span class="term">name</span></p></td>
140 <td><p><span class="term">direction</span></p></td>
144 <td><p><span class="term">presence</span></p></td>
148 <td><p><span class="term">details</span></p></td>
158 <div class="refsect1">
159 <a name="gst-plugins-base-plugins-appsrc.details"></a><h2>Details</h2>
160 <div class="refsect2">
161 <a name="GstAppSrc-struct"></a><h3>struct GstAppSrc</h3>
162 <pre class="programlisting">struct GstAppSrc;</pre>
167 <div class="refsect1">
168 <a name="gst-plugins-base-plugins-appsrc.property-details"></a><h2>Property Details</h2>
169 <div class="refsect2">
170 <a name="GstAppSrc--block"></a><h3>The <code class="literal">"block"</code> property</h3>
171 <pre class="programlisting"> "block" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
172 <p>Block push-buffer when max-bytes are queued.</p>
173 <p>Default value: FALSE</p>
176 <div class="refsect2">
177 <a name="GstAppSrc--caps"></a><h3>The <code class="literal">"caps"</code> property</h3>
178 <pre class="programlisting"> "caps" <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>* : Read / Write</pre>
179 <p>The allowed caps for the src pad.</p>
182 <div class="refsect2">
183 <a name="GstAppSrc--format"></a><h3>The <code class="literal">"format"</code> property</h3>
184 <pre class="programlisting"> "format" <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> : Read / Write</pre>
185 <p>The format of the segment events and seek.</p>
186 <p>Default value: GST_FORMAT_BYTES</p>
189 <div class="refsect2">
190 <a name="GstAppSrc--is-live"></a><h3>The <code class="literal">"is-live"</code> property</h3>
191 <pre class="programlisting"> "is-live" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
192 <p>Whether to act as a live source.</p>
193 <p>Default value: FALSE</p>
196 <div class="refsect2">
197 <a name="GstAppSrc--max-bytes"></a><h3>The <code class="literal">"max-bytes"</code> property</h3>
198 <pre class="programlisting"> "max-bytes" <span class="type">guint64</span> : Read / Write</pre>
199 <p>The maximum number of bytes to queue internally (0 = unlimited).</p>
200 <p>Default value: 200000</p>
203 <div class="refsect2">
204 <a name="GstAppSrc--max-latency"></a><h3>The <code class="literal">"max-latency"</code> property</h3>
205 <pre class="programlisting"> "max-latency" <span class="type">gint64</span> : Read / Write</pre>
206 <p>The maximum latency (-1 = unlimited).</p>
207 <p>Allowed values: >= G_MAXULONG</p>
208 <p>Default value: -1</p>
211 <div class="refsect2">
212 <a name="GstAppSrc--min-latency"></a><h3>The <code class="literal">"min-latency"</code> property</h3>
213 <pre class="programlisting"> "min-latency" <span class="type">gint64</span> : Read / Write</pre>
214 <p>The minimum latency (-1 = default).</p>
215 <p>Allowed values: >= G_MAXULONG</p>
216 <p>Default value: -1</p>
219 <div class="refsect2">
220 <a name="GstAppSrc--size"></a><h3>The <code class="literal">"size"</code> property</h3>
221 <pre class="programlisting"> "size" <span class="type">gint64</span> : Read / Write</pre>
222 <p>The size of the data stream in bytes (-1 if unknown).</p>
223 <p>Allowed values: >= G_MAXULONG</p>
224 <p>Default value: -1</p>
227 <div class="refsect2">
228 <a name="GstAppSrc--stream-type"></a><h3>The <code class="literal">"stream-type"</code> property</h3>
229 <pre class="programlisting"> "stream-type" <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-appsrc.html#GstAppStreamType"><span class="type">GstAppStreamType</span></a> : Read / Write</pre>
230 <p>the type of the stream.</p>
231 <p>Default value: GST_APP_STREAM_TYPE_STREAM</p>
234 <div class="refsect2">
235 <a name="GstAppSrc--emit-signals"></a><h3>The <code class="literal">"emit-signals"</code> property</h3>
236 <pre class="programlisting"> "emit-signals" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
237 <p>Emit need-data, enough-data and seek-data signals.</p>
238 <p>Default value: TRUE</p>
241 <div class="refsect2">
242 <a name="GstAppSrc--min-percent"></a><h3>The <code class="literal">"min-percent"</code> property</h3>
243 <pre class="programlisting"> "min-percent" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
244 <p>Emit need-data when queued bytes drops below this percent of max-bytes.</p>
245 <p>Allowed values: <= 100</p>
246 <p>Default value: 0</p>
249 <div class="refsect1">
250 <a name="gst-plugins-base-plugins-appsrc.signal-details"></a><h2>Signal Details</h2>
251 <div class="refsect2">
252 <a name="GstAppSrc-end-of-stream"></a><h3>The <code class="literal">"end-of-stream"</code> signal</h3>
253 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> user_function (<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *gstappsrc,
254 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
257 <div class="variablelist"><table border="0">
258 <col align="left" valign="top">
261 <td><p><span class="term"><em class="parameter"><code>gstappsrc</code></em> :</span></p></td>
262 <td>the object which received the signal.</td>
265 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
266 <td>user data set when the signal handler was connected.</td>
272 <div class="refsect2">
273 <a name="GstAppSrc-enough-data"></a><h3>The <code class="literal">"enough-data"</code> signal</h3>
274 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *gstappsrc,
275 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
278 <div class="variablelist"><table border="0">
279 <col align="left" valign="top">
282 <td><p><span class="term"><em class="parameter"><code>gstappsrc</code></em> :</span></p></td>
283 <td>the object which received the signal.</td>
286 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
287 <td>user data set when the signal handler was connected.</td>
293 <div class="refsect2">
294 <a name="GstAppSrc-need-data"></a><h3>The <code class="literal">"need-data"</code> signal</h3>
295 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *gstappsrc,
296 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg1,
297 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
300 <div class="variablelist"><table border="0">
301 <col align="left" valign="top">
304 <td><p><span class="term"><em class="parameter"><code>gstappsrc</code></em> :</span></p></td>
305 <td>the object which received the signal.</td>
308 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
309 <td>user data set when the signal handler was connected.</td>
315 <div class="refsect2">
316 <a name="GstAppSrc-push-buffer"></a><h3>The <code class="literal">"push-buffer"</code> signal</h3>
317 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> user_function (<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *gstappsrc,
318 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *arg1,
319 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
322 <div class="variablelist"><table border="0">
323 <col align="left" valign="top">
326 <td><p><span class="term"><em class="parameter"><code>gstappsrc</code></em> :</span></p></td>
327 <td>the object which received the signal.</td>
330 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
331 <td>user data set when the signal handler was connected.</td>
337 <div class="refsect2">
338 <a name="GstAppSrc-seek-data"></a><h3>The <code class="literal">"seek-data"</code> signal</h3>
339 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> user_function (<a class="link" href="gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *gstappsrc,
340 <span class="type">guint64</span> arg1,
341 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
344 <div class="variablelist"><table border="0">
345 <col align="left" valign="top">
348 <td><p><span class="term"><em class="parameter"><code>gstappsrc</code></em> :</span></p></td>
349 <td>the object which received the signal.</td>
352 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
353 <td>user data set when the signal handler was connected.</td>
362 Generated by GTK-Doc V1.18</div>