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>ipcpipelinesink: GStreamer Bad 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 Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-intervideosrc.html" title="intervideosrc"> 10<link rel="next" href="gst-plugins-bad-plugins-ipcpipelinesrc.html" title="ipcpipelinesrc"> 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-bad-plugins-ipcpipelinesink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-ipcpipelinesink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-ipcpipelinesink.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-ipcpipelinesink.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-bad-plugins-intervideosrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-bad-plugins-ipcpipelinesrc.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-bad-plugins-ipcpipelinesink"></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-bad-plugins-ipcpipelinesink.top_of_page"></a>ipcpipelinesink</span></h2> 33<p>ipcpipelinesink</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-bad-plugins-ipcpipelinesink.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-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--ack-time" title="The “ack-time” property">ack-time</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-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--fdin" title="The “fdin” property">fdin</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#gint"><span class="type">gint</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--fdout" title="The “fdout” property">fdout</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 63<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--read-chunk-size" title="The “read-chunk-size” property">read-chunk-size</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66</tbody> 67</table></div> 68</div> 69<div class="refsect1"> 70<a name="gst-plugins-bad-plugins-ipcpipelinesink.signals"></a><h2>Signals</h2> 71<div class="informaltable"><table class="informaltable" border="0"> 72<colgroup> 73<col width="150px" class="signals_return"> 74<col width="300px" class="signals_name"> 75<col width="200px" class="signals_flags"> 76</colgroup> 77<tbody><tr> 78<td class="signal_type"><span class="returnvalue">void</span></td> 79<td class="signal_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink-disconnect" title="The “disconnect” signal">disconnect</a></td> 80<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td> 81</tr></tbody> 82</table></div> 83</div> 84<a name="GstIpcPipelineSink"></a><div class="refsect1"> 85<a name="gst-plugins-bad-plugins-ipcpipelinesink.other"></a><h2>Types and Values</h2> 86<div class="informaltable"><table class="informaltable" width="100%" border="0"> 87<colgroup> 88<col width="150px" class="name"> 89<col class="description"> 90</colgroup> 91<tbody><tr> 92<td class="datatype_keyword">struct</td> 93<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink-struct" title="struct GstIpcPipelineSink">GstIpcPipelineSink</a></td> 94</tr></tbody> 95</table></div> 96</div> 97<div class="refsect1"> 98<a name="gst-plugins-bad-plugins-ipcpipelinesink.object-hierarchy"></a><h2>Object Hierarchy</h2> 99<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 100 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 101 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 102 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 103 <span class="lineart">╰──</span> GstIpcPipelineSink 104</pre> 105</div> 106<div class="refsect1"> 107<a name="gst-plugins-bad-plugins-ipcpipelinesink.description"></a><h2>Description</h2> 108<p>Communicates with an ipcpipelinesrc element in another process via a socket.</p> 109<p>This element, together with ipcpipelinesrc and ipcslavepipeline form a 110mechanism that allows splitting a single pipeline in different processes. 111The main use-case for it is a playback pipeline split in two parts, where the 112first part contains the networking, parsing and demuxing and the second part 113contains the decoding and display. The intention of this split is to improve 114security of an application, by letting the networking, parsing and demuxing 115parts run in a less privileged process than the process that accesses the 116decoder and display.</p> 117<p>Once the pipelines in those different processes have been created, the 118playback can be controlled entirely from the first pipeline, which is the 119one that contains ipcpipelinesink. We call this pipeline the “master”. 120All relevant events and queries sent from the application are sent to 121the master pipeline and messages to the application are sent from the master 122pipeline. The second pipeline, in the other process, is transparently slaved.</p> 123<p>ipcpipelinesink can work only in push mode and does not synchronize buffers 124to the clock. Synchronization is meant to happen either at the real sink at 125the end of the remote slave pipeline, or not to happen at all, if the 126pipeline is live.</p> 127<p>A master pipeline may contain more than one ipcpipelinesink elements, which 128can be connected either to the same slave pipeline or to different ones.</p> 129<p>Communication with ipcpipelinesrc on the slave happens via a socket, using a 130custom protocol. Each buffer, event, query, message or state change is 131serialized in a "packet" and sent over the socket. The sender then 132performs a blocking wait for a reply, if a return code is needed.</p> 133<p>All objects that contan a GstStructure (messages, queries, events) are 134serialized by serializing the GstStructure to a string 135(gst_structure_to_string). This implies some limitations, of course. 136All fields of this structures that are not serializable to strings (ex. 137object pointers) are ignored, except for some cases where custom 138serialization may occur (ex error/warning/info messages that contain a 139GError are serialized differently).</p> 140<p>Buffers are transported by writing their content directly on the socket. 141More efficient ways for memory sharing could be implemented in the future.</p> 142<div class="refsynopsisdiv"> 143<h2>Synopsis</h2> 144<div class="refsect2"> 145<a name="id-1.2.117.8.10.1"></a><h3>Element Information</h3> 146<div class="variablelist"><table border="0" class="variablelist"> 147<colgroup> 148<col align="left" valign="top"> 149<col> 150</colgroup> 151<tbody> 152<tr> 153<td><p><span class="term">plugin</span></p></td> 154<td> 155 <a class="link" href="gst-plugins-bad-plugins-plugin-ipcpipeline.html#plugin-ipcpipeline">ipcpipeline</a> 156 </td> 157</tr> 158<tr> 159<td><p><span class="term">author</span></p></td> 160<td>Vincent Penquerc'h <vincent.penquerch@collabora.co.uk></td> 161</tr> 162<tr> 163<td><p><span class="term">class</span></p></td> 164<td>Sink</td> 165</tr> 166</tbody> 167</table></div> 168</div> 169<hr> 170<div class="refsect2"> 171<a name="id-1.2.117.8.10.2"></a><h3>Element Pads</h3> 172<div class="variablelist"><table border="0" class="variablelist"> 173<colgroup> 174<col align="left" valign="top"> 175<col> 176</colgroup> 177<tbody> 178<tr> 179<td><p><span class="term">name</span></p></td> 180<td>sink</td> 181</tr> 182<tr> 183<td><p><span class="term">direction</span></p></td> 184<td>sink</td> 185</tr> 186<tr> 187<td><p><span class="term">presence</span></p></td> 188<td>always</td> 189</tr> 190<tr> 191<td><p><span class="term">details</span></p></td> 192<td>ANY</td> 193</tr> 194</tbody> 195</table></div> 196</div> 197</div> 198</div> 199<div class="refsect1"> 200<a name="gst-plugins-bad-plugins-ipcpipelinesink.functions_details"></a><h2>Functions</h2> 201<p></p> 202</div> 203<div class="refsect1"> 204<a name="gst-plugins-bad-plugins-ipcpipelinesink.other_details"></a><h2>Types and Values</h2> 205<div class="refsect2"> 206<a name="GstIpcPipelineSink-struct"></a><h3>struct GstIpcPipelineSink</h3> 207<pre class="programlisting">struct GstIpcPipelineSink;</pre> 208</div> 209</div> 210<div class="refsect1"> 211<a name="gst-plugins-bad-plugins-ipcpipelinesink.property-details"></a><h2>Property Details</h2> 212<div class="refsect2"> 213<a name="GstIpcPipelineSink--ack-time"></a><h3>The <code class="literal">“ack-time”</code> property</h3> 214<pre class="programlisting"> “ack-time” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 215<p>Maximum time to wait for a response to a message.</p> 216<p>Flags: Read / Write</p> 217<p>Default value: 10000000</p> 218</div> 219<hr> 220<div class="refsect2"> 221<a name="GstIpcPipelineSink--fdin"></a><h3>The <code class="literal">“fdin”</code> property</h3> 222<pre class="programlisting"> “fdin” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 223<p>File descriptor to received data from.</p> 224<p>Flags: Read / Write</p> 225<p>Allowed values: [G_MAXULONG,65535]</p> 226<p>Default value: -1</p> 227</div> 228<hr> 229<div class="refsect2"> 230<a name="GstIpcPipelineSink--fdout"></a><h3>The <code class="literal">“fdout”</code> property</h3> 231<pre class="programlisting"> “fdout” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 232<p>File descriptor to send data through.</p> 233<p>Flags: Read / Write</p> 234<p>Allowed values: [G_MAXULONG,65535]</p> 235<p>Default value: -1</p> 236</div> 237<hr> 238<div class="refsect2"> 239<a name="GstIpcPipelineSink--read-chunk-size"></a><h3>The <code class="literal">“read-chunk-size”</code> property</h3> 240<pre class="programlisting"> “read-chunk-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 241<p>Read chunk size.</p> 242<p>Flags: Read / Write</p> 243<p>Allowed values: [1,16777216]</p> 244<p>Default value: 4096</p> 245</div> 246</div> 247<div class="refsect1"> 248<a name="gst-plugins-bad-plugins-ipcpipelinesink.signal-details"></a><h2>Signal Details</h2> 249<div class="refsect2"> 250<a name="GstIpcPipelineSink-disconnect"></a><h3>The <code class="literal">“disconnect”</code> signal</h3> 251<pre class="programlisting"><span class="returnvalue">void</span> 252user_function (<a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink"><span class="type">GstIpcPipelineSink</span></a> *gstipcpipelinesink, 253 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 254<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p> 255</div> 256</div> 257<div class="refsect1"> 258<a name="gst-plugins-bad-plugins-ipcpipelinesink.see-also"></a><h2>See Also</h2> 259<p><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesrc.html#GstIpcPipelineSrc"><span class="type">GstIpcPipelineSrc</span></a>, <a class="link" href="gst-plugins-bad-plugins-ipcslavepipeline.html#GstIpcSlavePipeline"><span class="type">GstIpcSlavePipeline</span></a></p> 260</div> 261</div> 262<div class="footer"> 263<hr>Generated by GTK-Doc V1.28</div> 264</body> 265</html>
