← Back to branch summary

~ubuntu-branches/ubuntu/feisty/gst-plugins-good0.10/feisty-security

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-good-plugins-udpsrc.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2006-12-21 21:12:15 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20061221211215-3uukkusokhe0nk4f
Tags: 0.10.5-0ubuntu1
* Sync with pkg-gstreamer SVN:
  + debian/rules:
    - Use Ubuntu as distribution name and point to the proper Launchpad URL
  + debian/patches/01_esdsink-priority.patch:
    - Mark the esdsink with rank primary-2 to get
      pulse > alsadmix > esd > alsa > oss

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plugins/html/gst-plugins-good-plugins-udpsrc.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>udpsrc</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7
7
<link rel="start" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9
9
<link rel="prev" href="gst-plugins-good-plugins-smokeenc.html" title="smokeenc">
10
10
<link rel="next" href="gst-plugins-good-plugins-videobalance.html" title="videobalance">
11
 
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="gst-plugins-good Elements">
14
14
<link rel="chapter" href="ch02.html" title="gst-plugins-good Plugins">
22
22
<th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
23
23
<td><a accesskey="n" href="gst-plugins-good-plugins-videobalance.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
24
</tr>
25
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
26
 
                  &#160;|&#160;
27
 
                  <a href="#desc" class="shortcut">Description</a>
28
 
                  &#160;|&#160;
29
 
                  <a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
30
 
                  &#160;|&#160;
31
 
                  <a href="#properties" class="shortcut">Properties</a></nobr></td></tr>
 
25
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id294197" class="shortcut">Top</a>
 
26
                  &#160;|&#160;
 
27
                  <a href="#id334182" class="shortcut">Description</a>
 
28
                  &#160;|&#160;
 
29
                  <a href="#id315661" class="shortcut">Object Hierarchy</a>
 
30
                  &#160;|&#160;
 
31
                  <a href="#id315716" class="shortcut">Implemented Interfaces</a>
 
32
                  &#160;|&#160;
 
33
                  <a href="#id309086" class="shortcut">Properties</a></nobr></td></tr>
32
34
</table>
33
35
<div class="refentry" lang="en">
34
36
<a name="gst-plugins-good-plugins-udpsrc"></a><div class="titlepage"></div>
35
37
<div class="refnamediv"><table width="100%"><tr>
36
38
<td valign="top">
37
 
<h2><span class="refentrytitle"><a name="top_of_page"></a>udpsrc</span></h2>
 
39
<h2>
 
40
<a name="id294197"></a><span class="refentrytitle">udpsrc</span>
 
41
</h2>
38
42
<p>udpsrc &#8212; Receive data over the network via UDP</p>
39
43
</td>
40
44
<td valign="top" align="right"></td>
41
45
</tr></table></div>
42
46
<div class="refsynopsisdiv">
43
 
<a name="synopsis"></a><h2>Synopsis</h2>
 
47
<h2>Synopsis</h2>
44
48
<a name="GstUDPSrc"></a><pre class="synopsis">
45
49
 
46
50
 
50
54
</pre>
51
55
</div>
52
56
<div class="refsect1" lang="en">
53
 
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
 
57
<a name="id315661"></a><h2>Object Hierarchy</h2>
54
58
<pre class="synopsis">
55
59
 
56
 
  <a
57
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
58
 
>GObject</a>
59
 
   +----<a
60
 
href="/usr/share/gtk-doc/html/gstreamer/GstObject.html"
61
 
>GstObject</a>
62
 
         +----<a
63
 
href="/usr/share/gtk-doc/html/gstreamer/GstElement.html"
64
 
>GstElement</a>
65
 
               +----<a
66
 
href="/usr/share/gtk-doc/html/gstreamer-libs/gstreamer-libs-GstBaseSrc.html#GstBaseSrc"
67
 
>GstBaseSrc</a>
68
 
                     +----<a
69
 
href="/usr/share/gtk-doc/html/gstreamer-libs/gstreamer-libs-GstPushSrc.html#GstPushSrc"
70
 
