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>shmsink: 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-sfdec.html" title="sfdec"> 10<link rel="next" href="gst-plugins-bad-plugins-shmsrc.html" title="shmsrc"> 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-shmsink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-shmsink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-shmsink.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-shmsink.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-sfdec.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-shmsrc.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-shmsink"></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-shmsink.top_of_page"></a>shmsink</span></h2> 33<p>shmsink</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-shmsink.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#guint"><span class="type">guint</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink--perms" title="The “perms” property">perms</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#guint"><span class="type">guint</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink--shm-size" title="The “shm-size” property">shm-size</a></td> 54<td class="property_flags">Read / Write</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-bad-plugins-shmsink.html#GstShmSink--socket-path" title="The “socket-path” property">socket-path</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-bad-plugins-shmsink.html#GstShmSink--wait-for-connection" title="The “wait-for-connection” property">wait-for-connection</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#gint64"><span class="type">gint64</span></a></td> 69<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink--buffer-time" title="The “buffer-time” property">buffer-time</a></td> 70<td class="property_flags">Read / Write / Construct</td> 71</tr> 72</tbody> 73</table></div> 74</div> 75<div class="refsect1"> 76<a name="gst-plugins-bad-plugins-shmsink.signals"></a><h2>Signals</h2> 77<div class="informaltable"><table class="informaltable" border="0"> 78<colgroup> 79<col width="150px" class="signals_return"> 80<col width="300px" class="signals_name"> 81<col width="200px" class="signals_flags"> 82</colgroup> 83<tbody> 84<tr> 85<td class="signal_type"><span class="returnvalue">void</span></td> 86<td class="signal_name"><a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink-client-connected" title="The “client-connected” signal">client-connected</a></td> 87<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> 88</tr> 89<tr> 90<td class="signal_type"><span class="returnvalue">void</span></td> 91<td class="signal_name"><a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink-client-disconnected" title="The “client-disconnected” signal">client-disconnected</a></td> 92<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> 93</tr> 94</tbody> 95</table></div> 96</div> 97<a name="GstShmSink"></a><div class="refsect1"> 98<a name="gst-plugins-bad-plugins-shmsink.other"></a><h2>Types and Values</h2> 99<div class="informaltable"><table class="informaltable" width="100%" border="0"> 100<colgroup> 101<col width="150px" class="name"> 102<col class="description"> 103</colgroup> 104<tbody><tr> 105<td class="datatype_keyword">struct</td> 106<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink-struct" title="struct GstShmSink">GstShmSink</a></td> 107</tr></tbody> 108</table></div> 109</div> 110<div class="refsect1"> 111<a name="gst-plugins-bad-plugins-shmsink.object-hierarchy"></a><h2>Object Hierarchy</h2> 112<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 113 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 114 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 115 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 116 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 117 <span class="lineart">╰──</span> GstShmSink 118</pre> 119</div> 120<div class="refsect1"> 121<a name="gst-plugins-bad-plugins-shmsink.description"></a><h2>Description</h2> 122<p>Send data over shared memory to the matching source.</p> 123<div class="refsect3"> 124<a name="id-1.2.196.8.3"></a><h4>Example launch lines</h4> 125<div class="informalexample"> 126 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 127 <tbody> 128 <tr> 129 <td class="listing_lines" align="right"><pre>1 1302 1313</pre></td> 132 <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> <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> <span class="string">"video/x-raw, format=YUY2, color-matrix=sdtv, \</span> 133<span class="string">chroma-site=mpeg2, width=(int)320, height=(int)240, framerate=(fraction)30/1"</span> \ 134<span class="gtkdoc opt">!</span> shmsink socket<span class="gtkdoc opt">-</span>path<span class="gtkdoc opt">=/</span>tmp<span class="gtkdoc opt">/</span>blah shm<span class="gtkdoc opt">-</span>size<span class="gtkdoc opt">=</span><span class="number">2000000</span></pre></td> 135 </tr> 136 </tbody> 137 </table> 138</div> 139 140<p> Send video to shm buffers.</p> 141</div> 142<div class="refsynopsisdiv"> 143<h2>Synopsis</h2> 144<div class="refsect2"> 145<a name="id-1.2.196.8.4.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-shm.html#plugin-shm">shm</a> 156 </td> 157</tr> 158<tr> 159<td><p><span class="term">author</span></p></td> 160<td>Olivier Crete <olivier.crete@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.196.8.4.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-shmsink.functions_details"></a><h2>Functions</h2> 201<p></p> 202</div> 203<div class="refsect1"> 204<a name="gst-plugins-bad-plugins-shmsink.other_details"></a><h2>Types and Values</h2> 205<div class="refsect2"> 206<a name="GstShmSink-struct"></a><h3>struct GstShmSink</h3> 207<pre class="programlisting">struct GstShmSink;</pre> 208</div> 209</div> 210<div class="refsect1"> 211<a name="gst-plugins-bad-plugins-shmsink.property-details"></a><h2>Property Details</h2> 212<div class="refsect2"> 213<a name="GstShmSink--perms"></a><h3>The <code class="literal">“perms”</code> property</h3> 214<pre class="programlisting"> “perms” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 215<p>Permissions to set on the shm area.</p> 216<p>Flags: Read / Write</p> 217<p>Allowed values: <= 4095</p> 218<p>Default value: 416</p> 219</div> 220<hr> 221<div class="refsect2"> 222<a name="GstShmSink--shm-size"></a><h3>The <code class="literal">“shm-size”</code> property</h3> 223<pre class="programlisting"> “shm-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 224<p>Size of the shared memory area.</p> 225<p>Flags: Read / Write</p> 226<p>Default value: 67108864</p> 227</div> 228<hr> 229<div class="refsect2"> 230<a name="GstShmSink--socket-path"></a><h3>The <code class="literal">“socket-path”</code> property</h3> 231<pre class="programlisting"> “socket-path” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 232<p>The path to the control socket used to control the shared memory transport. This may be modified during the NULL->READY transition.</p> 233<p>Flags: Read / Write</p> 234<p>Default value: NULL</p> 235</div> 236<hr> 237<div class="refsect2"> 238<a name="GstShmSink--wait-for-connection"></a><h3>The <code class="literal">“wait-for-connection”</code> property</h3> 239<pre class="programlisting"> “wait-for-connection” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 240<p>Block the stream until the shm pipe is connected.</p> 241<p>Flags: Read / Write</p> 242<p>Default value: TRUE</p> 243</div> 244<hr> 245<div class="refsect2"> 246<a name="GstShmSink--buffer-time"></a><h3>The <code class="literal">“buffer-time”</code> property</h3> 247<pre class="programlisting"> “buffer-time” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre> 248<p>Maximum Size of the shm buffer in nanoseconds (-1 to disable).</p> 249<p>Flags: Read / Write / Construct</p> 250<p>Allowed values: >= G_MAXULONG</p> 251<p>Default value: -1</p> 252</div> 253</div> 254<div class="refsect1"> 255<a name="gst-plugins-bad-plugins-shmsink.signal-details"></a><h2>Signal Details</h2> 256<div class="refsect2"> 257<a name="GstShmSink-client-connected"></a><h3>The <code class="literal">“client-connected”</code> signal</h3> 258<pre class="programlisting"><span class="returnvalue">void</span> 259user_function (<a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink"><span class="type">GstShmSink</span></a> *gstshmsink, 260 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1, 261 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 262<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> 263</div> 264<hr> 265<div class="refsect2"> 266<a name="GstShmSink-client-disconnected"></a><h3>The <code class="literal">“client-disconnected”</code> signal</h3> 267<pre class="programlisting"><span class="returnvalue">void</span> 268user_function (<a class="link" href="gst-plugins-bad-plugins-shmsink.html#GstShmSink"><span class="type">GstShmSink</span></a> *gstshmsink, 269 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1, 270 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 271<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> 272</div> 273</div> 274</div> 275<div class="footer"> 276<hr>Generated by GTK-Doc V1.28</div> 277</body> 278</html>
