docs/plugins/html/gst-plugins-good-plugins-udpsink.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>udpsink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-udpsrc.html" title="udpsrc">
  10 <link rel="next" href="gst-plugins-good-plugins-v4l2src.html" title="v4l2src">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-good-plugins-udpsrc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-v4l2src.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-good-plugins-udpsink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-udpsink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-udpsink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-udpsink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-udpsink.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-udpsink"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-udpsink.top_of_page"></a>udpsink</span></h2>
  40 <p>udpsink — Send data over the network via UDP</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-good-plugins-udpsink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstUDPSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-udpsink.html#GstUDPSink-struct" title="struct GstUDPSink">GstUDPSink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-udpsink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  56                      +----<a class="link" href="gst-plugins-good-plugins-multiudpsink.html#GstMultiUDPSink">GstMultiUDPSink</a>
  57                            +----GstUDPSink
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gst-plugins-good-plugins-udpsink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  62 <p>
  63 GstUDPSink implements
  64  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-good-plugins-udpsink.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="gst-plugins-good-plugins-udpsink.html#GstUDPSink--host" title='The "host" property'>host</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  70   "<a class="link" href="gst-plugins-good-plugins-udpsink.html#GstUDPSink--port" title='The "port" property'>port</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  71 </pre>
  72 </div>
  73 <div class="refsect1">
  74 <a name="gst-plugins-good-plugins-udpsink.description"></a><h2>Description</h2>
  75 <p>
  76 udpsink is a network sink that sends UDP packets to the network.
  77 It can be combined with RTP payloaders to implement RTP streaming.
  78 </p>
  79 <p>
  80 </p>
  81 <div class="refsect2">
  82 <a name="idp19336848"></a><h3>Examples</h3>
  83 <div class="informalexample">
  84   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  85     <tbody>
  86       <tr>
  87         <td class="listing_lines" align="right"><pre>1</pre></td>
  88         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v audiotestsrc <span class="gtkdoc opt">!</span> udpsink</pre></td>
  89       </tr>
  90     </tbody>
  91   </table>
  92 </div>
  93
  94 </div>
  95 <p>
  96 </p>
  97 <div class="refsynopsisdiv">
  98 <h2>Synopsis</h2>
  99 <div class="refsect2">
 100 <a name="idp22372000"></a><h3>Element Information</h3>
 101 <div class="variablelist"><table border="0">
 102 <col align="left" valign="top">
 103 <tbody>
 104 <tr>
 105 <td><p><span class="term">plugin</span></p></td>
 106 <td>
 107             <a class="link" href="gst-plugins-good-plugins-plugin-udp.html#plugin-udp">udp</a>
 108           </td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term">author</span></p></td>
 112 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">class</span></p></td>
 116 <td>Sink/Network</td>
 117 </tr>
 118 </tbody>
 119 </table></div>
 120 </div>
 121 <hr>
 122 <div class="refsect2">
 123 <a name="idp20057472"></a><h3>Element Pads</h3>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody>
 127 <tr>
 128 <td><p><span class="term">name</span></p></td>
 129 <td>sink</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">direction</span></p></td>
 133 <td>sink</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">presence</span></p></td>
 137 <td>always</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">details</span></p></td>
 141 <td>ANY</td>
 142 </tr>
 143 </tbody>
 144 </table></div>
 145 </div>
 146 </div>
 147 <p>
 148 </p>
 149 </div>
 150 <div class="refsect1">
 151 <a name="gst-plugins-good-plugins-udpsink.details"></a><h2>Details</h2>
 152 <div class="refsect2">
 153 <a name="GstUDPSink-struct"></a><h3>struct GstUDPSink</h3>
 154 <pre class="programlisting">struct GstUDPSink;</pre>
 155 <p>
 156 </p>
 157 </div>
 158 </div>
 159 <div class="refsect1">
 160 <a name="gst-plugins-good-plugins-udpsink.property-details"></a><h2>Property Details</h2>
 161 <div class="refsect2">
 162 <a name="GstUDPSink--host"></a><h3>The <code class="literal">"host"</code> property</h3>
 163 <pre class="programlisting">  "host"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 164 <p>The host/IP/Multicast group to send the packets to.</p>
 165 <p>Default value: "localhost"</p>
 166 </div>
 167 <hr>
 168 <div class="refsect2">
 169 <a name="GstUDPSink--port"></a><h3>The <code class="literal">"port"</code> property</h3>
 170 <pre class="programlisting">  "port"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 171 <p>The port to send the packets to.</p>
 172 <p>Allowed values: [0,65535]</p>
 173 <p>Default value: 4951</p>
 174 </div>
 175 </div>
 176 <div class="refsect1">
 177 <a name="gst-plugins-good-plugins-udpsink.see-also"></a><h2>See Also</h2>
 178 udpsrc, multifdsink
 179 </div>
 180 </div>
 181 <div class="footer">
 182 <hr>
 183           Generated by GTK-Doc V1.18</div>
 184 </body>
 185 </html>