>GstPushSrc</a>
 
60
  GObject
 
61
   +----GstObject
 
62
         +----GstElement
 
63
               +----GstBaseSrc
 
64
                     +----GstPushSrc
71
65
                           +----GstUDPSrc
72
66
</pre>
73
67
</div>
74
68
<div class="refsect1" lang="en">
75
 
<a name="impl_interfaces"></a><h2>Implemented Interfaces</h2>
 
69
<a name="id315716"></a><h2>Implemented Interfaces</h2>
76
70
<p>
77
71
GstUDPSrc implements
78
 
 <a
79
 
href="/usr/share/gtk-doc/html/gstreamer/gstreamer-GstUriHandler.html#GstURIHandler"
80
 
>GstURIHandler</a>.</p>
 
72
 GstURIHandler.</p>
81
73
</div>
82
74
<div class="refsect1" lang="en">
83
 
<a name="properties"></a><h2>Properties</h2>
 
75
<a name="id309086"></a><h2>Properties</h2>
84
76
<pre class="synopsis">
85
77
 
86
 
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--caps">caps</a>"                 <a
87
 
href="/usr/share/gtk-doc/html/gstreamer/gstreamer-GstCaps.html#GstCaps"
88
 
>GstCaps</a>               : Read / Write
89
 
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--multicast-group">multicast-group</a>"      <a
90
 
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
91
 
>gchararray</a>            : Read / Write
92
 
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--port">port</a>"                 <a
93
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
94
 
>gint</a>                  : Read / Write
95
 
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--uri">uri</a>"                  <a
96
 
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
97
 
>gchararray</a>            : Read / Write
98
 
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--sockfd">sockfd</a>"               <a
99
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
100
 
>gint</a>                  : Read / Write
 
78
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--caps">caps</a>"                 GstCaps               : Read / Write
 
79
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--multicast-group">multicast-group</a>"      gchararray            : Read / Write
 
80
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--port">port</a>"                 gint                  : Read / Write
 
81
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--uri">uri</a>"                  gchararray            : Read / Write
 
82
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--sockfd">sockfd</a>"               gint                  : Read / Write
 
83
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--buffer-size">buffer-size</a>"          gint                  : Read / Write
 
84
  "<a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--timeout">timeout</a>"              guint64               : Read / Write
101
85
</pre>
102
86
</div>
103
87
<div class="refsect1" lang="en">
104
 
<a name="desc"></a><h2>Description</h2>
 
88
<a name="id334182"></a><h2>Description</h2>
105
89
<p>
106
90
</p>
107
91
<div class="refsect2" lang="en">
108
 
<a name="id2630206"></a><p>
 
92
<a name="id334195"></a><p>
109
93
udpsrc is a network source that reads UDP packets from the network.
110
94
It can be combined with RTP depayloaders to implement RTP streaming.
111
95
</p>
168
152
URIs.
169
153
</p>
170
154
<p>
171
 
Last reviewed on 2006-07-27 (0.10.4)
 
155
If the <a href="gst-plugins-good-plugins-udpsrc.html#GstUDPSrc--timeout">timeout property</a> is set to a
 
156
value bigger than 0, udpsrc will generate an element message named
 
157
<code class="classname">"GstUDPSrcTimeout"</code>:
 
158
if no data was recieved in the given timeout.
 
159
The message's structure contains one field:
 
160
</p>
 
161
<div class="itemizedlist"><ul type="disc"><li><p>
 
162
  <span class="type">guint64</span>
 
163
  <code class="classname">"timeout"</code>: the timeout in microseconds that
 
164
  expired when waiting for data.
 
165
  </p></li></ul></div>
 
166
<p>
 
167
The message is typically used to detect that no UDP arrives in the receiver
 
168
because it is blocked by a firewall.
 
169
</p>
 
170
<p>
 
171
Last reviewed on 2006-09-29 (0.10.5)
172
172
</p>
173
173
</div>
174
174
<div class="refsect2" lang="en">
175
 
