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>tcpclientsrc: GStreamer Base 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 Base Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-base Elements"> 9<link rel="prev" href="gst-plugins-base-plugins-tcpclientsink.html" title="tcpclientsink"> 10<link rel="next" href="gst-plugins-base-plugins-tcpserversink.html" title="tcpserversink"> 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-base-plugins-tcpclientsrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-tcpclientsrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-tcpclientsrc.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-base-plugins-tcpclientsink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-base-plugins-tcpserversink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-base-plugins-tcpclientsrc"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-tcpclientsrc.top_of_page"></a>tcpclientsrc</span></h2> 32<p>tcpclientsrc</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-base-plugins-tcpclientsrc.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"> 47<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 48<td class="property_name"><a class="link" href="gst-plugins-base-plugins-tcpclientsrc.html#GstTCPClientSrc--host" title="The “host” property">host</a></td> 49<td class="property_flags">Read / Write</td> 50</tr> 51<tr> 52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-base-plugins-tcpclientsrc.html#GstTCPClientSrc--port" title="The “port” property">port</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-base-plugins-tcpclientsrc.html#GstTCPClientSrc--timeout" title="The “timeout” property">timeout</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61</tbody> 62</table></div> 63</div> 64<a name="GstTCPClientSrc"></a><div class="refsect1"> 65<a name="gst-plugins-base-plugins-tcpclientsrc.other"></a><h2>Types and Values</h2> 66<div class="informaltable"><table class="informaltable" width="100%" border="0"> 67<colgroup> 68<col width="150px" class="name"> 69<col class="description"> 70</colgroup> 71<tbody><tr> 72<td class="datatype_keyword">struct</td> 73<td class="function_name"><a class="link" href="gst-plugins-base-plugins-tcpclientsrc.html#GstTCPClientSrc-struct" title="struct GstTCPClientSrc">GstTCPClientSrc</a></td> 74</tr></tbody> 75</table></div> 76</div> 77<div class="refsect1"> 78<a name="gst-plugins-base-plugins-tcpclientsrc.object-hierarchy"></a><h2>Object Hierarchy</h2> 79<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 80 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 82 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 83 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSrc.html#GstBaseSrc-struct">GstBaseSrc</a> 84 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstPushSrc.html#GstPushSrc-struct">GstPushSrc</a> 85 <span class="lineart">╰──</span> GstTCPClientSrc 86</pre> 87</div> 88<div class="refsect1"> 89<a name="gst-plugins-base-plugins-tcpclientsrc.description"></a><h2>Description</h2> 90<div class="refsect3"> 91<a name="id-1.2.94.7.2"></a><h4>Example launch line (server):</h4> 92<div class="informalexample"> 93 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 94 <tbody> 95 <tr> 96 <td class="listing_lines" align="right"><pre>1</pre></td> 97 <td class="listing_code"><pre class="programlisting">nc <span class="gtkdoc opt">-</span>l <span class="gtkdoc opt">-</span>p <span class="number">3000</span></pre></td> 98 </tr> 99 </tbody> 100 </table> 101</div> 102 103<p></p> 104</div> 105<div class="refsect3"> 106<a name="id-1.2.94.7.3"></a><h4>Example launch line (client):</h4> 107<div class="informalexample"> 108 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 109 <tbody> 110 <tr> 111 <td class="listing_lines" align="right"><pre>1</pre></td> 112 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> tcpclientsrc port<span class="gtkdoc opt">=</span><span class="number">3000</span> <span class="gtkdoc opt">!</span> fdsink fd<span class="gtkdoc opt">=</span><span class="number">2</span></pre></td> 113 </tr> 114 </tbody> 115 </table> 116</div> 117 118<p> 119 everything you type in the server is shown on the client. 120If you want to detect network failures and/or limit the time your tcp client 121keeps waiting for data from server setting a timeout value can be useful.</p> 122</div> 123<div class="refsynopsisdiv"> 124<h2>Synopsis</h2> 125<div class="refsect2"> 126<a name="id-1.2.94.7.4.1"></a><h3>Element Information</h3> 127<div class="variablelist"><table border="0" class="variablelist"> 128<colgroup> 129<col align="left" valign="top"> 130<col> 131</colgroup> 132<tbody> 133<tr> 134<td><p><span class="term">plugin</span></p></td> 135<td> 136 <a class="link" href="gst-plugins-base-plugins-plugin-tcp.html#plugin-tcp">tcp</a> 137 </td> 138</tr> 139<tr> 140<td><p><span class="term">author</span></p></td> 141<td>Thomas Vander Stichele <thomas at apestaart dot org></td> 142</tr> 143<tr> 144<td><p><span class="term">class</span></p></td> 145<td>Source/Network</td> 146</tr> 147</tbody> 148</table></div> 149</div> 150<hr> 151<div class="refsect2"> 152<a name="id-1.2.94.7.4.2"></a><h3>Element Pads</h3> 153<div class="variablelist"><table border="0" class="variablelist"> 154<colgroup> 155<col align="left" valign="top"> 156<col> 157</colgroup> 158<tbody> 159<tr> 160<td><p><span class="term">name</span></p></td> 161<td>src</td> 162</tr> 163<tr> 164<td><p><span class="term">direction</span></p></td> 165<td>source</td> 166</tr> 167<tr> 168<td><p><span class="term">presence</span></p></td> 169<td>always</td> 170</tr> 171<tr> 172<td><p><span class="term">details</span></p></td> 173<td>ANY</td> 174</tr> 175</tbody> 176</table></div> 177</div> 178</div> 179</div> 180<div class="refsect1"> 181<a name="gst-plugins-base-plugins-tcpclientsrc.functions_details"></a><h2>Functions</h2> 182<p></p> 183</div> 184<div class="refsect1"> 185<a name="gst-plugins-base-plugins-tcpclientsrc.other_details"></a><h2>Types and Values</h2> 186<div class="refsect2"> 187<a name="GstTCPClientSrc-struct"></a><h3>struct GstTCPClientSrc</h3> 188<pre class="programlisting">struct GstTCPClientSrc;</pre> 189</div> 190</div> 191<div class="refsect1"> 192<a name="gst-plugins-base-plugins-tcpclientsrc.property-details"></a><h2>Property Details</h2> 193<div class="refsect2"> 194<a name="GstTCPClientSrc--host"></a><h3>The <code class="literal">“host”</code> property</h3> 195<pre class="programlisting"> “host” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 196<p>The host IP address to receive packets from.</p> 197<p>Flags: Read / Write</p> 198<p>Default value: "localhost"</p> 199</div> 200<hr> 201<div class="refsect2"> 202<a name="GstTCPClientSrc--port"></a><h3>The <code class="literal">“port”</code> property</h3> 203<pre class="programlisting"> “port” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 204<p>The port to receive packets from.</p> 205<p>Flags: Read / Write</p> 206<p>Allowed values: [0,65535]</p> 207<p>Default value: 4953</p> 208</div> 209<hr> 210<div class="refsect2"> 211<a name="GstTCPClientSrc--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3> 212<pre class="programlisting"> “timeout” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 213<p>Value in seconds to timeout a blocking I/O. 0 = No timeout. .</p> 214<p>Flags: Read / Write</p> 215<p>Default value: 0</p> 216</div> 217</div> 218<div class="refsect1"> 219<a name="gst-plugins-base-plugins-tcpclientsrc.see-also"></a><h2>See Also</h2> 220<p><span class="type">tcpclientsink</span></p> 221</div> 222</div> 223<div class="footer"> 224<hr>Generated by GTK-Doc V1.28</div> 225</body> 226</html>
