1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>multiudpsink: GStreamer Good Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-good Elements"> 9<link rel="prev" href="gst-plugins-good-plugins-multipartmux.html" title="multipartmux"> 10<link rel="next" href="gst-plugins-good-plugins-navigationtest.html" title="navigationtest"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><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-good-plugins-multiudpsink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-multiudpsink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-multiudpsink.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 21 <a href="#gst-plugins-good-plugins-multiudpsink.signals" class="shortcut">Signals</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-good-plugins-multipartmux.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-good-plugins-navigationtest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-good-plugins-multiudpsink"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-multiudpsink.top_of_page"></a>multiudpsink</span></h2> 33<p>multiudpsink</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-good-plugins-multiudpsink.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--bytes-served" title="The “bytes-served” property">bytes-served</a></td> 49<td class="property_flags">Read</td> 50</tr> 51<tr> 52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--bytes-to-serve" title="The “bytes-to-serve” property">bytes-to-serve</a></td> 54<td class="property_flags">Read</td> 55</tr> 56<tr> 57<td class="property_type"> 58<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 59<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--clients" title="The “clients” property">clients</a></td> 60<td class="property_flags">Read / Write</td> 61</tr> 62<tr> 63<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 64<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--auto-multicast" title="The “auto-multicast” property">auto-multicast</a></td> 65<td class="property_flags">Read / Write</td> 66</tr> 67<tr> 68<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 69<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--loop" title="The “loop” property">loop</a></td> 70<td class="property_flags">Read / Write</td> 71</tr> 72<tr> 73<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 74<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--qos-dscp" title="The “qos-dscp” property">qos-dscp</a></td> 75<td class="property_flags">Read / Write</td> 76</tr> 77<tr> 78<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 79<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--ttl" title="The “ttl” property">ttl</a></td> 80<td class="property_flags">Read / Write</td> 81</tr> 82<tr> 83<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 84<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--ttl-mc" title="The “ttl-mc” property">ttl-mc</a></td> 85<td class="property_flags">Read / Write</td> 86</tr> 87<tr> 88<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 89<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--send-duplicates" title="The “send-duplicates” property">send-duplicates</a></td> 90<td class="property_flags">Read / Write</td> 91</tr> 92<tr> 93<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 94<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--buffer-size" title="The “buffer-size” property">buffer-size</a></td> 95<td class="property_flags">Read / Write</td> 96</tr> 97<tr> 98<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 99<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--close-socket" title="The “close-socket” property">close-socket</a></td> 100<td class="property_flags">Read / Write</td> 101</tr> 102<tr> 103<td class="property_type"> 104<a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</td> 105<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--socket" title="The “socket” property">socket</a></td> 106<td class="property_flags">Read / Write</td> 107</tr> 108<tr> 109<td class="property_type"> 110<a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</td> 111<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--used-socket" title="The “used-socket” property">used-socket</a></td> 112<td class="property_flags">Read</td> 113</tr> 114<tr> 115<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 116<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--force-ipv4" title="The “force-ipv4” property">force-ipv4</a></td> 117<td class="property_flags">Read / Write</td> 118</tr> 119<tr> 120<td class="property_type"> 121<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 122<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--multicast-iface" title="The “multicast-iface” property">multicast-iface</a></td> 123<td class="property_flags">Read / Write</td> 124</tr> 125<tr> 126<td class="property_type"> 127<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 128<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--bind-address" title="The “bind-address” property">bind-address</a></td> 129<td class="property_flags">Read / Write</td> 130</tr> 131<tr> 132<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 133<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--bind-port" title="The “bind-port” property">bind-port</a></td> 134<td class="property_flags">Read / Write</td> 135</tr> 136<tr> 137<td class="property_type"> 138<a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</td> 139<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--socket-v6" title="The “socket-v6” property">socket-v6</a></td> 140<td class="property_flags">Read / Write</td> 141</tr> 142<tr> 143<td class="property_type"> 144<a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</td> 145<td class="property_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink--used-socket-v6" title="The “used-socket-v6” property">used-socket-v6</a></td> 146<td class="property_flags">Read</td> 147</tr> 148</tbody> 149</table></div> 150</div> 151<div class="refsect1"> 152<a name="gst-plugins-good-plugins-multiudpsink.signals"></a><h2>Signals</h2> 153<div class="informaltable"><table class="informaltable" border="0"> 154<colgroup> 155<col width="150px" class="signals_return"> 156<col width="300px" class="signals_name"> 157<col width="200px" class="signals_flags"> 158</colgroup> 159<tbody> 160<tr> 161<td class="signal_type"><span class="returnvalue">void</span></td> 162<td class="signal_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink-add" title="The “add” signal">add</a></td> 163<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td> 164</tr> 165<tr> 166<td class="signal_type"><span class="returnvalue">void</span></td> 167<td class="signal_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink-clear" title="The “clear” signal">clear</a></td> 168<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td> 169</tr> 170<tr> 171<td class="signal_type"><span class="returnvalue">void</span></td> 172<td class="signal_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink-client-added" title="The “client-added” signal">client-added</a></td> 173<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> 174</tr> 175<tr> 176<td class="signal_type"><span class="returnvalue">void</span></td> 177<td class="signal_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink-client-removed" title="The “client-removed” signal">client-removed</a></td> 178<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> 179</tr> 180<tr> 181<td class="signal_type"> 182<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="returnvalue">GstStructure</span></a>*</td> 183<td class="signal_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink-get-stats" title="The “get-stats” signal">get-stats</a></td> 184<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td> 185</tr> 186<tr> 187<td class="signal_type"><span class="returnvalue">void</span></td> 188<td class="signal_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink-remove" title="The “remove” signal">remove</a></td> 189<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td> 190</tr> 191</tbody> 192</table></div> 193</div> 194<a name="GstMultiUDPSink"></a><div class="refsect1"> 195<a name="gst-plugins-good-plugins-multiudpsink.other"></a><h2>Types and Values</h2> 196<div class="informaltable"><table class="informaltable" width="100%" border="0"> 197<colgroup> 198<col width="150px" class="name"> 199<col class="description"> 200</colgroup> 201<tbody><tr> 202<td class="datatype_keyword">struct</td> 203<td class="function_name"><a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink-struct" title="struct GstMultiUDPSink">GstMultiUDPSink</a></td> 204</tr></tbody> 205</table></div> 206</div> 207<div class="refsect1"> 208<a name="gst-plugins-good-plugins-multiudpsink.object-hierarchy"></a><h2>Object Hierarchy</h2> 209<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 210 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 211 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 212 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 213 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 214 <span class="lineart">╰──</span> GstMultiUDPSink 215 <span class="lineart">╰──</span> <a class="link" href="gst-plugins-good-plugins-udpsink.html#GstUDPSink">GstUDPSink</a> 216</pre> 217</div> 218<div class="refsect1"> 219<a name="gst-plugins-good-plugins-multiudpsink.description"></a><h2>Description</h2> 220<p>multiudpsink is a network sink that sends UDP packets to multiple 221clients. 222It can be combined with rtp payload encoders to implement RTP streaming.</p> 223<div class="refsynopsisdiv"> 224<h2>Synopsis</h2> 225<div class="refsect2"> 226<a name="id-1.2.102.8.3.1"></a><h3>Element Information</h3> 227<div class="variablelist"><table border="0" class="variablelist"> 228<colgroup> 229<col align="left" valign="top"> 230<col> 231</colgroup> 232<tbody> 233<tr> 234<td><p><span class="term">plugin</span></p></td> 235<td> 236 <a class="link" href="gst-plugins-good-plugins-plugin-udp.html#plugin-udp">udp</a> 237 </td> 238</tr> 239<tr> 240<td><p><span class="term">author</span></p></td> 241<td>Wim Taymans <wim.taymans@gmail.com></td> 242</tr> 243<tr> 244<td><p><span class="term">class</span></p></td> 245<td>Sink/Network</td> 246</tr> 247</tbody> 248</table></div> 249</div> 250<hr> 251<div class="refsect2"> 252<a name="id-1.2.102.8.3.2"></a><h3>Element Pads</h3> 253<div class="variablelist"><table border="0" class="variablelist"> 254<colgroup> 255<col align="left" valign="top"> 256<col> 257</colgroup> 258<tbody> 259<tr> 260<td><p><span class="term">name</span></p></td> 261<td>sink</td> 262</tr> 263<tr> 264<td><p><span class="term">direction</span></p></td> 265<td>sink</td> 266</tr> 267<tr> 268<td><p><span class="term">presence</span></p></td> 269<td>always</td> 270</tr> 271<tr> 272<td><p><span class="term">details</span></p></td> 273<td>ANY</td> 274</tr> 275</tbody> 276</table></div> 277</div> 278</div> 279</div> 280<div class="refsect1"> 281<a name="gst-plugins-good-plugins-multiudpsink.functions_details"></a><h2>Functions</h2> 282<p></p> 283</div> 284<div class="refsect1"> 285<a name="gst-plugins-good-plugins-multiudpsink.other_details"></a><h2>Types and Values</h2> 286<div class="refsect2"> 287<a name="GstMultiUDPSink-struct"></a><h3>struct GstMultiUDPSink</h3> 288<pre class="programlisting">struct GstMultiUDPSink;</pre> 289</div> 290</div> 291<div class="refsect1"> 292<a name="gst-plugins-good-plugins-multiudpsink.property-details"></a><h2>Property Details</h2> 293<div class="refsect2"> 294<a name="GstMultiUDPSink--bytes-served"></a><h3>The <code class="literal">“bytes-served”</code> property</h3> 295<pre class="programlisting"> “bytes-served” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 296<p>Total number of bytes sent to all clients.</p> 297<p>Flags: Read</p> 298<p>Default value: 0</p> 299</div> 300<hr> 301<div class="refsect2"> 302<a name="GstMultiUDPSink--bytes-to-serve"></a><h3>The <code class="literal">“bytes-to-serve”</code> property</h3> 303<pre class="programlisting"> “bytes-to-serve” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 304<p>Number of bytes received to serve to clients.</p> 305<p>Flags: Read</p> 306<p>Default value: 0</p> 307</div> 308<hr> 309<div class="refsect2"> 310<a name="GstMultiUDPSink--clients"></a><h3>The <code class="literal">“clients”</code> property</h3> 311<pre class="programlisting"> “clients” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 312<p>A comma separated list of host:port pairs with destinations.</p> 313<p>Flags: Read / Write</p> 314<p>Default value: NULL</p> 315</div> 316<hr> 317<div class="refsect2"> 318<a name="GstMultiUDPSink--auto-multicast"></a><h3>The <code class="literal">“auto-multicast”</code> property</h3> 319<pre class="programlisting"> “auto-multicast” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 320<p>Automatically join/leave the multicast groups, FALSE means user has to do it himself.</p> 321<p>Flags: Read / Write</p> 322<p>Default value: TRUE</p> 323</div> 324<hr> 325<div class="refsect2"> 326<a name="GstMultiUDPSink--loop"></a><h3>The <code class="literal">“loop”</code> property</h3> 327<pre class="programlisting"> “loop” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 328<p>Used for setting the multicast loop parameter. TRUE = enable, FALSE = disable.</p> 329<p>Flags: Read / Write</p> 330<p>Default value: TRUE</p> 331</div> 332<hr> 333<div class="refsect2"> 334<a name="GstMultiUDPSink--qos-dscp"></a><h3>The <code class="literal">“qos-dscp”</code> property</h3> 335<pre class="programlisting"> “qos-dscp” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 336<p>Quality of Service, differentiated services code point (-1 default).</p> 337<p>Flags: Read / Write</p> 338<p>Allowed values: [G_MAXULONG,63]</p> 339<p>Default value: -1</p> 340</div> 341<hr> 342<div class="refsect2"> 343<a name="GstMultiUDPSink--ttl"></a><h3>The <code class="literal">“ttl”</code> property</h3> 344<pre class="programlisting"> “ttl” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 345<p>Used for setting the unicast TTL parameter.</p> 346<p>Flags: Read / Write</p> 347<p>Allowed values: [0,255]</p> 348<p>Default value: 64</p> 349</div> 350<hr> 351<div class="refsect2"> 352<a name="GstMultiUDPSink--ttl-mc"></a><h3>The <code class="literal">“ttl-mc”</code> property</h3> 353<pre class="programlisting"> “ttl-mc” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 354<p>Used for setting the multicast TTL parameter.</p> 355<p>Flags: Read / Write</p> 356<p>Allowed values: [0,255]</p> 357<p>Default value: 1</p> 358</div> 359<hr> 360<div class="refsect2"> 361<a name="GstMultiUDPSink--send-duplicates"></a><h3>The <code class="literal">“send-duplicates”</code> property</h3> 362<pre class="programlisting"> “send-duplicates” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 363<p>When a distination/port pair is added multiple times, send packets multiple times as well.</p> 364<p>Flags: Read / Write</p> 365<p>Default value: TRUE</p> 366</div> 367<hr> 368<div class="refsect2"> 369<a name="GstMultiUDPSink--buffer-size"></a><h3>The <code class="literal">“buffer-size”</code> property</h3> 370<pre class="programlisting"> “buffer-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 371<p>Size of the kernel send buffer in bytes, 0=default.</p> 372<p>Flags: Read / Write</p> 373<p>Allowed values: >= 0</p> 374<p>Default value: 0</p> 375</div> 376<hr> 377<div class="refsect2"> 378<a name="GstMultiUDPSink--close-socket"></a><h3>The <code class="literal">“close-socket”</code> property</h3> 379<pre class="programlisting"> “close-socket” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 380<p>Close socket if passed as property on state change.</p> 381<p>Flags: Read / Write</p> 382<p>Default value: TRUE</p> 383</div> 384<hr> 385<div class="refsect2"> 386<a name="GstMultiUDPSink--socket"></a><h3>The <code class="literal">“socket”</code> property</h3> 387<pre class="programlisting"> “socket” <a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</pre> 388<p>Socket to use for UDP sending. (NULL == allocate).</p> 389<p>Flags: Read / Write</p> 390</div> 391<hr> 392<div class="refsect2"> 393<a name="GstMultiUDPSink--used-socket"></a><h3>The <code class="literal">“used-socket”</code> property</h3> 394<pre class="programlisting"> “used-socket” <a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</pre> 395<p>Socket currently in use for UDP sending. (NULL == no socket).</p> 396<p>Flags: Read</p> 397</div> 398<hr> 399<div class="refsect2"> 400<a name="GstMultiUDPSink--force-ipv4"></a><h3>The <code class="literal">“force-ipv4”</code> property</h3> 401<pre class="programlisting"> “force-ipv4” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 402<p>Forcing the use of an IPv4 socket (DEPRECATED, has no effect anymore).</p> 403<p>Flags: Read / Write</p> 404<p>Default value: FALSE</p> 405</div> 406<hr> 407<div class="refsect2"> 408<a name="GstMultiUDPSink--multicast-iface"></a><h3>The <code class="literal">“multicast-iface”</code> property</h3> 409<pre class="programlisting"> “multicast-iface” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 410<p>The network interface on which to join the multicast group.</p> 411<p>Flags: Read / Write</p> 412<p>Default value: NULL</p> 413</div> 414<hr> 415<div class="refsect2"> 416<a name="GstMultiUDPSink--bind-address"></a><h3>The <code class="literal">“bind-address”</code> property</h3> 417<pre class="programlisting"> “bind-address” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 418<p>Address to bind the socket to.</p> 419<p>Flags: Read / Write</p> 420<p>Default value: NULL</p> 421</div> 422<hr> 423<div class="refsect2"> 424<a name="GstMultiUDPSink--bind-port"></a><h3>The <code class="literal">“bind-port”</code> property</h3> 425<pre class="programlisting"> “bind-port” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 426<p>Port to bind the socket to.</p> 427<p>Flags: Read / Write</p> 428<p>Allowed values: [0,65535]</p> 429<p>Default value: 0</p> 430</div> 431<hr> 432<div class="refsect2"> 433<a name="GstMultiUDPSink--socket-v6"></a><h3>The <code class="literal">“socket-v6”</code> property</h3> 434<pre class="programlisting"> “socket-v6” <a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</pre> 435<p>Socket to use for UDPv6 sending. (NULL == allocate).</p> 436<p>Flags: Read / Write</p> 437</div> 438<hr> 439<div class="refsect2"> 440<a name="GstMultiUDPSink--used-socket-v6"></a><h3>The <code class="literal">“used-socket-v6”</code> property</h3> 441<pre class="programlisting"> “used-socket-v6” <a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</pre> 442<p>Socket currently in use for UDPv6 sending. (NULL == no socket).</p> 443<p>Flags: Read</p> 444</div> 445</div> 446<div class="refsect1"> 447<a name="gst-plugins-good-plugins-multiudpsink.signal-details"></a><h2>Signal Details</h2> 448<div class="refsect2"> 449<a name="GstMultiUDPSink-add"></a><h3>The <code class="literal">“add”</code> signal</h3> 450<pre class="programlisting"><span class="returnvalue">void</span> 451user_function (<a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink"><span class="type">GstMultiUDPSink</span></a> *gstmultiudpsink, 452 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host, 453 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port, 454 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 455<p>Add a client with destination <em class="parameter"><code>host</code></em> 456 and <em class="parameter"><code>port</code></em> 457 to the list of 458clients. When the same host/port pair is added multiple times, the 459send-duplicates property defines if the packets are sent multiple times to 460the same host/port pair or not.</p> 461<p>When a host/port pair is added multiple times, an equal amount of remove 462calls must be performed to actually remove the host/port pair from the list 463of destinations.</p> 464<div class="refsect3"> 465<a name="GstMultiUDPSink-add.parameters"></a><h4>Parameters</h4> 466<div class="informaltable"><table class="informaltable" width="100%" border="0"> 467<colgroup> 468<col width="150px" class="parameters_name"> 469<col class="parameters_description"> 470<col width="200px" class="parameters_annotations"> 471</colgroup> 472<tbody> 473<tr> 474<td class="parameter_name"><p>gstmultiudpsink</p></td> 475<td class="parameter_description"><p>the sink on which the signal is emitted</p></td> 476<td class="parameter_annotations"> </td> 477</tr> 478<tr> 479<td class="parameter_name"><p>host</p></td> 480<td class="parameter_description"><p>the hostname/IP address of the client to add</p></td> 481<td class="parameter_annotations"> </td> 482</tr> 483<tr> 484<td class="parameter_name"><p>port</p></td> 485<td class="parameter_description"><p>the port of the client to add</p></td> 486<td class="parameter_annotations"> </td> 487</tr> 488<tr> 489<td class="parameter_name"><p>user_data</p></td> 490<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> 491<td class="parameter_annotations"> </td> 492</tr> 493</tbody> 494</table></div> 495</div> 496<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p> 497</div> 498<hr> 499<div class="refsect2"> 500<a name="GstMultiUDPSink-clear"></a><h3>The <code class="literal">“clear”</code> signal</h3> 501<pre class="programlisting"><span class="returnvalue">void</span> 502user_function (<a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink"><span class="type">GstMultiUDPSink</span></a> *gstmultiudpsink, 503 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 504<p>Clear the list of clients.</p> 505<div class="refsect3"> 506<a name="GstMultiUDPSink-clear.parameters"></a><h4>Parameters</h4> 507<div class="informaltable"><table class="informaltable" width="100%" border="0"> 508<colgroup> 509<col width="150px" class="parameters_name"> 510<col class="parameters_description"> 511<col width="200px" class="parameters_annotations"> 512</colgroup> 513<tbody> 514<tr> 515<td class="parameter_name"><p>gstmultiudpsink</p></td> 516<td class="parameter_description"><p>the sink on which the signal is emitted</p></td> 517<td class="parameter_annotations"> </td> 518</tr> 519<tr> 520<td class="parameter_name"><p>user_data</p></td> 521<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> 522<td class="parameter_annotations"> </td> 523</tr> 524</tbody> 525</table></div> 526</div> 527<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p> 528</div> 529<hr> 530<div class="refsect2"> 531<a name="GstMultiUDPSink-client-added"></a><h3>The <code class="literal">“client-added”</code> signal</h3> 532<pre class="programlisting"><span class="returnvalue">void</span> 533user_function (<a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink"><span class="type">GstMultiUDPSink</span></a> *gstmultiudpsink, 534 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host, 535 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port, 536 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 537<p>Signal emitted when a new client is added to the list of 538clients.</p> 539<div class="refsect3"> 540<a name="GstMultiUDPSink-client-added.parameters"></a><h4>Parameters</h4> 541<div class="informaltable"><table class="informaltable" width="100%" border="0"> 542<colgroup> 543<col width="150px" class="parameters_name"> 544<col class="parameters_description"> 545<col width="200px" class="parameters_annotations"> 546</colgroup> 547<tbody> 548<tr> 549<td class="parameter_name"><p>gstmultiudpsink</p></td> 550<td class="parameter_description"><p>the sink emitting the signal</p></td> 551<td class="parameter_annotations"> </td> 552</tr> 553<tr> 554<td class="parameter_name"><p>host</p></td> 555<td class="parameter_description"><p>the hostname/IP address of the added client</p></td> 556<td class="parameter_annotations"> </td> 557</tr> 558<tr> 559<td class="parameter_name"><p>port</p></td> 560<td class="parameter_description"><p>the port of the added client</p></td> 561<td class="parameter_annotations"> </td> 562</tr> 563<tr> 564<td class="parameter_name"><p>user_data</p></td> 565<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> 566<td class="parameter_annotations"> </td> 567</tr> 568</tbody> 569</table></div> 570</div> 571<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> 572</div> 573<hr> 574<div class="refsect2"> 575<a name="GstMultiUDPSink-client-removed"></a><h3>The <code class="literal">“client-removed”</code> signal</h3> 576<pre class="programlisting"><span class="returnvalue">void</span> 577user_function (<a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink"><span class="type">GstMultiUDPSink</span></a> *gstmultiudpsink, 578 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host, 579 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port, 580 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 581<p>Signal emitted when a client is removed from the list of 582clients.</p> 583<div class="refsect3"> 584<a name="GstMultiUDPSink-client-removed.parameters"></a><h4>Parameters</h4> 585<div class="informaltable"><table class="informaltable" width="100%" border="0"> 586<colgroup> 587<col width="150px" class="parameters_name"> 588<col class="parameters_description"> 589<col width="200px" class="parameters_annotations"> 590</colgroup> 591<tbody> 592<tr> 593<td class="parameter_name"><p>gstmultiudpsink</p></td> 594<td class="parameter_description"><p>the sink emitting the signal</p></td> 595<td class="parameter_annotations"> </td> 596</tr> 597<tr> 598<td class="parameter_name"><p>host</p></td> 599<td class="parameter_description"><p>the hostname/IP address of the removed client</p></td> 600<td class="parameter_annotations"> </td> 601</tr> 602<tr> 603<td class="parameter_name"><p>port</p></td> 604<td class="parameter_description"><p>the port of the removed client</p></td> 605<td class="parameter_annotations"> </td> 606</tr> 607<tr> 608<td class="parameter_name"><p>user_data</p></td> 609<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> 610<td class="parameter_annotations"> </td> 611</tr> 612</tbody> 613</table></div> 614</div> 615<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> 616</div> 617<hr> 618<div class="refsect2"> 619<a name="GstMultiUDPSink-get-stats"></a><h3>The <code class="literal">“get-stats”</code> signal</h3> 620<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="returnvalue">GstStructure</span></a>* 621user_function (<a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink"><span class="type">GstMultiUDPSink</span></a> *gstmultiudpsink, 622 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host, 623 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port, 624 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 625<p>Get the statistics of the client with destination <em class="parameter"><code>host</code></em> 626 and <em class="parameter"><code>port</code></em> 627.</p> 628<div class="refsect3"> 629<a name="GstMultiUDPSink-get-stats.parameters"></a><h4>Parameters</h4> 630<div class="informaltable"><table class="informaltable" width="100%" border="0"> 631<colgroup> 632<col width="150px" class="parameters_name"> 633<col class="parameters_description"> 634<col width="200px" class="parameters_annotations"> 635</colgroup> 636<tbody> 637<tr> 638<td class="parameter_name"><p>gstmultiudpsink</p></td> 639<td class="parameter_description"><p>the sink on which the signal is emitted</p></td> 640<td class="parameter_annotations"> </td> 641</tr> 642<tr> 643<td class="parameter_name"><p>host</p></td> 644<td class="parameter_description"><p>the hostname/IP address of the client to get stats on</p></td> 645<td class="parameter_annotations"> </td> 646</tr> 647<tr> 648<td class="parameter_name"><p>port</p></td> 649<td class="parameter_description"><p>the port of the client to get stats on</p></td> 650<td class="parameter_annotations"> </td> 651</tr> 652<tr> 653<td class="parameter_name"><p>user_data</p></td> 654<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> 655<td class="parameter_annotations"> </td> 656</tr> 657</tbody> 658</table></div> 659</div> 660<div class="refsect3"> 661<a name="GstMultiUDPSink-get-stats.returns"></a><h4>Returns</h4> 662<p> a GstStructure: bytes_sent, packets_sent, 663connect_time (in epoch seconds), disconnect_time (in epoch seconds)</p> 664</div> 665<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p> 666</div> 667<hr> 668<div class="refsect2"> 669<a name="GstMultiUDPSink-remove"></a><h3>The <code class="literal">“remove”</code> signal</h3> 670<pre class="programlisting"><span class="returnvalue">void</span> 671user_function (<a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink"><span class="type">GstMultiUDPSink</span></a> *gstmultiudpsink, 672 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host, 673 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port, 674 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 675<p>Remove the client with destination <em class="parameter"><code>host</code></em> 676 and <em class="parameter"><code>port</code></em> 677 from the list of 678clients.</p> 679<div class="refsect3"> 680<a name="GstMultiUDPSink-remove.parameters"></a><h4>Parameters</h4> 681<div class="informaltable"><table class="informaltable" width="100%" border="0"> 682<colgroup> 683<col width="150px" class="parameters_name"> 684<col class="parameters_description"> 685<col width="200px" class="parameters_annotations"> 686</colgroup> 687<tbody> 688<tr> 689<td class="parameter_name"><p>gstmultiudpsink</p></td> 690<td class="parameter_description"><p>the sink on which the signal is emitted</p></td> 691<td class="parameter_annotations"> </td> 692</tr> 693<tr> 694<td class="parameter_name"><p>host</p></td> 695<td class="parameter_description"><p>the hostname/IP address of the client to remove</p></td> 696<td class="parameter_annotations"> </td> 697</tr> 698<tr> 699<td class="parameter_name"><p>port</p></td> 700<td class="parameter_description"><p>the port of the client to remove</p></td> 701<td class="parameter_annotations"> </td> 702</tr> 703<tr> 704<td class="parameter_name"><p>user_data</p></td> 705<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> 706<td class="parameter_annotations"> </td> 707</tr> 708</tbody> 709</table></div> 710</div> 711<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p> 712</div> 713</div> 714<div class="refsect1"> 715<a name="gst-plugins-good-plugins-multiudpsink.see-also"></a><h2>See Also</h2> 716<p>udpsink, multifdsink</p> 717</div> 718</div> 719<div class="footer"> 720<hr>Generated by GTK-Doc V1.28</div> 721</body> 722</html>