<a name="id2630301"></a><h3>Element Information</h3>
176
 
<div class="variablelist"><table border="0">
 
175
<a name="id335664"></a><h3>Element Information</h3>
 
176
<div class="variablelist">
 
177
<span class="term">plugin</span>
 
178
          <a href="gst-plugins-good-plugins-plugin-udp.html#plugin-udp">udp</a>
 
179
        
 
180
          <a href="gst-plugins-good-plugins-plugin-udp.html#plugin-udp">udp</a>
 
181
        <a href="gst-plugins-good-plugins-plugin-udp.html#plugin-udp">udp</a><span class="term">author</span>Wim Taymans &lt;wim@fluendo.com&gt;
 
182
    Thijs Vermeir &lt;thijs.vermeir@barco.com&gt;Wim Taymans &lt;wim@fluendo.com&gt;
 
183
    Thijs Vermeir &lt;thijs.vermeir@barco.com&gt;<span class="term">class</span>Source/NetworkSource/Network<table border="0">
177
184
<col align="left" valign="top">
178
185
<tbody>
179
186
<tr>
186
193
<tr>
187
194
<td>
188
195
<span class="term">author</span></td>
189
 
<td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
 
196
<td>Wim Taymans &lt;wim@fluendo.com&gt;
 
197
    Thijs Vermeir &lt;thijs.vermeir@barco.com&gt;</td>
190
198
</tr>
191
199
<tr>
192
200
<td>
194
202
<td>Source/Network</td>
195
203
</tr>
196
204
</tbody>
197
 
</table></div>
 
205
</table>
 
206
</div>
198
207
</div>
199
208
<p>
200
209
 
201
210
</p>
202
211
</div>
203
212
<div class="refsect1" lang="en">
204
 
<a name="details"></a><h2>Details</h2>
 
213
<a name="id335732"></a><h2>Details</h2>
205
214
<div class="refsect2" lang="en">
206
 
<a name="id2627378"></a><h3>
 
215
<a name="id335743"></a><h3>
207
216
<a name="GstUDPSrc-struct"></a>GstUDPSrc</h3>
208
 
<a class="indexterm" name="id2627390"></a><pre class="programlisting">typedef struct _GstUDPSrc GstUDPSrc;</pre>
 
217
<a class="indexterm" name="id335755"></a><pre class="programlisting">typedef struct _GstUDPSrc GstUDPSrc;</pre>
209
218
<p>
210
219
 
211
220
</p>
212
221
</div>
213
222
</div>
214
223
<div class="refsect1" lang="en">
215
 
<a name="property_details"></a><h2>Property Details</h2>
 
224
<a name="id335772"></a><h2>Property Details</h2>
216
225
<div class="refsect2" lang="en">
217
 
<a name="id2627418"></a><h3>
 
226
<a name="id335782"></a><h3>
218
227
<a name="GstUDPSrc--caps"></a>The "<code class="literal">caps</code>" property</h3>
219
 
<a class="indexterm" name="id2627432"></a><pre class="programlisting">  "caps"                 <a
220
 
href="/usr/share/gtk-doc/html/gstreamer/gstreamer-GstCaps.html#GstCaps"
221
 
>GstCaps</a>               : Read / Write</pre>
 
228
<a class="indexterm" name="id335797"></a><pre class="programlisting">  "caps"                 GstCaps               : Read / Write</pre>
222
229
<p>The caps of the source pad.</p>
223
230
</div>
224
231
<hr>
225
232
<div class="refsect2" lang="en">
226
 
<a name="id2627453"></a><h3>
 
233
<a name="id335819"></a><h3>
227
234
<a name="GstUDPSrc--multicast-group"></a>The "<code class="literal">multicast-group</code>" property</h3>
228
 
<a class="indexterm" name="id2627467"></a><pre class="programlisting">  "multicast-group"      <a
229
 
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
230
 
>gchararray</a>            : Read / Write</pre>
 
