~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-appsrc.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>appsrc</title>
 
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: appsrc</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
8
8
<link rel="up" href="gstreamer-app.html" title="App Library">
9
9
<link rel="prev" href="gstreamer-app.html" title="App Library">
10
10
<link rel="next" href="gst-plugins-base-libs-appsink.html" title="appsink">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
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 1.0 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>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#gst-plugins-base-libs-appsrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-libs-appsrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="gstreamer-app.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="gstreamer-app.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="gst-plugins-base-libs-appsink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
29
26
<div class="refentry">
30
27
<a name="gst-plugins-base-libs-appsrc"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
34
31
<p>appsrc — Easy way for applications to inject buffers into a
35
32
    pipeline</p>
36
33
</td>
37
 
<td valign="top" align="right"></td>
 
34
<td class="gallery_image" valign="top" align="right"></td>
38
35
</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
 
enum                <a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType">GstAppStreamType</a>;
45
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
46
 
                                                         <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>);
47
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
48
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
49
 
                                                         <em class="parameter"><code><span class="type">guint64</span> *min</code></em>,
50
 
                                                         <em class="parameter"><code><span class="type">guint64</span> *max</code></em>);
51
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
52
 
                                                         <em class="parameter"><code><span class="type">guint64</span> min</code></em>,
53
 
                                                         <em class="parameter"><code><span class="type">guint64</span> max</code></em>);
54
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">gint64</span> size</code></em>);
56
 
<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><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
57
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
58
 
                                                         <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>);
59
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
60
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
61
 
                                                         <em class="parameter"><code><span class="type">guint64</span> max</code></em>);
62
 
<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><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
63
 
<span class="returnvalue">guint64</span>             <a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-current-level-bytes" title="gst_app_src_get_current_level_bytes ()">gst_app_src_get_current_level_bytes</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);
 
36
<div class="refsect1">
 
37
<a name="gst-plugins-base-libs-appsrc.functions"></a><h2>Functions</h2>
 
38
<div class="informaltable"><table width="100%" border="0">
 
39
<colgroup>
 
40
<col width="150px" class="functions_return">
 
41
<col class="functions_name">
 
42
</colgroup>
 
43
<tbody>
 
44
<tr>
 
45
<td class="function_type">
 
46
<span class="returnvalue">void</span>
 
47
</td>
 
48
<td class="function_name">
 
49
<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> <span class="c_punctuation">()</span>
 
50
</td>
 
51
</tr>
 
52
<tr>
 
53
<td class="function_type">
 
54
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> *
 
55
</td>
 
56
<td class="function_name">
 
57
<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> <span class="c_punctuation">()</span>
 
58
</td>
 
59
</tr>
 
60
<tr>
 
61
<td class="function_type">
 
62
<span class="returnvalue">void</span>
 
63
</td>
 
64
<td class="function_name">
 
65
<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> <span class="c_punctuation">()</span>
 
66
</td>
 
67
</tr>
 
68
<tr>
 
69
<td class="function_type">
 
70
<span class="returnvalue">void</span>
 
71
</td>
 
72
<td class="function_name">
 
73
<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> <span class="c_punctuation">()</span>
 
74
</td>
 
75
</tr>
 
76
<tr>
 
77
<td class="function_type">
 
78
<span class="returnvalue">void</span>
 
79
</td>
 
80
<td class="function_name">
 
81
<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> <span class="c_punctuation">()</span>
 
82
</td>
 
83
</tr>
 
84
<tr>
 
85
<td class="function_type">
 
86
<span class="returnvalue">gint64</span>
 
87
</td>
 
88
<td class="function_name">
 
89
<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> <span class="c_punctuation">()</span>
 
90
</td>
 
91
</tr>
 
92
<tr>
 
93
<td class="function_type">
 
94
<span class="returnvalue">void</span>
 
95
</td>
 
96
<td class="function_name">
 
97
<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> <span class="c_punctuation">()</span>
 
98
</td>
 
99
</tr>
 
100
<tr>
 
101
<td class="function_type">
 
102
<a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType"><span class="returnvalue">GstAppStreamType</span></a>
 
103
</td>
 
104
<td class="function_name">
 
105
<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> <span class="c_punctuation">()</span>
 
106
</td>
 
107
</tr>
 
108
<tr>
 
109
<td class="function_type">
 
110
<span class="returnvalue">void</span>
 
111
</td>
 
112
<td class="function_name">
 
113
<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> <span class="c_punctuation">()</span>
 
114
</td>
 
115
</tr>
 
116
<tr>
 
117
<td class="function_type">
 
118
<span class="returnvalue">guint64</span>
 
119
</td>
 
120
<td class="function_name">
 
121
<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> <span class="c_punctuation">()</span>
 
122
</td>
 
123
</tr>
 
124
<tr>
 
125
<td class="function_type">
 
126
<span class="returnvalue">guint64</span>
 
127
</td>
 
128
<td class="function_name">
 
129
<a class="link" href="gst-plugins-base-libs-appsrc.html#gst-app-src-get-current-level-bytes" title="gst_app_src_get_current_level_bytes ()">gst_app_src_get_current_level_bytes</a> <span class="c_punctuation">()</span>
 
130
</td>
 
131
</tr>
 
132
<tr>
 
133
<td class="function_type">
 
134
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
135
</td>
 
136
<td class="function_name">
 
137
<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> <span class="c_punctuation">()</span>
 
138
</td>
 
139
</tr>
 
140
<tr>
 
141
<td class="function_type">
 
142
<span class="returnvalue">void</span>
 
143
</td>
 
144
<td class="function_name">
 
145
<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> <span class="c_punctuation">()</span>
 
146
</td>
 
147
</tr>
 
148
<tr>
 
149
<td class="function_type">
 
150
<span class="returnvalue">void</span>
 
151
</td>
 
152
<td class="function_name">
 
153
<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> <span class="c_punctuation">()</span>
 
154
</td>
 
155
</tr>
 
156
<tr>
 
157
<td class="function_type">
 
158
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
 
159
</td>
 
160
<td class="function_name">
 
161
<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> <span class="c_punctuation">()</span>
 
162
</td>
 
163
</tr>
 
164
<tr>
 
165
<td class="function_type">
 
166
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
 
167
</td>
 
168
<td class="function_name">
 
169
<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> <span class="c_punctuation">()</span>
 
170
</td>
 
171
</tr>
 
172
</tbody>
 
173
</table></div>
 
174
</div>
 
175
<div class="refsect1">
 
176
<a name="gst-plugins-base-libs-appsrc.other"></a><h2>Types and Values</h2>
 
177
<div class="informaltable"><table width="100%" border="0">
 
178
<colgroup>
 
179
<col width="150px" class="name">
 
180
<col class="description">
 
181
</colgroup>
 
182
<tbody>
 
183
<tr>
 
184
<td class="datatype_keyword">enum</td>
 
185
<td class="function_name"><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType">GstAppStreamType</a></td>
 
186
</tr>
 
187
<tr>
 
188
<td class="datatype_keyword"> </td>
 
189
<td class="function_name"><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppSrcCallbacks" title="GstAppSrcCallbacks">GstAppSrcCallbacks</a></td>
 
190
</tr>
 
191
</tbody>
 
192
</table></div>
 
