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>waylandsink: 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-wavescope.html" title="wavescope"> 10<link rel="next" href="gst-plugins-bad-plugins-webpdec.html" title="webpdec"> 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-waylandsink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-waylandsink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-waylandsink.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-waylandsink.properties" class="shortcut">Properties</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-wavescope.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-webpdec.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-waylandsink"></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-waylandsink.top_of_page"></a>waylandsink</span></h2> 33<p>waylandsink</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-waylandsink.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#gpointer"><span class="type">gpointer</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-waylandsink.html#GstWaylandSink--wayland-display" title="The “wayland-display” property">wayland-display</a></td> 49<td class="property_flags">Read / Write</td> 50</tr> 51<tr> 52<td class="property_type"> 53<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 54<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-waylandsink.html#GstWaylandSink--display" title="The “display” property">display</a></td> 55<td class="property_flags">Read / Write</td> 56</tr> 57<tr> 58<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 59<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-waylandsink.html#GstWaylandSink--fullscreen" title="The “fullscreen” property">fullscreen</a></td> 60<td class="property_flags">Read / Write</td> 61</tr> 62</tbody> 63</table></div> 64</div> 65<a name="GstWaylandSink"></a><div class="refsect1"> 66<a name="gst-plugins-bad-plugins-waylandsink.other"></a><h2>Types and Values</h2> 67<div class="informaltable"><table class="informaltable" width="100%" border="0"> 68<colgroup> 69<col width="150px" class="name"> 70<col class="description"> 71</colgroup> 72<tbody><tr> 73<td class="datatype_keyword">struct</td> 74<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-waylandsink.html#GstWaylandSink-struct" title="struct GstWaylandSink">GstWaylandSink</a></td> 75</tr></tbody> 76</table></div> 77</div> 78<div class="refsect1"> 79<a name="gst-plugins-bad-plugins-waylandsink.object-hierarchy"></a><h2>Object Hierarchy</h2> 80<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 82 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 83 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 84 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 85 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoSink.html#GstVideoSink-struct">GstVideoSink</a> 86 <span class="lineart">╰──</span> GstWaylandSink 87</pre> 88</div> 89<div class="refsect1"> 90<a name="gst-plugins-bad-plugins-waylandsink.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 91<p> 92GstWaylandSink implements 93 <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoOverlay.html#GstVideoOverlay-struct">GstVideoOverlay</a> and GstWaylandVideo.</p> 94</div> 95<div class="refsect1"> 96<a name="gst-plugins-bad-plugins-waylandsink.description"></a><h2>Description</h2> 97<p>The waylandsink is creating its own window and render the decoded video frames to that. 98 Setup the Wayland environment as described in</p> 99<a class="ulink" href="http://wayland.freedesktop.org/building.html" target="_top">Wayland</a> home page. 100<p> The current implementaion is based on weston compositor.</p> 101<div class="refsect3"> 102<a name="id-1.2.250.8.5"></a><h4>Example pipelines</h4> 103<div class="informalexample"> 104 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 105 <tbody> 106 <tr> 107 <td class="listing_lines" align="right"><pre>1</pre></td> 108 <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> waylandsink</pre></td> 109 </tr> 110 </tbody> 111 </table> 112</div> 113 114<p> test the video rendering in wayland</p> 115</div> 116<div class="refsynopsisdiv"> 117<h2>Synopsis</h2> 118<div class="refsect2"> 119<a name="id-1.2.250.8.6.1"></a><h3>Element Information</h3> 120<div class="variablelist"><table border="0" class="variablelist"> 121<colgroup> 122<col align="left" valign="top"> 123<col> 124</colgroup> 125<tbody> 126<tr> 127<td><p><span class="term">plugin</span></p></td> 128<td> 129 <a class="link" href="gst-plugins-bad-plugins-plugin-waylandsink.html#plugin-waylandsink">waylandsink</a> 130 </td> 131</tr> 132<tr> 133<td><p><span class="term">author</span></p></td> 134<td>Sreerenj Balachandran <sreerenj.balachandran@intel.com>, George Kiagiadakis <george.kiagiadakis@collabora.com></td> 135</tr> 136<tr> 137<td><p><span class="term">class</span></p></td> 138<td>Sink/Video</td> 139</tr> 140</tbody> 141</table></div> 142</div> 143<hr> 144<div class="refsect2"> 145<a name="id-1.2.250.8.6.2"></a><h3>Element Pads</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">name</span></p></td> 154<td>sink</td> 155</tr> 156<tr> 157<td><p><span class="term">direction</span></p></td> 158<td>sink</td> 159</tr> 160<tr> 161<td><p><span class="term">presence</span></p></td> 162<td>always</td> 163</tr> 164<tr> 165<td><p><span class="term">details</span></p></td> 166<td>video/x-raw, format=(string){ BGRx, BGRA, RGBx, xBGR, xRGB, RGBA, ABGR, ARGB, RGB, BGR, RGB16, BGR16, YUY2, YVYU, UYVY, AYUV, NV12, NV21, NV16, YUV9, YVU9, Y41B, I420, YV12, Y42B, v308 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 167</tr> 168<tr> 169<td><p><span class="term"></span></p></td> 170<td> video/x-raw(memory:DMABuf), format=(string){ BGRx, BGRA, RGBx, xBGR, xRGB, RGBA, ABGR, ARGB, RGB, BGR, RGB16, BGR16, YUY2, YVYU, UYVY, AYUV, NV12, NV21, NV16, YUV9, YVU9, Y41B, I420, YV12, Y42B, v308 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 171</tr> 172</tbody> 173</table></div> 174</div> 175</div> 176</div> 177<div class="refsect1"> 178<a name="gst-plugins-bad-plugins-waylandsink.functions_details"></a><h2>Functions</h2> 179<p></p> 180</div> 181<div class="refsect1"> 182<a name="gst-plugins-bad-plugins-waylandsink.other_details"></a><h2>Types and Values</h2> 183<div class="refsect2"> 184<a name="GstWaylandSink-struct"></a><h3>struct GstWaylandSink</h3> 185<pre class="programlisting">struct GstWaylandSink;</pre> 186</div> 187</div> 188<div class="refsect1"> 189<a name="gst-plugins-bad-plugins-waylandsink.property-details"></a><h2>Property Details</h2> 190<div class="refsect2"> 191<a name="GstWaylandSink--wayland-display"></a><h3>The <code class="literal">“wayland-display”</code> property</h3> 192<pre class="programlisting"> “wayland-display” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> 193<p>Wayland Display handle created by the application .</p> 194<p>Flags: Read / Write</p> 195</div> 196<hr> 197<div class="refsect2"> 198<a name="GstWaylandSink--display"></a><h3>The <code class="literal">“display”</code> property</h3> 199<pre class="programlisting"> “display” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 200<p>Wayland display name to connect to, if not supplied via the GstContext.</p> 201<p>Flags: Read / Write</p> 202<p>Default value: NULL</p> 203</div> 204<hr> 205<div class="refsect2"> 206<a name="GstWaylandSink--fullscreen"></a><h3>The <code class="literal">“fullscreen”</code> property</h3> 207<pre class="programlisting"> “fullscreen” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 208<p>Whether the surface should be made fullscreen .</p> 209<p>Flags: Read / Write</p> 210<p>Default value: FALSE</p> 211</div> 212</div> 213</div> 214<div class="footer"> 215<hr>Generated by GTK-Doc V1.28</div> 216</body> 217</html>