235
<a class="indexterm" name="id335834"></a><pre class="programlisting">  "multicast-group"      gchararray            : Read / Write</pre>
231
236
<p>The Address of multicast group to join.</p>
232
237
<p>Default value: "0.0.0.0"</p>
233
238
</div>
234
239
<hr>
235
240
<div class="refsect2" lang="en">
236
 
<a name="id2627492"></a><h3>
 
241
<a name="id335859"></a><h3>
237
242
<a name="GstUDPSrc--port"></a>The "<code class="literal">port</code>" property</h3>
238
 
<a class="indexterm" name="id2627507"></a><pre class="programlisting">  "port"                 <a
239
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
240
 
>gint</a>                  : Read / Write</pre>
 
243
<a class="indexterm" name="id335874"></a><pre class="programlisting">  "port"                 gint                  : Read / Write</pre>
241
244
<p>The port to receive the packets from, 0=allocate.</p>
242
245
<p>Allowed values: [0,65535]</p>
243
246
<p>Default value: 4951</p>
244
247
</div>
245
248
<hr>
246
249
<div class="refsect2" lang="en">
247
 
<a name="id2627536"></a><h3>
 
250
<a name="id339015"></a><h3>
248
251
<a name="GstUDPSrc--uri"></a>The "<code class="literal">uri</code>" property</h3>
249
 
<a class="indexterm" name="id2627551"></a><pre class="programlisting">  "uri"                  <a
250
 
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
251
 
>gchararray</a>            : Read / Write</pre>
 
252
<a class="indexterm" name="id339028"></a><pre class="programlisting">  "uri"                  gchararray            : Read / Write</pre>
252
253
<p>URI in the form of udp://multicast_group:port.</p>
253
254
<p>Default value: "udp://0.0.0.0:4951"</p>
254
255
</div>
255
256
<hr>
256
257
<div class="refsect2" lang="en">
257
 
<a name="id2627577"></a><h3>
 
258
<a name="id339050"></a><h3>
258
259
<a name="GstUDPSrc--sockfd"></a>The "<code class="literal">sockfd</code>" property</h3>
259
 
<a class="indexterm" name="id2627592"></a><pre class="programlisting">  "sockfd"               <a
260
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
261
 
>gint</a>                  : Read / Write</pre>
 
260
<a class="indexterm" name="id339062"></a><pre class="programlisting">  "sockfd"               gint                  : Read / Write</pre>
262
261
<p>Socket to use for UDP reception. (-1 == allocate).</p>
263
 
<p>Allowed values: &gt;= -1</p>
 
262
<p>Allowed values: &gt;= G_MAXULONG</p>
264
263
<p>Default value: -1</p>
265
264
</div>
 
265
<hr>
 
266
<div class="refsect2" lang="en">
 
267
<a name="id339087"></a><h3>
 
268
<a name="GstUDPSrc--buffer-size"></a>The "<code class="literal">buffer-size</code>" property</h3>
 
269
<a class="indexterm" name="id339100"></a><pre class="programlisting">  "buffer-size"          gint                  : Read / Write</pre>
 
270
<p>Size of the kernel receive buffer in bytes, 0=default.</p>
 
271
<p>Allowed values: &gt;= 0</p>
 
272
<p>Default value: 0</p>
 
273
</div>
 
274
<hr>
 
275
<div class="refsect2" lang="en">
 
276
<a name="id339125"></a><h3>
 
277
<a name="GstUDPSrc--timeout"></a>The "<code class="literal">timeout</code>" property</h3>
 
278
<a class="indexterm" name="id339138"></a><pre class="programlisting">  "timeout"              guint64               : Read / Write</pre>
 
279
<p>Post a message after timeout microseconds (0 = disabled).</p>
 
280
<p>Default value: 0</p>
 
281
</div>
266
282
</div>
267
283
<div class="refsect1" lang="en">
268
 
<a name="id2657260"></a><h2>See Also</h2>
 
284
<a name="id339161"></a><h2>See Also</h2>
269
285
udpsink, multifdsink
270
286
</div>
271
287
</div>