193
</div>
 
194
<div class="refsect1">
 
195
<a name="gst-plugins-base-libs-appsrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
196
<pre class="screen">
 
197
</pre>
 
198
</div>
 
199
<div class="refsect1">
 
200
<a name="gst-plugins-base-libs-appsrc.includes"></a><h2>Includes</h2>
 
201
<pre class="synopsis">#include &lt;gst/app/gstappsrc.h&gt;
75
202
</pre>
76
203
</div>
77
204
<div class="refsect1">
78
205
<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
 
206
<p>The appsrc element can be used by applications to insert data into a
81
207
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
 
208
external API functions.</p>
 
209
<p>appsrc can be used by linking with the libgstapp library to access the
 
210
methods directly or by using the appsrc action signals.</p>
 
211
<p>Before operating appsrc, the caps property must be set to a fixed caps
90
212
describing the format of the data that will be pushed with appsrc. An
91
213
exception to this is when pushing buffers with unknown caps, in which case no
92
214
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 emitting the push-buffer action signal.
 
215
byte buffers.</p>
 
216
<p>The main way of handing data to the appsrc element is by calling the
 
217
<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.
98
218
This will put the buffer onto a queue from which appsrc will read from in its
99
219
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
 
220
from the thread that performed the push-buffer call.</p>
 
221
<p>The "max-bytes" property controls how much data can be queued in appsrc
104
222
before appsrc considers the queue full. A filled internal queue will always
105
223
signal the "enough-data" signal, which signals the application that it should
106
224
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
 
225
block the push-buffer method until free data becomes available again.</p>
 
226
<p>When the internal queue is running out of data, the "need-data" signal is
111
227
emitted, 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
 
228
into appsrc.</p>
 
229
<p>In addition to the "need-data" and "enough-data" signals, appsrc can emit the
116
230
"seek-data" signal when the "stream-mode" property is set to "seekable" or
117
231
"random-access". The signal argument will contain the new desired position in
118
232
the stream expressed in the unit set with the "format" property. After
119
233
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 repeatedly calls the push-buffer method
 
234
new position.</p>
 
235
<p>These signals allow the application to operate the appsrc in two different
 
236
ways:</p>
 
237
<p>The push model, in which the application repeatedly calls the push-buffer method
128
238
with a new buffer. Optionally, the queue size in the appsrc can be controlled
129
239
with the enough-data and need-data signals by respectively stopping/starting
130
240
the push-buffer calls. This is a typical mode of operation for the
131
241
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.
 
242
network protocols or hardware devices.</p>
 
243
<p>The pull model where the need-data signal triggers the next push-buffer call.
136
244
This mode is typically used in the "random-access" stream-type. Use this
137
245
model for file access or other randomly accessable sources. In this mode, a
138
246
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
 
247
pushed into appsrc.</p>
 
248
<p>In all modes, the size property on appsrc should contain the total stream
143
249
size in bytes. Setting this property is mandatory in the random-access mode.
144
250
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
 
251
recommended.</p>
 
252
<p>When the application is finished pushing data into appsrc, it should call
 
253
<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
254
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>
 
255
happened or the state of the appsrc has gone through READY.</p>
 
256
<p>Last reviewed on 2008-12-17 (0.10.10)</p>
156
257
</div>
157
258
<div class="refsect1">
158
 
<a name="gst-plugins-base-libs-appsrc.details"></a><h2>Details</h2>
159
 
<div class="refsect2">
160
 
<a name="GstAppStreamType"></a><h3>enum GstAppStreamType</h3>
161
 
<pre class="programlisting">typedef enum {
162
 
  GST_APP_STREAM_TYPE_STREAM,
163
 
  GST_APP_STREAM_TYPE_SEEKABLE,
164
 
  GST_APP_STREAM_TYPE_RANDOM_ACCESS
165
 
} GstAppStreamType;
166
 
</pre>
167
 
<p>
168
 
The stream type.
169
 
</p>
170
 
<div class="variablelist"><table border="0" class="variablelist">
171
 
<colgroup>
172
 
<col align="left" valign="top">
173
 
<col>
174
 
</colgroup>
175
 
<tbody>
176
 
<tr>
177
 
<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>
178
 
<td>No seeking is supported in the stream, such as a
179
 
live stream.
180
 
</td>
181
 
</tr>
182
 
<tr>
183
 
<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>
184
 
<td>The stream is seekable but seeking might not
185
 
be very fast, such as data from a webserver.
186
 
</td>
187
 
</tr>
188
 
<tr>
189
 
<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>
190
 
<td>The stream is seekable and seeking is fast,
191
 
such as in a local file.
192
 
</td>
193
 
</tr>
194
 
</tbody>
195
 
</table></div>
196
 
</div>
197
 
<hr>
198
 
<div class="refsect2">
199
 
