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>socketsrc: 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-rawvideoparse.html" title="rawvideoparse"> 10<link rel="next" href="gst-plugins-base-plugins-ssaparse.html" title="ssaparse"> 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-socketsrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-socketsrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-socketsrc.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 21 <a href="#gst-plugins-base-plugins-socketsrc.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-base-plugins-rawvideoparse.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-base-plugins-ssaparse.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-base-plugins-socketsrc"></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-base-plugins-socketsrc.top_of_page"></a>socketsrc</span></h2> 33<p>socketsrc</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-base-plugins-socketsrc.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"> 48<a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</td> 49<td class="property_name"><a class="link" href="gst-plugins-base-plugins-socketsrc.html#GstSocketSrc--socket" title="The “socket” property">socket</a></td> 50<td class="property_flags">Read / Write</td> 51</tr> 52<tr> 53<td class="property_type"> 54<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *</td> 55<td class="property_name"><a class="link" href="gst-plugins-base-plugins-socketsrc.html#GstSocketSrc--caps" title="The “caps” property">caps</a></td> 56<td class="property_flags">Read / Write</td> 57</tr> 58<tr> 59<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 60<td class="property_name"><a class="link" href="gst-plugins-base-plugins-socketsrc.html#GstSocketSrc--send-messages" title="The “send-messages” property">send-messages</a></td> 61<td class="property_flags">Read / Write</td> 62</tr> 63</tbody> 64</table></div> 65</div> 66<div class="refsect1"> 67<a name="gst-plugins-base-plugins-socketsrc.signals"></a><h2>Signals</h2> 68<div class="informaltable"><table class="informaltable" border="0"> 69<colgroup> 70<col width="150px" class="signals_return"> 71<col width="300px" class="signals_name"> 72<col width="200px" class="signals_flags"> 73</colgroup> 74<tbody><tr> 75<td class="signal_type"><span class="returnvalue">void</span></td> 76<td class="signal_name"><a class="link" href="gst-plugins-base-plugins-socketsrc.html#GstSocketSrc-connection-closed-by-peer" title="The “connection-closed-by-peer” signal">connection-closed-by-peer</a></td> 77<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> 78</tr></tbody> 79</table></div> 80</div> 81<a name="GstSocketSrc"></a><div class="refsect1"> 82<a name="gst-plugins-base-plugins-socketsrc.other"></a><h2>Types and Values</h2> 83<div class="informaltable"><table class="informaltable" width="100%" border="0"> 84<colgroup> 85<col width="150px" class="name"> 86<col class="description"> 87</colgroup> 88<tbody><tr> 89<td class="datatype_keyword">struct</td> 90<td class="function_name"><a class="link" href="gst-plugins-base-plugins-socketsrc.html#GstSocketSrc-struct" title="struct GstSocketSrc">GstSocketSrc</a></td> 91</tr></tbody> 92</table></div> 93</div> 94<div class="refsect1"> 95<a name="gst-plugins-base-plugins-socketsrc.object-hierarchy"></a><h2>Object Hierarchy</h2> 96<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 97 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 98 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 99 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 100 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSrc.html#GstBaseSrc-struct">GstBaseSrc</a> 101 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstPushSrc.html#GstPushSrc-struct">GstPushSrc</a> 102 <span class="lineart">╰──</span> GstSocketSrc 103</pre> 104</div> 105<div class="refsect1"> 106<a name="gst-plugins-base-plugins-socketsrc.description"></a><h2>Description</h2> 107<p>Receive data from a socket.</p> 108<p>As compared to other elements:</p> 109<p>socketsrc can be considered a source counterpart to the <span class="type">multisocketsink</span> 110sink.</p> 111<p>socketsrc can also be considered a generalization of <span class="type">tcpclientsrc</span> and 112<span class="type">tcpserversrc</span>: it contains all the logic required to communicate over the 113socket but none of the logic for creating the sockets/establishing the 114connection in the first place, allowing the user to accomplish this 115externally in whatever manner they wish making it applicable to other types 116of sockets besides TCP.</p> 117<p>As compared to <span class="type">fdsrc</span> socketsrc is socket specific and deals with <a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> 118objects rather than sockets via integer file-descriptors.</p> 119<p><em class="parameter"><code>see_also</code></em> 120: <span class="type">multisocketsink</span></p> 121<div class="refsynopsisdiv"> 122<h2>Synopsis</h2> 123<div class="refsect2"> 124<a name="id-1.2.88.8.8.1"></a><h3>Element Information</h3> 125<div class="variablelist"><table border="0" class="variablelist"> 126<colgroup> 127<col align="left" valign="top"> 128<col> 129</colgroup> 130<tbody> 131<tr> 132<td><p><span class="term">plugin</span></p></td> 133<td> 134 <a class="link" href="gst-plugins-base-plugins-plugin-tcp.html#plugin-tcp">tcp</a> 135 </td> 136</tr> 137<tr> 138<td><p><span class="term">author</span></p></td> 139<td>Thomas Vander Stichele <thomas at apestaart dot org>, William Manley <will@williammanley.net></td> 140</tr> 141<tr> 142<td><p><span class="term">class</span></p></td> 143<td>Source/Network</td> 144</tr> 145</tbody> 146</table></div> 147</div> 148<hr> 149<div class="refsect2"> 150<a name="id-1.2.88.8.8.2"></a><h3>Element Pads</h3> 151<div class="variablelist"><table border="0" class="variablelist"> 152<colgroup> 153<col align="left" valign="top"> 154<col> 155</colgroup> 156<tbody> 157<tr> 158<td><p><span class="term">name</span></p></td> 159<td>src</td> 160</tr> 161<tr> 162<td><p><span class="term">direction</span></p></td> 163<td>source</td> 164</tr> 165<tr> 166<td><p><span class="term">presence</span></p></td> 167<td>always</td> 168</tr> 169<tr> 170<td><p><span class="term">details</span></p></td> 171<td>ANY</td> 172</tr> 173</tbody> 174</table></div> 175</div> 176</div> 177</div> 178<div class="refsect1"> 179<a name="gst-plugins-base-plugins-socketsrc.functions_details"></a><h2>Functions</h2> 180<p></p> 181</div> 182<div class="refsect1"> 183<a name="gst-plugins-base-plugins-socketsrc.other_details"></a><h2>Types and Values</h2> 184<div class="refsect2"> 185<a name="GstSocketSrc-struct"></a><h3>struct GstSocketSrc</h3> 186<pre class="programlisting">struct GstSocketSrc;</pre> 187</div> 188</div> 189<div class="refsect1"> 190<a name="gst-plugins-base-plugins-socketsrc.property-details"></a><h2>Property Details</h2> 191<div class="refsect2"> 192<a name="GstSocketSrc--socket"></a><h3>The <code class="literal">“socket”</code> property</h3> 193<pre class="programlisting"> “socket” <a href="/usr/share/gtk-doc/html/gio/GSocket.html#GSocket-struct"><span class="type">GSocket</span></a> *</pre> 194<p>The socket to receive packets from.</p> 195<p>Flags: Read / Write</p> 196</div> 197<hr> 198<div class="refsect2"> 199<a name="GstSocketSrc--caps"></a><h3>The <code class="literal">“caps”</code> property</h3> 200<pre class="programlisting"> “caps” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *</pre> 201<p>The caps of the source pad.</p> 202<p>Flags: Read / Write</p> 203</div> 204<hr> 205<div class="refsect2"> 206<a name="GstSocketSrc--send-messages"></a><h3>The <code class="literal">“send-messages”</code> property</h3> 207<pre class="programlisting"> “send-messages” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 208<p>Control if the source will handle GstNetworkMessage events. 209The event is a CUSTOM event named 'GstNetworkMessage' and contains:</p> 210<p> "buffer", GST_TYPE_BUFFER : the buffer with data to send</p> 211<p>The buffer in the event will be sent on the socket. This allows 212for simple bidirectional communication.</p> 213<p>Flags: Read / Write</p> 214<p>Default value: FALSE</p> 215<p class="since">Since: 1.8.0</p> 216</div> 217</div> 218<div class="refsect1"> 219<a name="gst-plugins-base-plugins-socketsrc.signal-details"></a><h2>Signal Details</h2> 220<div class="refsect2"> 221<a name="GstSocketSrc-connection-closed-by-peer"></a><h3>The <code class="literal">“connection-closed-by-peer”</code> signal</h3> 222<pre class="programlisting"><span class="returnvalue">void</span> 223user_function (<a class="link" href="gst-plugins-base-plugins-socketsrc.html#GstSocketSrc"><span class="type">GstSocketSrc</span></a> *gstsocketsrc, 224 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 225<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> 226</div> 227</div> 228</div> 229<div class="footer"> 230<hr>Generated by GTK-Doc V1.28</div> 231</body> 232</html>
