9a234392c3eee439e5e024ce5f1a8ebdfaeffce6
[framework/multimedia/gst-plugins-base0.10.git] / docs / libs / html / gst-plugins-base-libs-appsrc.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>appsrc</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-app.html" title="App Library">
9 <link rel="prev" href="gstreamer-app.html" title="App Library">
10 <link rel="next" href="gst-plugins-base-libs-appsink.html" title="appsink">
11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gstreamer-app.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-app.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 Library Reference Manual</th>
21 <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>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-appsrc.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-libs-appsrc.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gst-plugins-base-libs-appsrc"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-appsrc.top_of_page"></a>appsrc</span></h2>
34 <p>appsrc — Easy way for applications to inject buffers into a
35     pipeline</p>
36 </td>
37 <td valign="top" align="right"></td>
38 </tr></table></div>
39 <div class="refsynopsisdiv">
40 <a name="gst-plugins-base-libs-appsrc.synopsis"></a><h2>Synopsis</h2>
41 <pre class="synopsis">
42 #include &lt;gst/app/gstappsrc.h&gt;
43
44 struct              <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc">GstAppSrc</a>;
45 enum                <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType">GstAppStreamType</a>;
46 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
47                                                          <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
48 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
49 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
50                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *min</code></em>,
51                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *max</code></em>);
52 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
53                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> min</code></em>,
54                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> max</code></em>);
55 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
56                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> size</code></em>);
57 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
58 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
59                                                          <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>);
60 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
61 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
62                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> max</code></em>);
63 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a>             <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
64 <a href="http://library.gnome.org/devel/glib/unstable/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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
65 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
66                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> emit</code></em>);
67                     <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrcCallbacks" title="GstAppSrcCallbacks">GstAppSrcCallbacks</a>;
68 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
69                                                          <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>,
70                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
71                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
72 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
73                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);
74 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
75 </pre>
76 </div>
77 <div class="refsect1">
78 <a name="gst-plugins-base-libs-appsrc.description"></a><h2>Description</h2>
79 <p>
80 The appsrc element can be used by applications to insert data into a
81 GStreamer pipeline. Unlike most GStreamer elements, Appsrc provides
82 external API functions.
83 </p>
84 <p>
85 appsrc can be used by linking with the libgstapp library to access the
86 methods directly or by using the appsrc action signals.
87 </p>
88 <p>
89 Before operating appsrc, the caps property must be set to a fixed caps
90 describing the format of the data that will be pushed with appsrc. An
91 exception to this is when pushing buffers with unknown caps, in which case no
92 caps should be set. This is typically true of file-like sources that push raw
93 byte buffers.
94 </p>
95 <p>
96 The main way of handing data to the appsrc element is by calling the
97 <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 emiting the push-buffer action signal.
98 This will put the buffer onto a queue from which appsrc will read from in its
99 streaming thread. It is important to note that data transport will not happen
100 from the thread that performed the push-buffer call.
101 </p>
102 <p>
103 The "max-bytes" property controls how much data can be queued in appsrc
104 before appsrc considers the queue full. A filled internal queue will always
105 signal the "enough-data" signal, which signals the application that it should
106 stop pushing data into appsrc. The "block" property will cause appsrc to
107 block the push-buffer method until free data becomes available again.
108 </p>
109 <p>
110 When the internal queue is running out of data, the "need-data" signal is
111 emited, which signals the application that it should start pushing more data
112 into appsrc.
113 </p>
114 <p>
115 In addition to the "need-data" and "enough-data" signals, appsrc can emit the
116 "seek-data" signal when the "stream-mode" property is set to "seekable" or
117 "random-access". The signal argument will contain the new desired position in
118 the stream expressed in the unit set with the "format" property. After
119 receiving the seek-data signal, the application should push-buffers from the
120 new position.
121 </p>
122 <p>
123 These signals allow the application to operate the appsrc in two different
124 ways:
125 </p>
126 <p>
127 The push model, in which the application repeadedly calls the push-buffer method
128 with a new buffer. Optionally, the queue size in the appsrc can be controlled
129 with the enough-data and need-data signals by respectively stopping/starting
130 the push-buffer calls. This is a typical mode of operation for the
131 stream-type "stream" and "seekable". Use this model when implementing various
132 network protocols or hardware devices.
133 </p>
134 <p>
135 The pull model where the need-data signal triggers the next push-buffer call.
136 This mode is typically used in the "random-access" stream-type. Use this
137 model for file access or other randomly accessable sources. In this mode, a
138 buffer of exactly the amount of bytes given by the need-data signal should be
139 pushed into appsrc.
140 </p>
141 <p>
142 In all modes, the size property on appsrc should contain the total stream
143 size in bytes. Setting this property is mandatory in the random-access mode.
144 For the stream and seekable modes, setting this property is optional but
145 recommended.
146 </p>
147 <p>
148 When the application is finished pushing data into appsrc, it should call 
149 <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
150 this call, no more buffers can be pushed into appsrc until a flushing seek
151 happened or the state of the appsrc has gone through READY.
152 </p>
153 <p>
154 Last reviewed on 2008-12-17 (0.10.10)
155 </p>
156 </div>
157 <div class="refsect1">
158 <a name="gst-plugins-base-libs-appsrc.details"></a><h2>Details</h2>
159 <div class="refsect2">
160 <a name="GstAppSrc"></a><h3>struct GstAppSrc</h3>
161 <pre class="programlisting">struct GstAppSrc {
162   GstBaseSrc basesrc;
163 };
164 </pre>
165 </div>
166 <hr>
167 <div class="refsect2">
168 <a name="GstAppStreamType"></a><h3>enum GstAppStreamType</h3>
169 <pre class="programlisting">typedef enum
170 {
171   GST_APP_STREAM_TYPE_STREAM,
172   GST_APP_STREAM_TYPE_SEEKABLE,
173   GST_APP_STREAM_TYPE_RANDOM_ACCESS
174 } GstAppStreamType;
175 </pre>
176 <p>
177 The stream type.
178 </p>
179 <div class="variablelist"><table border="0">
180 <col align="left" valign="top">
181 <tbody>
182 <tr>
183 <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>
184 <td>No seeking is supported in the stream, such as a
185 live stream.
186 </td>
187 </tr>
188 <tr>
189 <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>
190 <td>The stream is seekable but seeking might not
191 be very fast, such as data from a webserver. 
192 </td>
193 </tr>
194 <tr>
195 <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>
196 <td>The stream is seekable and seeking is fast,
197 such as in a local file.
198 </td>
199 </tr>
200 </tbody>
201 </table></div>
202 </div>
203 <hr>
204 <div class="refsect2">
205 <a name="gst-app-src-set-caps"></a><h3>gst_app_src_set_caps ()</h3>
206 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_caps                (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
207                                                          <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
208 <p>
209 Set the capabilities on the appsrc element.  This function takes
210 a copy of the caps structure. After calling this method, the source will
211 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
212 buffers must match the caps or left NULL.
213 </p>
214 <div class="variablelist"><table border="0">
215 <col align="left" valign="top">
216 <tbody>
217 <tr>
218 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
219 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
220 </td>
221 </tr>
222 <tr>
223 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
224 <td>caps to set</td>
225 </tr>
226 </tbody>
227 </table></div>
228 <p class="since">Since 0.10.22</p>
229 </div>
230 <hr>
231 <div class="refsect2">
232 <a name="gst-app-src-get-caps"></a><h3>gst_app_src_get_caps ()</h3>
233 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> *           gst_app_src_get_caps                (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
234 <p>
235 Get the configured caps on <em class="parameter"><code>appsrc</code></em>.
236 </p>
237 <div class="variablelist"><table border="0">
238 <col align="left" valign="top">
239 <tbody>
240 <tr>
241 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
242 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
243 </td>
244 </tr>
245 <tr>
246 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
247 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> produced by the source. <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#gst-caps-unref"><code class="function">gst_caps_unref()</code></a> after usage.</td>
248 </tr>
249 </tbody>
250 </table></div>
251 <p class="since">Since 0.10.22</p>
252 </div>
253 <hr>
254 <div class="refsect2">
255 <a name="gst-app-src-get-latency"></a><h3>gst_app_src_get_latency ()</h3>
256 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_get_latency             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
257                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *min</code></em>,
258                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *max</code></em>);</pre>
259 <p>
260 Retrieve the min and max latencies in <em class="parameter"><code>min</code></em> and <em class="parameter"><code>max</code></em> respectively.
261 </p>
262 <div class="variablelist"><table border="0">
263 <col align="left" valign="top">
264 <tbody>
265 <tr>
266 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
267 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
268 </td>
269 </tr>
270 <tr>
271 <td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
272 <td>the min latency</td>
273 </tr>
274 <tr>
275 <td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
276 <td>the min latency</td>
277 </tr>
278 </tbody>
279 </table></div>
280 <p class="since">Since 0.10.22</p>
281 </div>
282 <hr>
283 <div class="refsect2">
284 <a name="gst-app-src-set-latency"></a><h3>gst_app_src_set_latency ()</h3>
285 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_latency             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
286                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> min</code></em>,
287                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> max</code></em>);</pre>
288 <p>
289 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
290 default latency calculations for pseudo-live sources will be used.
291 </p>
292 <div class="variablelist"><table border="0">
293 <col align="left" valign="top">
294 <tbody>
295 <tr>
296 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
297 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
298 </td>
299 </tr>
300 <tr>
301 <td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
302 <td>the min latency</td>
303 </tr>
304 <tr>
305 <td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
306 <td>the min latency</td>
307 </tr>
308 </tbody>
309 </table></div>
310 <p class="since">Since 0.10.22</p>
311 </div>
312 <hr>
313 <div class="refsect2">
314 <a name="gst-app-src-set-size"></a><h3>gst_app_src_set_size ()</h3>
315 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_size                (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
316                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> size</code></em>);</pre>
317 <p>
318 Set the size of the stream in bytes. A value of -1 means that the size is
319 not known.
320 </p>
321 <div class="variablelist"><table border="0">
322 <col align="left" valign="top">
323 <tbody>
324 <tr>
325 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
326 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
327 </td>
328 </tr>
329 <tr>
330 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
331 <td>the size to set</td>
332 </tr>
333 </tbody>
334 </table></div>
335 <p class="since">Since 0.10.22</p>
336 </div>
337 <hr>
338 <div class="refsect2">
339 <a name="gst-app-src-get-size"></a><h3>gst_app_src_get_size ()</h3>
340 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              gst_app_src_get_size                (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
341 <p>
342 Get the size of the stream in bytes. A value of -1 means that the size is
343 not known.
344 </p>
345 <div class="variablelist"><table border="0">
346 <col align="left" valign="top">
347 <tbody>
348 <tr>
349 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
350 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
351 </td>
352 </tr>
353 <tr>
354 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
355 <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>
356 </tr>
357 </tbody>
358 </table></div>
359 <p class="since">Since 0.10.22</p>
360 </div>
361 <hr>
362 <div class="refsect2">
363 <a name="gst-app-src-set-stream-type"></a><h3>gst_app_src_set_stream_type ()</h3>
364 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_stream_type         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
365                                                          <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>
366 <p>
367 Set the stream type on <em class="parameter"><code>appsrc</code></em>. For seekable streams, the "seek" signal must
368 be connected to.
369 </p>
370 <p>
371 A stream_type stream
372 </p>
373 <div class="variablelist"><table border="0">
374 <col align="left" valign="top">
375 <tbody>
376 <tr>
377 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
378 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
379 </td>
380 </tr>
381 <tr>
382 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
383 <td>the new state</td>
384 </tr>
385 </tbody>
386 </table></div>
387 <p class="since">Since 0.10.22</p>
388 </div>
389 <hr>
390 <div class="refsect2">
391 <a name="gst-app-src-get-stream-type"></a><h3>gst_app_src_get_stream_type ()</h3>
392 <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><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
393 <p>
394 Get the stream type. Control the stream type of <em class="parameter"><code>appsrc</code></em>
395 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>.
396 </p>
397 <div class="variablelist"><table border="0">
398 <col align="left" valign="top">
399 <tbody>
400 <tr>
401 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
402 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
403 </td>
404 </tr>
405 <tr>
406 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
407 <td>the stream type.</td>
408 </tr>
409 </tbody>
410 </table></div>
411 <p class="since">Since 0.10.22</p>
412 </div>
413 <hr>
414 <div class="refsect2">
415 <a name="gst-app-src-set-max-bytes"></a><h3>gst_app_src_set_max_bytes ()</h3>
416 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_max_bytes           (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
417                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> max</code></em>);</pre>
418 <p>
419 Set the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>.
420 After the maximum amount of bytes are queued, <em class="parameter"><code>appsrc</code></em> will emit the
421 "enough-data" signal.
422 </p>
423 <div class="variablelist"><table border="0">
424 <col align="left" valign="top">
425 <tbody>
426 <tr>
427 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
428 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
429 </td>
430 </tr>
431 <tr>
432 <td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
433 <td>the maximum number of bytes to queue</td>
434 </tr>
435 </tbody>
436 </table></div>
437 <p class="since">Since 0.10.22</p>
438 </div>
439 <hr>
440 <div class="refsect2">
441 <a name="gst-app-src-get-max-bytes"></a><h3>gst_app_src_get_max_bytes ()</h3>
442 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a>             gst_app_src_get_max_bytes           (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
443 <p>
444 Get the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>.
445 </p>
446 <div class="variablelist"><table border="0">
447 <col align="left" valign="top">
448 <tbody>
449 <tr>
450 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
451 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
452 </td>
453 </tr>
454 <tr>
455 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
456 <td>The maximum amount of bytes that can be queued.</td>
457 </tr>
458 </tbody>
459 </table></div>
460 <p class="since">Since 0.10.22</p>
461 </div>
462 <hr>
463 <div class="refsect2">
464 <a name="gst-app-src-get-emit-signals"></a><h3>gst_app_src_get_emit_signals ()</h3>
465 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_app_src_get_emit_signals        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
466 <p>
467 Check if appsrc will emit the "new-preroll" and "new-buffer" signals.
468 </p>
469 <div class="variablelist"><table border="0">
470 <col align="left" valign="top">
471 <tbody>
472 <tr>
473 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
474 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
475 </td>
476 </tr>
477 <tr>
478 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
479 <td>
480 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>appsrc</code></em> is emiting the "new-preroll" and "new-buffer"
481 signals.</td>
482 </tr>
483 </tbody>
484 </table></div>
485 <p class="since">Since 0.10.23</p>
486 </div>
487 <hr>
488 <div class="refsect2">
489 <a name="gst-app-src-set-emit-signals"></a><h3>gst_app_src_set_emit_signals ()</h3>
490 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_emit_signals        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
491                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> emit</code></em>);</pre>
492 <p>
493 Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is
494 by default disabled because signal emission is expensive and unneeded when
495 the application prefers to operate in pull mode.
496 </p>
497 <div class="variablelist"><table border="0">
498 <col align="left" valign="top">
499 <tbody>
500 <tr>
501 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
502 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
503 </td>
504 </tr>
505 <tr>
506 <td><p><span class="term"><em class="parameter"><code>emit</code></em> :</span></p></td>
507 <td>the new state</td>
508 </tr>
509 </tbody>
510 </table></div>
511 <p class="since">Since 0.10.23</p>
512 </div>
513 <hr>
514 <div class="refsect2">
515 <a name="GstAppSrcCallbacks"></a><h3>GstAppSrcCallbacks</h3>
516 <pre class="programlisting">typedef struct {
517   void      (*need_data)    (GstAppSrc *src, guint length, gpointer user_data);
518   void      (*enough_data)  (GstAppSrc *src, gpointer user_data);
519   gboolean  (*seek_data)    (GstAppSrc *src, guint64 offset, gpointer user_data);
520 } GstAppSrcCallbacks;
521 </pre>
522 <p>
523 A set of callbacks that can be installed on the appsrc with
524 <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>.
525 </p>
526 <div class="variablelist"><table border="0">
527 <col align="left" valign="top">
528 <tbody>
529 <tr>
530 <td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.need-data"></a>need_data</code></em> ()</span></p></td>
531 <td>Called when the appsrc needs more data. A buffer or EOS should be
532 pushed to appsrc from this thread or another thread. <em class="parameter"><code>length</code></em> is just a hint
533 and when it is set to -1, any number of bytes can be pushed into <em class="parameter"><code>appsrc</code></em>.</td>
534 </tr>
535 <tr>
536 <td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.enough-data"></a>enough_data</code></em> ()</span></p></td>
537 <td>Called when appsrc has enough data. It is recommended that the
538 application stops calling push-buffer until the need_data callback is
539 emited again to avoid excessive buffer queueing.</td>
540 </tr>
541 <tr>
542 <td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.seek-data"></a>seek_data</code></em> ()</span></p></td>
543 <td>Called when a seek should be performed to the offset.
544 The next push-buffer should produce buffers from the new <em class="parameter"><code>offset</code></em>.
545 This callback is only called for seekable stream types.</td>
546 </tr>
547 </tbody>
548 </table></div>
549 <p class="since">Since 0.10.23</p>
550 </div>
551 <hr>
552 <div class="refsect2">
553 <a name="gst-app-src-set-callbacks"></a><h3>gst_app_src_set_callbacks ()</h3>
554 <pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_callbacks           (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
555                                                          <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>,
556                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
557                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
558 <p>
559 Set callbacks which will be executed when data is needed, enough data has
560 been collected or when a seek should be performed.
561 This is an alternative to using the signals, it has lower overhead and is thus
562 less expensive, but also less flexible.
563 </p>
564 <p>
565 If callbacks are installed, no signals will be emited for performance
566 reasons.
567 </p>
568 <div class="variablelist"><table border="0">
569 <col align="left" valign="top">
570 <tbody>
571 <tr>
572 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
573 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
574 </td>
575 </tr>
576 <tr>
577 <td><p><span class="term"><em class="parameter"><code>callbacks</code></em> :</span></p></td>
578 <td>the callbacks</td>
579 </tr>
580 <tr>
581 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
582 <td>a user_data argument for the callbacks</td>
583 </tr>
584 <tr>
585 <td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
586 <td>a destroy notify function</td>
587 </tr>
588 </tbody>
589 </table></div>
590 <p class="since">Since 0.10.23</p>
591 </div>
592 <hr>
593 <div class="refsect2">
594 <a name="gst-app-src-push-buffer"></a><h3>gst_app_src_push_buffer ()</h3>
595 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>       gst_app_src_push_buffer             (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
596                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
597 <p>
598 Adds a buffer to the queue of buffers that the appsrc element will
599 push to its source pad.  This function takes ownership of the buffer.
600 </p>
601 <p>
602 When the block property is TRUE, this function can block until free
603 space becomes available in the queue.
604 </p>
605 <div class="variablelist"><table border="0">
606 <col align="left" valign="top">
607 <tbody>
608 <tr>
609 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
610 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
611 </td>
612 </tr>
613 <tr>
614 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
615 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> to push</td>
616 </tr>
617 <tr>
618 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
619 <td>
620 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-OK:CAPS"><span class="type">GST_FLOW_OK</span></a> when the buffer was successfuly queued.
621 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/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.
622 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-UNEXPECTED:CAPS"><span class="type">GST_FLOW_UNEXPECTED</span></a> when EOS occured.</td>
623 </tr>
624 </tbody>
625 </table></div>
626 <p class="since">Since 0.10.22</p>
627 </div>
628 <hr>
629 <div class="refsect2">
630 <a name="gst-app-src-end-of-stream"></a><h3>gst_app_src_end_of_stream ()</h3>
631 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>       gst_app_src_end_of_stream           (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
632 <p>
633 Indicates to the appsrc element that the last buffer queued in the
634 element is the last buffer of the stream.
635 </p>
636 <div class="variablelist"><table border="0">
637 <col align="left" valign="top">
638 <tbody>
639 <tr>
640 <td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
641 <td>a <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrc" title="struct GstAppSrc"><span class="type">GstAppSrc</span></a>
642 </td>
643 </tr>
644 <tr>
645 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
646 <td>
647 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-OK:CAPS"><span class="type">GST_FLOW_OK</span></a> when the EOS was successfuly queued.
648 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/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>
649 </tr>
650 </tbody>
651 </table></div>
652 <p class="since">Since 0.10.22</p>
653 </div>
654 </div>
655 <div class="refsect1">
656 <a name="gst-plugins-base-libs-appsrc.see-also"></a><h2>See Also</h2>
657 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html"><span class="type">GstBaseSrc</span></a>, appsink
658 </div>
659 </div>
660 <div class="footer">
661 <hr>
662           Generated by GTK-Doc V1.17</div>
663 </body>
664 </html>