<a name="gst-app-src-set-caps"></a><h3>gst_app_src_set_caps ()</h3>
200
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_caps                (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
201
 
                                                         <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>
202
 
<p>
203
 
Set the capabilities on the appsrc element.  This function takes
 
259
<a name="gst-plugins-base-libs-appsrc.functions_details"></a><h2>Functions</h2>
 
260
<div class="refsect2">
 
261
<a name="gst-app-src-set-caps"></a><h3>gst_app_src_set_caps ()</h3>
 
262
<pre class="programlisting"><span class="returnvalue">void</span>
 
263
gst_app_src_set_caps (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
264
                      <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>
 
265
<p>Set the capabilities on the appsrc element.  This function takes
204
266
a copy of the caps structure. After calling this method, the source will
205
 
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
206
 
buffers must match the caps or left NULL.
207
 
</p>
208
 
<div class="variablelist"><table border="0" class="variablelist">
209
 
<colgroup>
210
 
<col align="left" valign="top">
211
 
<col>
212
 
</colgroup>
213
 
<tbody>
214
 
<tr>
215
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
216
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
217
 
</td>
218
 
</tr>
219
 
<tr>
220
 
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
221
 
<td>caps to set</td>
222
 
</tr>
223
 
</tbody>
224
 
</table></div>
225
 
</div>
226
 
<hr>
227
 
<div class="refsect2">
228
 
<a name="gst-app-src-get-caps"></a><h3>gst_app_src_get_caps ()</h3>
229
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
230
 
<p>
231
 
Get the configured caps on <em class="parameter"><code>appsrc</code></em>.
232
 
</p>
233
 
<div class="variablelist"><table border="0" class="variablelist">
234
 
<colgroup>
235
 
<col align="left" valign="top">
236
 
<col>
237
 
</colgroup>
238
 
<tbody>
239
 
<tr>
240
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
241
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
242
 
</td>
243
 
</tr>
244
 
<tr>
245
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
246
 
<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>
247
 
</tr>
248
 
</tbody>
249
 
</table></div>
250
 
</div>
251
 
<hr>
252
 
<div class="refsect2">
253
 
<a name="gst-app-src-get-latency"></a><h3>gst_app_src_get_latency ()</h3>
254
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_get_latency             (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
255
 
                                                         <em class="parameter"><code><span class="type">guint64</span> *min</code></em>,
256
 
                                                         <em class="parameter"><code><span class="type">guint64</span> *max</code></em>);</pre>
257
 
<p>
258
 
Retrieve the min and max latencies in <em class="parameter"><code>min</code></em> and <em class="parameter"><code>max</code></em> respectively.
259
 
</p>
260
 
<div class="variablelist"><table border="0" class="variablelist">
261
 
<colgroup>
262
 
<col align="left" valign="top">
263
 
<col>
264
 
</colgroup>
265
 
<tbody>
266
 
<tr>
267
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
268
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
269
 
</td>
270
 
</tr>
271
 
<tr>
272
 
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
273
 
<td>the min latency</td>
274
 
</tr>
275
 
<tr>
276
 
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
277
 
<td>the min latency</td>
278
 
</tr>
279
 
</tbody>
280
 
</table></div>
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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
286
 
                                                         <em class="parameter"><code><span class="type">guint64</span> min</code></em>,
287
 
                                                         <em class="parameter"><code><span class="type">guint64</span> 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" class="variablelist">
293
 
<colgroup>
294
 
<col align="left" valign="top">
295
 
<col>
296
 
</colgroup>
297
 
<tbody>
298
 
<tr>
299
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
300
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
301
 
</td>
302
 
</tr>
303
 
<tr>
304
 
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
305
 
<td>the min latency</td>
306
 
</tr>
307
 
<tr>
308
 
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
309
 
<td>the min latency</td>
310
 
</tr>
311
 
</tbody>
312
 
</table></div>
313
 
</div>
314
 
<hr>
315
 
<div class="refsect2">
316
 
<a name="gst-app-src-set-size"></a><h3>gst_app_src_set_size ()</h3>
317
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_size                (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
318
 
                                                         <em class="parameter"><code><span class="type">gint64</span> size</code></em>);</pre>
319
 
<p>
320
 
Set the size of the stream in bytes. A value of -1 means that the size is
321
 
not known.
322
 
</p>
323
 
<div class="variablelist"><table border="0" class="variablelist">
324
 
<colgroup>
325
 
<col align="left" valign="top">
326
 
<col>
327
 
</colgroup>
328
 
<tbody>
329
 
<tr>
330
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
331
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
332
 
</td>
333
 
</tr>
334
 
<tr>
335
 
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
336
 
<td>the size to set</td>
337
 
</tr>
338
 
</tbody>
339
 
</table></div>
340
 
</div>
341
 
<hr>
342
 
<div class="refsect2">
343
 
<a name="gst-app-src-get-size"></a><h3>gst_app_src_get_size ()</h3>
344
 
<pre class="programlisting"><span class="returnvalue">gint64</span>              gst_app_src_get_size                (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
345
 
<p>
346
 
Get the size of the stream in bytes. A value of -1 means that the size is
347
 
not known.
348
 
</p>
349
 
<div class="variablelist"><table border="0" class="variablelist">
350
 
<colgroup>
351
 
<col align="left" valign="top">
352
 
<col>
353
 
</colgroup>
354
 
<tbody>
355
 
<tr>
356
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
357
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
358
 
</td>
359
 
</tr>
360
 
<tr>
361
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
362
 
<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>
363
 
</tr>
364
 
</tbody>
365
 
</table></div>
366
 
</div>
367
 
<hr>
368
 
<div class="refsect2">
369
 
<a name="gst-app-src-set-stream-type"></a><h3>gst_app_src_set_stream_type ()</h3>
370
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_stream_type         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
371
 
                                                         <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>
372
 
<p>
373
 
Set the stream type on <em class="parameter"><code>appsrc</code></em>. For seekable streams, the "seek" signal must
374
 
be connected to.
375
 
</p>
376
 
<p>
377
 
A stream_type stream
378
 
</p>
379
 
<div class="variablelist"><table border="0" class="variablelist">
380
 
<colgroup>
381
 
<col align="left" valign="top">
382
 
<col>
383
 
</colgroup>
384
 
<tbody>
385
 
<tr>
386
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
387
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
388
 
</td>
389
 
</tr>
390
 
<tr>
391
 
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
392
 
<td>the new state</td>
393
 
</tr>
394
 
</tbody>
395
 
</table></div>
396
 
</div>
397
 
<hr>
398
 
<div class="refsect2">
399
 
<a name="gst-app-src-get-stream-type"></a><h3>gst_app_src_get_stream_type ()</h3>
400
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
401
 
<p>
402
 
Get the stream type. Control the stream type of <em class="parameter"><code>appsrc</code></em>
403
 
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>.
404
 
</p>
405
 
<div class="variablelist"><table border="0" class="variablelist">
406
 
<colgroup>
407
 
<col align="left" valign="top">
408
 
<col>
409
 
</colgroup>
410
 
<tbody>
411
 
<tr>
412
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
413
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
414
 
</td>
415
 
</tr>
416
 
<tr>
417
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
418
 
<td>the stream type.</td>
419
 
</tr>
420
 
</tbody>
421
 
</table></div>
422
 
</div>
423
 
<hr>
424
 
<div class="refsect2">
425
 
<a name="gst-app-src-set-max-bytes"></a><h3>gst_app_src_set_max_bytes ()</h3>
426
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_max_bytes           (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
427
 
                                                         <em class="parameter"><code><span class="type">guint64</span> max</code></em>);</pre>
428
 
<p>
429
 
Set the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>.
430
 
After the maximum amount of bytes are queued, <em class="parameter"><code>appsrc</code></em> will emit the
431
 
"enough-data" signal.
432
 
</p>
433
 
<div class="variablelist"><table border="0" class="variablelist">
434
 
<colgroup>
435
 
<col align="left" valign="top">
436
 
<col>
437
 
</colgroup>
438
 
<tbody>
439
 
<tr>
440
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
441
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
442
 
</td>
443
 
</tr>
444
 
<tr>
445
 
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
446
 
<td>the maximum number of bytes to queue</td>
447
 
</tr>
448
 
</tbody>
449
 
</table></div>
450
 
</div>
451
 
<hr>
452
 
<div class="refsect2">
453
 
<a name="gst-app-src-get-max-bytes"></a><h3>gst_app_src_get_max_bytes ()</h3>
454
 
<pre class="programlisting"><span class="returnvalue">guint64</span>             gst_app_src_get_max_bytes           (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
455
 
<p>
456
 
Get the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>.
457
 
</p>
458
 
<div class="variablelist"><table border="0" class="variablelist">
459
 
<colgroup>
460
 
<col align="left" valign="top">
461
 
<col>
462
 
</colgroup>
463
 
<tbody>
464
 
<tr>
465
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
466
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
467
 
</td>
468
 
</tr>
469
 
<tr>
470
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
471
 
<td>The maximum amount of bytes that can be queued.</td>
472
 
</tr>
473
 
</tbody>
474
 
</table></div>
475
 
</div>
476
 
<hr>
477
 
<div class="refsect2">
478
 
<a name="gst-app-src-get-current-level-bytes"></a><h3>gst_app_src_get_current_level_bytes ()</h3>
479
 
<pre class="programlisting"><span class="returnvalue">guint64</span>             gst_app_src_get_current_level_bytes (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
480
 
<p>
481
 
Get the number of currently queued bytes inside <em class="parameter"><code>appsrc</code></em>.
482
 
</p>
483
 
<div class="variablelist"><table border="0" class="variablelist">
484
 
<colgroup>
485
 
<col align="left" valign="top">
486
 
<col>
487
 
</colgroup>
488
 
<tbody>
489
 
<tr>
490
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
491
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
492
 
</td>
493
 
</tr>
494
 
<tr>
495
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
496
 
<td>The number of currently queued bytes.</td>
497
 
</tr>
498
 
</tbody>
499
 
</table></div>
 
267
only produce caps that match <em class="parameter"><code>caps</code></em>
 
268
. <em class="parameter"><code>caps</code></em>
 
269
 must be fixed and the caps on the
 
270
buffers must match the caps or left NULL.</p>
 
271
<div class="refsect3">
 
272
<a name="id-1.2.5.4.8.2.5"></a><h4>Parameters</h4>
 
273
<div class="informaltable"><table width="100%" border="0">
 
274
<colgroup>
 
275
<col width="150px" class="parameters_name">
 
276
<col class="parameters_description">
 
277
<col width="200px" class="parameters_annotations">
 
278
</colgroup>
 
279
<tbody>
 
280
<tr>
 
281
<td class="parameter_name"><p>appsrc</p></td>
 
282
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
283
<td class="parameter_annotations"> </td>
 
284
</tr>
 
285
<tr>
 
286
<td class="parameter_name"><p>caps</p></td>
 
287
<td class="parameter_description"><p>caps to set</p></td>
 
288
<td class="parameter_annotations"> </td>
 
289
</tr>
 
290
</tbody>
 
291
</table></div>
 
292
</div>
 
293
</div>
 
294
<hr>
 
295
<div class="refsect2">
 
296
<a name="gst-app-src-get-caps"></a><h3>gst_app_src_get_caps ()</h3>
 
297
<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> *
 
298
gst_app_src_get_caps (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
 
299
<p>Get the configured caps on <em class="parameter"><code>appsrc</code></em>
 
300
.</p>
 
301
<div class="refsect3">
 
302
<a name="id-1.2.5.4.8.3.5"></a><h4>Parameters</h4>
 
303
<div class="informaltable"><table width="100%" border="0">
 
304
<colgroup>
 
305
<col width="150px" class="parameters_name">
 
306
<col class="parameters_description">
 
307
<col width="200px" class="parameters_annotations">
 
308
</colgroup>
 
309
<tbody><tr>
 
310
<td class="parameter_name"><p>appsrc</p></td>
 
311
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
312
<td class="parameter_annotations"> </td>
 
313
</tr></tbody>
 
314
</table></div>
 
315
</div>
 
316
<div class="refsect3">
 
317
<a name="id-1.2.5.4.8.3.6"></a><h4>Returns</h4>
 
318
<p> 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.</p>
 
319
<p></p>
 
320
</div>
 
321
</div>
 
322
<hr>
 
323
<div class="refsect2">
 
324
<a name="gst-app-src-get-latency"></a><h3>gst_app_src_get_latency ()</h3>
 
325
<pre class="programlisting"><span class="returnvalue">void</span>
 
326
gst_app_src_get_latency (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
327
                         <em class="parameter"><code><span class="type">guint64</span> *min</code></em>,
 
328
                         <em class="parameter"><code><span class="type">guint64</span> *max</code></em>);</pre>
 
329
<p>Retrieve the min and max latencies in <em class="parameter"><code>min</code></em>
 
330
 and <em class="parameter"><code>max</code></em>
 
331
 respectively.</p>
 
332
<div class="refsect3">
 
333
<a name="id-1.2.5.4.8.4.5"></a><h4>Parameters</h4>
 
334
<div class="informaltable"><table width="100%" border="0">
 
335
<colgroup>
 
336
<col width="150px" class="parameters_name">
 
337
<col class="parameters_description">
 
338
<col width="200px" class="parameters_annotations">
 
339
</colgroup>
 
340
<tbody>
 
341
<tr>
 
342
<td class="parameter_name"><p>appsrc</p></td>
 
343
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
344
<td class="parameter_annotations"> </td>
 
345
</tr>
 
346
<tr>
 
347
<td class="parameter_name"><p>min</p></td>
 
348
<td class="parameter_description"><p>the min latency</p></td>
 
349
<td class="parameter_annotations"> </td>
 
350
</tr>
 
351
<tr>
 
352
<td class="parameter_name"><p>max</p></td>
 
353
<td class="parameter_description"><p>the min latency</p></td>
 
354
<td class="parameter_annotations"> </td>
 
355
</tr>
 
356
</tbody>
 
357
</table></div>
 
358
</div>
 
359
</div>
 
360
<hr>
 
361
<div class="refsect2">
 
362
<a name="gst-app-src-set-latency"></a><h3>gst_app_src_set_latency ()</h3>
 
363
<pre class="programlisting"><span class="returnvalue">void</span>
 
364
gst_app_src_set_latency (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
365
                         <em class="parameter"><code><span class="type">guint64</span> min</code></em>,
 
366
                         <em class="parameter"><code><span class="type">guint64</span> max</code></em>);</pre>
 
367
<p>Configure the <em class="parameter"><code>min</code></em>
 
368
 and <em class="parameter"><code>max</code></em>
 
369
 latency in <em class="parameter"><code>src</code></em>
 
370
. If <em class="parameter"><code>min</code></em>
 
371
 is set to -1, the
 
372
default latency calculations for pseudo-live sources will be used.</p>
 
373
<div class="refsect3">
 
374
<a name="id-1.2.5.4.8.5.5"></a><h4>Parameters</h4>
 
375
<div class="informaltable"><table width="100%" border="0">
 
376
<colgroup>
 
377
<col width="150px" class="parameters_name">
 
378
<col class="parameters_description">
 
379
<col width="200px" class="parameters_annotations">
 
380
</colgroup>
 
381
<tbody>
 
382
<tr>
 
383
<td class="parameter_name"><p>appsrc</p></td>
 
384
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
385
<td class="parameter_annotations"> </td>
 
386
</tr>
 
387
<tr>
 
388
<td class="parameter_name"><p>min</p></td>
 
389
<td class="parameter_description"><p>the min latency</p></td>
 
390
<td class="parameter_annotations"> </td>
 
391
</tr>
 
392
<tr>
 
393
<td class="parameter_name"><p>max</p></td>
 
394
<td class="parameter_description"><p>the min latency</p></td>
 
395
<td class="parameter_annotations"> </td>
 
396
</tr>
 
397
</tbody>
 
398
</table></div>
 
399
</div>
 
400
</div>
 
401
<hr>
 
402
<div class="refsect2">
 
403
<a name="gst-app-src-set-size"></a><h3>gst_app_src_set_size ()</h3>
 
404
<pre class="programlisting"><span class="returnvalue">void</span>
 
405
gst_app_src_set_size (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
406
                      <em class="parameter"><code><span class="type">gint64</span> size</code></em>);</pre>
 
407
<p>Set the size of the stream in bytes. A value of -1 means that the size is
 
408
not known.</p>
 
409
<div class="refsect3">
 
410
<a name="id-1.2.5.4.8.6.5"></a><h4>Parameters</h4>
 
411
<div class="informaltable"><table width="100%" border="0">
 
412
<colgroup>
 
413
<col width="150px" class="parameters_name">
 
414
<col class="parameters_description">
 
415
<col width="200px" class="parameters_annotations">
 
416
</colgroup>
 
417
<tbody>
 
418
<tr>
 
419
<td class="parameter_name"><p>appsrc</p></td>
 
420
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
421
<td class="parameter_annotations"> </td>
 
422
</tr>
 
423
<tr>
 
424
<td class="parameter_name"><p>size</p></td>
 
425
<td class="parameter_description"><p>the size to set</p></td>
 
426
<td class="parameter_annotations"> </td>
 
427
</tr>
 
428
</tbody>
 
429
</table></div>
 
430
</div>
 
431
</div>
 
432
<hr>
 
433
<div class="refsect2">
 
434
<a name="gst-app-src-get-size"></a><h3>gst_app_src_get_size ()</h3>
 
435
<pre class="programlisting"><span class="returnvalue">gint64</span>
 
436
gst_app_src_get_size (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
 
437
<p>Get the size of the stream in bytes. A value of -1 means that the size is
 
438
not known.</p>
 
439
<div class="refsect3">
 
440
<a name="id-1.2.5.4.8.7.5"></a><h4>Parameters</h4>
 
441
<div class="informaltable"><table width="100%" border="0">
 
442
<colgroup>
 
443
<col width="150px" class="parameters_name">
 
444
<col class="parameters_description">
 
445
<col width="200px" class="parameters_annotations">
 
446
</colgroup>
 
447
<tbody><tr>
 
448
<td class="parameter_name"><p>appsrc</p></td>
 
449
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
450
<td class="parameter_annotations"> </td>
 
451
</tr></tbody>
 
452
</table></div>
 
453
</div>
 
454
<div class="refsect3">
 
455
<a name="id-1.2.5.4.8.7.6"></a><h4>Returns</h4>
 
456
<p> 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>;</p>
 
457
<p></p>
 
458
</div>
 
459
</div>
 
460
<hr>
 
461
<div class="refsect2">
 
462
<a name="gst-app-src-set-stream-type"></a><h3>gst_app_src_set_stream_type ()</h3>
 
463
<pre class="programlisting"><span class="returnvalue">void</span>
 
464
gst_app_src_set_stream_type (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
465
                             <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>
 
466
<p>Set the stream type on <em class="parameter"><code>appsrc</code></em>
 
467
. For seekable streams, the "seek" signal must
 
468
be connected to.</p>
 
469
<p>A stream_type stream</p>
 
470
<div class="refsect3">
 
471
<a name="id-1.2.5.4.8.8.6"></a><h4>Parameters</h4>
 
472
<div class="informaltable"><table width="100%" border="0">
 
473
<colgroup>
 
474
<col width="150px" class="parameters_name">
 
475
<col class="parameters_description">
 
476
<col width="200px" class="parameters_annotations">
 
477
</colgroup>
 
478
<tbody>
 
479
<tr>
 
480
<td class="parameter_name"><p>appsrc</p></td>
 
481
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
482
<td class="parameter_annotations"> </td>
 
483
</tr>
 
484
<tr>
 
485
<td class="parameter_name"><p>type</p></td>
 
486
<td class="parameter_description"><p>the new state</p></td>
 
487
<td class="parameter_annotations"> </td>
 
488
</tr>
 
489
</tbody>
 
490
</table></div>
 
491
</div>
 
492
</div>
 
493
<hr>
 
494
<div class="refsect2">
 
495
<a name="gst-app-src-get-stream-type"></a><h3>gst_app_src_get_stream_type ()</h3>
 
496
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-appsrc.html#GstAppStreamType" title="enum GstAppStreamType"><span class="returnvalue">GstAppStreamType</span></a>
 
497
gst_app_src_get_stream_type (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
 
498
<p>Get the stream type. Control the stream type of <em class="parameter"><code>appsrc</code></em>
 
499
 
 
500
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>
 
501
<div class="refsect3">
 
502
<a name="id-1.2.5.4.8.9.5"></a><h4>Parameters</h4>
 
503
<div class="informaltable"><table width="100%" border="0">
 
504
<colgroup>
 
505
<col width="150px" class="parameters_name">
 
506
<col class="parameters_description">
 
507
<col width="200px" class="parameters_annotations">
 
508
</colgroup>
 
509
<tbody><tr>
 
510
<td class="parameter_name"><p>appsrc</p></td>
 
511
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
512
<td class="parameter_annotations"> </td>
 
513
</tr></tbody>
 
514
</table></div>
 
515
</div>
 
516
<div class="refsect3">
 
517
<a name="id-1.2.5.4.8.9.6"></a><h4>Returns</h4>
 
518
<p> the stream type.</p>
 
519
<p></p>
 
520
</div>
 
521
</div>
 
522
<hr>
 
523
<div class="refsect2">
 
524
<a name="gst-app-src-set-max-bytes"></a><h3>gst_app_src_set_max_bytes ()</h3>
 
525
<pre class="programlisting"><span class="returnvalue">void</span>
 
526
gst_app_src_set_max_bytes (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
527
                           <em class="parameter"><code><span class="type">guint64</span> max</code></em>);</pre>
 
528
<p>Set the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>
 
529
.
 
530
After the maximum amount of bytes are queued, <em class="parameter"><code>appsrc</code></em>
 
531
 will emit the
 
532
"enough-data" signal.</p>
 
533
<div class="refsect3">
 
534
<a name="id-1.2.5.4.8.10.5"></a><h4>Parameters</h4>
 
535
<div class="informaltable"><table width="100%" border="0">
 
536
<colgroup>
 
537
<col width="150px" class="parameters_name">
 
538
<col class="parameters_description">
 
539
<col width="200px" class="parameters_annotations">
 
540
</colgroup>
 
541
<tbody>
 
542
<tr>
 
543
<td class="parameter_name"><p>appsrc</p></td>
 
544
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
545
<td class="parameter_annotations"> </td>
 
546
</tr>
 
547
<tr>
 
548
<td class="parameter_name"><p>max</p></td>
 
549
<td class="parameter_description"><p>the maximum number of bytes to queue</p></td>
 
550
<td class="parameter_annotations"> </td>
 
551
</tr>
 
552
</tbody>
 
553
</table></div>
 
554
</div>
 
555
</div>
 
556
<hr>
 
557
<div class="refsect2">
 
558
<a name="gst-app-src-get-max-bytes"></a><h3>gst_app_src_get_max_bytes ()</h3>
 
559
<pre class="programlisting"><span class="returnvalue">guint64</span>
 
560
gst_app_src_get_max_bytes (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
 
561
<p>Get the maximum amount of bytes that can be queued in <em class="parameter"><code>appsrc</code></em>
 
562
.</p>
 
563
<div class="refsect3">
 
564
<a name="id-1.2.5.4.8.11.5"></a><h4>Parameters</h4>
 
565
<div class="informaltable"><table width="100%" border="0">
 
566
<colgroup>
 
567
<col width="150px" class="parameters_name">
 
568
<col class="parameters_description">
 
569
<col width="200px" class="parameters_annotations">
 
570
</colgroup>
 
571
<tbody><tr>
 
572
<td class="parameter_name"><p>appsrc</p></td>
 
573
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
574
<td class="parameter_annotations"> </td>
 
575
</tr></tbody>
 
576
</table></div>
 
577
</div>
 
578
<div class="refsect3">
 
579
<a name="id-1.2.5.4.8.11.6"></a><h4>Returns</h4>
 
580
<p> The maximum amount of bytes that can be queued.</p>
 
581
<p></p>
 
582
</div>
 
583
</div>
 
584
<hr>
 
585
<div class="refsect2">
 
586
<a name="gst-app-src-get-current-level-bytes"></a><h3>gst_app_src_get_current_level_bytes ()</h3>
 
587
<pre class="programlisting"><span class="returnvalue">guint64</span>
 
588
gst_app_src_get_current_level_bytes (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
 
589
<p>Get the number of currently queued bytes inside <em class="parameter"><code>appsrc</code></em>
 
590
.</p>
 
591
<div class="refsect3">
 
592
<a name="id-1.2.5.4.8.12.5"></a><h4>Parameters</h4>
 
593
<div class="informaltable"><table width="100%" border="0">
 
594
<colgroup>
 
595
<col width="150px" class="parameters_name">
 
596
<col class="parameters_description">
 
597
<col width="200px" class="parameters_annotations">
 
598
</colgroup>
 
599
<tbody><tr>
 
600
<td class="parameter_name"><p>appsrc</p></td>
 
601
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
602
<td class="parameter_annotations"> </td>
 
603
</tr></tbody>
 
604
</table></div>
 
605
</div>
 
606
<div class="refsect3">
 
607
<a name="id-1.2.5.4.8.12.6"></a><h4>Returns</h4>
 
608
<p> The number of currently queued bytes.</p>
 
609
<p></p>
 
610
</div>
500
611
<p class="since">Since 1.2</p>
501
612
</div>
502
613
<hr>
503
614
<div class="refsect2">
504
 
<a name="gst-app-src-get-emit-signals"></a><h3>gst_app_src_get_emit_signals ()</h3>
505
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
506
 
<p>
507
 
Check if appsrc will emit the "new-preroll" and "new-buffer" signals.
508
 
</p>
509
 
<div class="variablelist"><table border="0" class="variablelist">
 
615
<a name="gst-app-src-get-emit-signals"></a><h3>gst_app_src_get_emit_signals ()</h3>
 
616
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
617
gst_app_src_get_emit_signals (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
 
618
<p>Check if appsrc will emit the "new-preroll" and "new-buffer" signals.</p>
 
619
<div class="refsect3">
 
620
<a name="id-1.2.5.4.8.13.5"></a><h4>Parameters</h4>
 
621
<div class="informaltable"><table width="100%" border="0">
510
622
<colgroup>
511
 
<col align="left" valign="top">
512
 
<col>
 
623
<col width="150px" class="parameters_name">
 
624
<col class="parameters_description">
 
625
<col width="200px" class="parameters_annotations">
513
626
</colgroup>
514
 
<tbody>
515
 
<tr>
516
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
517
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
518
 
</td>
519
 
</tr>
520
 
<tr>
521
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
522
 
<td>
523
 
<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 emitting the "new-preroll" and "new-buffer"
524
 
signals.</td>
525
 
</tr>
526
 
</tbody>
 
627
<tbody><tr>
 
628
<td class="parameter_name"><p>appsrc</p></td>
 
629
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
630
<td class="parameter_annotations"> </td>
 
631
</tr></tbody>
527
632
</table></div>
528
633
</div>
 
634
<div class="refsect3">
 
635
<a name="id-1.2.5.4.8.13.6"></a><h4>Returns</h4>
 
636
<p> <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>
 
637
is emitting the "new-preroll" and "new-buffer"
 
638
signals.</p>
 
639
<p></p>
 
640
</div>
 
641
</div>
529
642
<hr>
530
643
<div class="refsect2">
531
 
<a name="gst-app-src-set-emit-signals"></a><h3>gst_app_src_set_emit_signals ()</h3>
532
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_emit_signals        (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
533
 
                                                         <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>
534
 
<p>
535
 
Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is
 
644
<a name="gst-app-src-set-emit-signals"></a><h3>gst_app_src_set_emit_signals ()</h3>
 
645
<pre class="programlisting"><span class="returnvalue">void</span>
 
646
gst_app_src_set_emit_signals (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
647
                              <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>
 
648
<p>Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is
536
649
by default disabled because signal emission is expensive and unneeded when
537
 
the application prefers to operate in pull mode.
538
 
</p>
539
 
<div class="variablelist"><table border="0" class="variablelist">
540
 
<colgroup>
541
 
<col align="left" valign="top">
542
 
<col>
543
 
</colgroup>
544
 
<tbody>
545
 
<tr>
546
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
547
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
548
 
</td>
549
 
</tr>
550
 
<tr>
551
 
<td><p><span class="term"><em class="parameter"><code>emit</code></em> :</span></p></td>
552
 
<td>the new state</td>
553
 
</tr>
554
 
</tbody>
555
 
</table></div>
 
650
the application prefers to operate in pull mode.</p>
 
651
<div class="refsect3">
 
652
<a name="id-1.2.5.4.8.14.5"></a><h4>Parameters</h4>
 
653
<div class="informaltable"><table width="100%" border="0">
 
654
<colgroup>
 
655
<col width="150px" class="parameters_name">
 
656
<col class="parameters_description">
 
657
<col width="200px" class="parameters_annotations">
 
658
</colgroup>
 
659
<tbody>
 
660
<tr>
 
661
<td class="parameter_name"><p>appsrc</p></td>
 
662
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
663
<td class="parameter_annotations"> </td>
 
664
</tr>
 
665
<tr>
 
666
<td class="parameter_name"><p>emit</p></td>
 
667
<td class="parameter_description"><p>the new state</p></td>
 
668
<td class="parameter_annotations"> </td>
 
669
</tr>
 
670
</tbody>
 
671
</table></div>
 
672
</div>
 
673
</div>
 
674
<hr>
 
675
<div class="refsect2">
 
676
<a name="gst-app-src-set-callbacks"></a><h3>gst_app_src_set_callbacks ()</h3>
 
677
<pre class="programlisting"><span class="returnvalue">void</span>
 
678
gst_app_src_set_callbacks (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
679
                           <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>,
 
680
                           <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>,
 
681
                           <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>
 
682
<p>Set callbacks which will be executed when data is needed, enough data has
 
683
been collected or when a seek should be performed.
 
684
This is an alternative to using the signals, it has lower overhead and is thus
 
685
less expensive, but also less flexible.</p>
 
686
<p>If callbacks are installed, no signals will be emitted for performance
 
687
reasons.</p>
 
688
<div class="refsect3">
 
689
<a name="id-1.2.5.4.8.15.6"></a><h4>Parameters</h4>
 
690
<div class="informaltable"><table width="100%" border="0">
 
691
<colgroup>
 
692
<col width="150px" class="parameters_name">
 
693
<col class="parameters_description">
 
694
<col width="200px" class="parameters_annotations">
 
695
</colgroup>
 
696
<tbody>
 
697
<tr>
 
698
<td class="parameter_name"><p>appsrc</p></td>
 
699
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
700
<td class="parameter_annotations"> </td>
 
701
</tr>
 
702
<tr>
 
703
<td class="parameter_name"><p>callbacks</p></td>
 
704
<td class="parameter_description"><p>the callbacks</p></td>
 
705
<td class="parameter_annotations"> </td>
 
706
</tr>
 
707
<tr>
 
708
<td class="parameter_name"><p>user_data</p></td>
 
709
<td class="parameter_description"><p>a user_data argument for the callbacks</p></td>
 
710
<td class="parameter_annotations"> </td>
 
711
</tr>
 
712
<tr>
 
713
<td class="parameter_name"><p>notify</p></td>
 
714
<td class="parameter_description"><p>a destroy notify function</p></td>
 
715
<td class="parameter_annotations"> </td>
 
716
</tr>
 
717
</tbody>
 
718
</table></div>
 
719
</div>
 
720
</div>
 
721
<hr>
 
722
<div class="refsect2">
 
723
<a name="gst-app-src-push-buffer"></a><h3>gst_app_src_push_buffer ()</h3>
 
724
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
 
725
gst_app_src_push_buffer (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
 
726
                         <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>
 
727
<p>Adds a buffer to the queue of buffers that the appsrc element will
 
728
push to its source pad.  This function takes ownership of the buffer.</p>
 
729
<p>When the block property is TRUE, this function can block until free
 
730
space becomes available in the queue.</p>
 
731
<div class="refsect3">
 
732
<a name="id-1.2.5.4.8.16.6"></a><h4>Parameters</h4>
 
733
<div class="informaltable"><table width="100%" border="0">
 
734
<colgroup>
 
735
<col width="150px" class="parameters_name">
 
736
<col class="parameters_description">
 
737
<col width="200px" class="parameters_annotations">
 
738
</colgroup>
 
739
<tbody>
 
740
<tr>
 
741
<td class="parameter_name"><p>appsrc</p></td>
 
742
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
743
<td class="parameter_annotations"> </td>
 
744
</tr>
 
745
<tr>
 
746
<td class="parameter_name"><p>buffer</p></td>
 
747
<td class="parameter_description"><p> 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. </p></td>
 
748
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
 
749
</tr>
 
750
</tbody>
 
751
</table></div>
 
752
</div>
 
753
<div class="refsect3">
 
754
<a name="id-1.2.5.4.8.16.7"></a><h4>Returns</h4>
 
755
<p> <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.
 
756
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-FLUSHING:CAPS"><span class="type">GST_FLOW_FLUSHING</span></a> when <em class="parameter"><code>appsrc</code></em>
 
757
is not PAUSED or PLAYING.
 
758
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-EOS:CAPS"><span class="type">GST_FLOW_EOS</span></a> when EOS occured.</p>
 
759
<p></p>
 
760
</div>
 
761
</div>
 
762
<hr>
 
763
<div class="refsect2">
 
764
<a name="gst-app-src-end-of-stream"></a><h3>gst_app_src_end_of_stream ()</h3>
 
765
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a>
 
766
gst_app_src_end_of_stream (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
 
767
<p>Indicates to the appsrc element that the last buffer queued in the
 
768
element is the last buffer of the stream.</p>
 
769
<div class="refsect3">
 
770
<a name="id-1.2.5.4.8.17.5"></a><h4>Parameters</h4>
 
771
<div class="informaltable"><table width="100%" border="0">
 
772
<colgroup>
 
773
<col width="150px" class="parameters_name">
 
774
<col class="parameters_description">
 
775
<col width="200px" class="parameters_annotations">
 
776
</colgroup>
 
777
<tbody><tr>
 
778
<td class="parameter_name"><p>appsrc</p></td>
 
779
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a></p></td>
 
780
<td class="parameter_annotations"> </td>
 
781
</tr></tbody>
 
782
</table></div>
 
783
</div>
 
784
<div class="refsect3">
 
785
<a name="id-1.2.5.4.8.17.6"></a><h4>Returns</h4>
 
786
<p> <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.
 
787
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-FLUSHING:CAPS"><span class="type">GST_FLOW_FLUSHING</span></a> when <em class="parameter"><code>appsrc</code></em>
 
788
is not PAUSED or PLAYING.</p>
 
789
<p></p>
 
790
</div>
 
791
</div>
 
792
</div>
 
793
<div class="refsect1">
 
794
<a name="gst-plugins-base-libs-appsrc.other_details"></a><h2>Types and Values</h2>
 
795
<div class="refsect2">
 
796
<a name="GstAppStreamType"></a><h3>enum GstAppStreamType</h3>
 
797
<p>The stream type.</p>
 
798
<div class="refsect3">
 
799
<a name="id-1.2.5.4.9.2.4"></a><h4>Members</h4>
 
800
<div class="informaltable"><table width="100%" border="0">
 
801
<colgroup>
 
802
<col width="300px" class="enum_members_name">
 
803
<col class="enum_members_description">
 
804
<col width="200px" class="enum_members_annotations">
 
805
</colgroup>
 
806
<tbody>
 
807
<tr>
 
808
<td class="enum_member_name"><p><a name="GST-APP-STREAM-TYPE-STREAM:CAPS"></a>GST_APP_STREAM_TYPE_STREAM</p></td>
 
809
<td class="enum_member_description">
 
810
<p>No seeking is supported in the stream, such as a
 
811
live stream.</p>
 
812
</td>
 
813
<td class="enum_member_annotations"> </td>
 
814
</tr>
 
815
<tr>
 
816
<td class="enum_member_name"><p><a name="GST-APP-STREAM-TYPE-SEEKABLE:CAPS"></a>GST_APP_STREAM_TYPE_SEEKABLE</p></td>
 
817
<td class="enum_member_description">
 
818
<p>The stream is seekable but seeking might not
 
819
be very fast, such as data from a webserver.</p>
 
820
</td>
 
821
<td class="enum_member_annotations"> </td>
 
822
</tr>
 
823
<tr>
 
824
<td class="enum_member_name"><p><a name="GST-APP-STREAM-TYPE-RANDOM-ACCESS:CAPS"></a>GST_APP_STREAM_TYPE_RANDOM_ACCESS</p></td>
 
825
<td class="enum_member_description">
 
826
<p>The stream is seekable and seeking is fast,
 
827
such as in a local file.</p>
 
828
</td>
 
829
<td class="enum_member_annotations"> </td>
 
830
</tr>
 
831
</tbody>
 
832
</table></div>
 
833
</div>
556
834
</div>
557
835
<hr>
558
836
<div class="refsect2">
563
841
  gboolean  (*seek_data)    (GstAppSrc *src, guint64 offset, gpointer user_data);
564
842
} GstAppSrcCallbacks;
565
843
</pre>
566
 
<p>
567
 
A set of callbacks that can be installed on the appsrc with
568
 
<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>.
569
 
</p>
570
 
<div class="variablelist"><table border="0" class="variablelist">
 
844
<p>A set of callbacks that can be installed on the appsrc with
 
845
<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>
 
846
<div class="refsect3">
 
847
<a name="id-1.2.5.4.9.3.5"></a><h4>Members</h4>
 
848
<div class="informaltable"><table width="100%" border="0">
571
849
<colgroup>
572
 
<col align="left" valign="top">
573
 
<col>
 
850
<col width="300px" class="struct_members_name">
 
851
<col class="struct_members_description">
 
852
<col width="200px" class="struct_members_annotations">
574
853
</colgroup>
575
854
<tbody>
576
855
<tr>
577
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.need-data"></a>need_data</code></em> ()</span></p></td>
578
 
<td>Called when the appsrc needs more data. A buffer or EOS should be
579
 
pushed to appsrc from this thread or another thread. <em class="parameter"><code>length</code></em> is just a hint
580
 
and when it is set to -1, any number of bytes can be pushed into <em class="parameter"><code>appsrc</code></em>.</td>
 
856
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAppSrcCallbacks.need-data"></a>need_data</code></em> ()</p></td>
 
857
<td class="struct_member_description"><p>Called when the appsrc needs more data. A buffer or EOS should be
 
858
pushed to appsrc from this thread or another thread. <em class="parameter"><code>length</code></em>
 
859
is just a hint
 
860
and when it is set to -1, any number of bytes can be pushed into <em class="parameter"><code>appsrc</code></em>
 
861
.</p></td>
 
862
<td class="struct_member_annotations"> </td>
581
863
</tr>
582
864
<tr>
583
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.enough-data"></a>enough_data</code></em> ()</span></p></td>
584
 
<td>Called when appsrc has enough data. It is recommended that the
 
865
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAppSrcCallbacks.enough-data"></a>enough_data</code></em> ()</p></td>
 
866
<td class="struct_member_description"><p>Called when appsrc has enough data. It is recommended that the
585
867
application stops calling push-buffer until the need_data callback is
586
 
emitted again to avoid excessive buffer queueing.</td>
587
 
</tr>
588
 
<tr>
589
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAppSrcCallbacks.seek-data"></a>seek_data</code></em> ()</span></p></td>
590
 
<td>Called when a seek should be performed to the offset.
591
 
The next push-buffer should produce buffers from the new <em class="parameter"><code>offset</code></em>.
592
 
This callback is only called for seekable stream types.</td>
593
 
</tr>
594
 
</tbody>
595
 
</table></div>
596
 
</div>
597
 
<hr>
598
 
<div class="refsect2">
599
 
<a name="gst-app-src-set-callbacks"></a><h3>gst_app_src_set_callbacks ()</h3>
600
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_app_src_set_callbacks           (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
601
 
                                                         <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>,
602
 
                                                         <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>,
603
 
                                                         <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>
604
 
<p>
605
 
Set callbacks which will be executed when data is needed, enough data has
606
 
been collected or when a seek should be performed.
607
 
This is an alternative to using the signals, it has lower overhead and is thus
608
 
less expensive, but also less flexible.
609
 
</p>
610
 
<p>
611
 
If callbacks are installed, no signals will be emitted for performance
612
 
reasons.
613
 
</p>
614
 
<div class="variablelist"><table border="0" class="variablelist">
615
 
<colgroup>
616
 
<col align="left" valign="top">
617
 
<col>
618
 
</colgroup>
619
 
<tbody>
620
 
<tr>
621
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
622
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
623
 
</td>
624
 
</tr>
625
 
<tr>
626
 
<td><p><span class="term"><em class="parameter"><code>callbacks</code></em> :</span></p></td>
627
 
<td>the callbacks</td>
628
 
</tr>
629
 
<tr>
630
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
631
 
<td>a user_data argument for the callbacks</td>
632
 
</tr>
633
 
<tr>
634
 
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
635
 
<td>a destroy notify function</td>
636
 
</tr>
637
 
</tbody>
638
 
</table></div>
639
 
</div>
640
 
<hr>
641
 
<div class="refsect2">
642
 
<a name="gst-app-src-push-buffer"></a><h3>gst_app_src_push_buffer ()</h3>
643
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>,
644
 
                                                         <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>
645
 
<p>
646
 
Adds a buffer to the queue of buffers that the appsrc element will
647
 
push to its source pad.  This function takes ownership of the buffer.
648
 
</p>
649
 
<p>
650
 
When the block property is TRUE, this function can block until free
651
 
space becomes available in the queue.
652
 
</p>
653
 
<div class="variablelist"><table border="0" class="variablelist">
654
 
<colgroup>
655
 
<col align="left" valign="top">
656
 
<col>
657
 
</colgroup>
658
 
<tbody>
659
 
<tr>
660
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
661
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
662
 
</td>
663
 
</tr>
664
 
<tr>
665
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
666
 
<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. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
667
 
</td>
668
 
</tr>
669
 
<tr>
670
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
671
 
<td>
672
 
<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.
673
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-FLUSHING:CAPS"><span class="type">GST_FLOW_FLUSHING</span></a> when <em class="parameter"><code>appsrc</code></em> is not PAUSED or PLAYING.
674
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-EOS:CAPS"><span class="type">GST_FLOW_EOS</span></a> when EOS occured.</td>
675
 
</tr>
676
 
</tbody>
677
 
</table></div>
678
 
</div>
679
 
<hr>
680
 
<div class="refsect2">
681
 
<a name="gst-app-src-end-of-stream"></a><h3>gst_app_src_end_of_stream ()</h3>
682
 
<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 href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a> *appsrc</code></em>);</pre>
683
 
<p>
684
 
Indicates to the appsrc element that the last buffer queued in the
685
 
element is the last buffer of the stream.
686
 
</p>
687
 
<div class="variablelist"><table border="0" class="variablelist">
688
 
<colgroup>
689
 
<col align="left" valign="top">
690
 
<col>
691
 
</colgroup>
692
 
<tbody>
693
 
<tr>
694
 
<td><p><span class="term"><em class="parameter"><code>appsrc</code></em> :</span></p></td>
695
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-appsrc.html#GstAppSrc"><span class="type">GstAppSrc</span></a>
696
 
</td>
697
 
</tr>
698
 
<tr>
699
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
700
 
<td>
701
 
<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.
702
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GST-FLOW-FLUSHING:CAPS"><span class="type">GST_FLOW_FLUSHING</span></a> when <em class="parameter"><code>appsrc</code></em> is not PAUSED or PLAYING.</td>
703
 
</tr>
704
 
</tbody>
705
 
</table></div>
 
868
emitted again to avoid excessive buffer queueing.</p></td>
 
869
<td class="struct_member_annotations"> </td>
 
870
</tr>
 
871
<tr>
 
872
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAppSrcCallbacks.seek-data"></a>seek_data</code></em> ()</p></td>
 
873
<td class="struct_member_description"><p>Called when a seek should be performed to the offset.
 
874
The next push-buffer should produce buffers from the new <em class="parameter"><code>offset</code></em>
 
875
.
 
876
This callback is only called for seekable stream types.</p></td>
 
877
<td class="struct_member_annotations"> </td>
 
878
</tr>
 
879
</tbody>
 
880
</table></div>
 
881
</div>
706
882
</div>
707
883
</div>
708
884
<div class="refsect1">
709
885
<a name="gst-plugins-base-libs-appsrc.see-also"></a><h2>See Also</h2>
710
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html"><span class="type">GstBaseSrc</span></a>, appsink
 
886
<p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html"><span class="type">GstBaseSrc</span></a>, appsink</p>
711
887
</div>
712
888
</div>
713
889
<div class="footer">
714
890
<hr>
715
 
          Generated by GTK-Doc V1.19</div>
 
891
          Generated by GTK-Doc V1.20</div>
716
892
</body>
717
893
</html>
 
 
b'\\ No newline at end of file'