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>kmssink: 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-katetag.html" title="katetag"> 10<link rel="next" href="gst-plugins-bad-plugins-ladspa.html" title="ladspa"> 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-kmssink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-kmssink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-kmssink.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-kmssink.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-katetag.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-ladspa.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-kmssink"></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-kmssink.top_of_page"></a>kmssink</span></h2> 33<p>kmssink — A KMS/DRM based video sink</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-kmssink.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#gint"><span class="type">gint</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--connector-id" title="The “connector-id” property">connector-id</a></td> 49<td class="property_flags">Read / Write / Construct</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-kmssink.html#GstKMSSink--driver-name" title="The “driver-name” property">driver-name</a></td> 55<td class="property_flags">Read / Write / Construct</td> 56</tr> 57<tr> 58<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 59<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--plane-id" title="The “plane-id” property">plane-id</a></td> 60<td class="property_flags">Read / Write / Construct</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-kmssink.html#GstKMSSink--force-modesetting" title="The “force-modesetting” property">force-modesetting</a></td> 65<td class="property_flags">Read / Write / Construct</td> 66</tr> 67<tr> 68<td class="property_type"> 69<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 70<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--bus-id" title="The “bus-id” property">bus-id</a></td> 71<td class="property_flags">Read / Write / Construct</td> 72</tr> 73<tr> 74<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 75<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--can-scale" title="The “can-scale” property">can-scale</a></td> 76<td class="property_flags">Read / Write / Construct</td> 77</tr> 78<tr> 79<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 80<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--display-height" title="The “display-height” property">display-height</a></td> 81<td class="property_flags">Read</td> 82</tr> 83<tr> 84<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 85<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--display-width" title="The “display-width” property">display-width</a></td> 86<td class="property_flags">Read</td> 87</tr> 88<tr> 89<td class="property_type"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstControlSource.html#GstValueArray"><span class="type">GstValueArray</span></a></td> 90<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--render-rectangle" title="The “render-rectangle” property">render-rectangle</a></td> 91<td class="property_flags">Write</td> 92</tr> 93<tr> 94<td class="property_type"> 95<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</td> 96<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--connector-properties" title="The “connector-properties” property">connector-properties</a></td> 97<td class="property_flags">Read / Write</td> 98</tr> 99<tr> 100<td class="property_type"> 101<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</td> 102<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--plane-properties" title="The “plane-properties” property">plane-properties</a></td> 103<td class="property_flags">Read / Write</td> 104</tr> 105<tr> 106<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 107<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink--restore-crtc" title="The “restore-crtc” property">restore-crtc</a></td> 108<td class="property_flags">Read / Write / Construct</td> 109</tr> 110</tbody> 111</table></div> 112</div> 113<a name="GstKMSSink"></a><div class="refsect1"> 114<a name="gst-plugins-bad-plugins-kmssink.other"></a><h2>Types and Values</h2> 115<div class="informaltable"><table class="informaltable" width="100%" border="0"> 116<colgroup> 117<col width="150px" class="name"> 118<col class="description"> 119</colgroup> 120<tbody><tr> 121<td class="datatype_keyword">struct</td> 122<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-kmssink.html#GstKMSSink-struct" title="struct GstKMSSink">GstKMSSink</a></td> 123</tr></tbody> 124</table></div> 125</div> 126<div class="refsect1"> 127<a name="gst-plugins-bad-plugins-kmssink.object-hierarchy"></a><h2>Object Hierarchy</h2> 128<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 129 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 130 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 131 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 132 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 133 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoSink.html#GstVideoSink-struct">GstVideoSink</a> 134 <span class="lineart">╰──</span> GstKMSSink 135</pre> 136</div> 137<div class="refsect1"> 138<a name="gst-plugins-bad-plugins-kmssink.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 139<p> 140GstKMSSink implements 141 <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoOverlay.html#GstVideoOverlay-struct">GstVideoOverlay</a>.</p> 142</div> 143<div class="refsect1"> 144<a name="gst-plugins-bad-plugins-kmssink.description"></a><h2>Description</h2> 145<p>kmssink is a simple video sink that renders video frames directly 146in a plane of a DRM device.</p> 147<p>In advance usage, the behaviour of kmssink can be change using the 148supported properties. Note that plane and connectors IDs and properties can 149be enumerated using the modetest command line tool.</p> 150<div class="refsect3"> 151<a name="id-1.2.133.8.4"></a><h4>Example launch line</h4> 152<div class="informalexample"> 153 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 154 <tbody> 155 <tr> 156 <td class="listing_lines" align="right"><pre>1 1572</pre></td> 158 <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> videotestsrc <span class="gtkdoc opt">!</span> kmssink 159gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> videotestsrc <span class="gtkdoc opt">!</span> kmssink plane<span class="gtkdoc opt">-</span>properties<span class="gtkdoc opt">=</span>s<span class="gtkdoc opt">,</span>rotation<span class="gtkdoc opt">=</span><span class="number">4</span></pre></td> 160 </tr> 161 </tbody> 162 </table> 163</div> 164 165<p></p> 166</div> 167<div class="refsynopsisdiv"> 168<h2>Synopsis</h2> 169<div class="refsect2"> 170<a name="id-1.2.133.8.5.1"></a><h3>Element Information</h3> 171<div class="variablelist"><table border="0" class="variablelist"> 172<colgroup> 173<col align="left" valign="top"> 174<col> 175</colgroup> 176<tbody> 177<tr> 178<td><p><span class="term">plugin</span></p></td> 179<td> 180 <a class="link" href="gst-plugins-bad-plugins-plugin-kms.html#plugin-kms">kms</a> 181 </td> 182</tr> 183<tr> 184<td><p><span class="term">author</span></p></td> 185<td>Víctor Jáquez <vjaquez@igalia.com></td> 186</tr> 187<tr> 188<td><p><span class="term">class</span></p></td> 189<td>Sink/Video</td> 190</tr> 191</tbody> 192</table></div> 193</div> 194<hr> 195<div class="refsect2"> 196<a name="id-1.2.133.8.5.2"></a><h3>Element Pads</h3> 197<div class="variablelist"><table border="0" class="variablelist"> 198<colgroup> 199<col align="left" valign="top"> 200<col> 201</colgroup> 202<tbody> 203<tr> 204<td><p><span class="term">name</span></p></td> 205<td>sink</td> 206</tr> 207<tr> 208<td><p><span class="term">direction</span></p></td> 209<td>sink</td> 210</tr> 211<tr> 212<td><p><span class="term">presence</span></p></td> 213<td>always</td> 214</tr> 215<tr> 216<td><p><span class="term">details</span></p></td> 217<td>video/x-raw, format=(string){ BGRA, BGRx, RGBA, RGBx, RGB, BGR, UYVY, YUY2, YVYU, I420, YV12, Y42B, NV12, NV21, NV16 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 218</tr> 219</tbody> 220</table></div> 221</div> 222</div> 223</div> 224<div class="refsect1"> 225<a name="gst-plugins-bad-plugins-kmssink.functions_details"></a><h2>Functions</h2> 226<p></p> 227</div> 228<div class="refsect1"> 229<a name="gst-plugins-bad-plugins-kmssink.other_details"></a><h2>Types and Values</h2> 230<div class="refsect2"> 231<a name="GstKMSSink-struct"></a><h3>struct GstKMSSink</h3> 232<pre class="programlisting">struct GstKMSSink;</pre> 233</div> 234</div> 235<div class="refsect1"> 236<a name="gst-plugins-bad-plugins-kmssink.property-details"></a><h2>Property Details</h2> 237<div class="refsect2"> 238<a name="GstKMSSink--connector-id"></a><h3>The <code class="literal">“connector-id”</code> property</h3> 239<pre class="programlisting"> “connector-id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 240<p>DRM connector id.</p> 241<p>Flags: Read / Write / Construct</p> 242<p>Allowed values: >= G_MAXULONG</p> 243<p>Default value: -1</p> 244</div> 245<hr> 246<div class="refsect2"> 247<a name="GstKMSSink--driver-name"></a><h3>The <code class="literal">“driver-name”</code> property</h3> 248<pre class="programlisting"> “driver-name” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 249<p>DRM device driver name.</p> 250<p>Flags: Read / Write / Construct</p> 251<p>Default value: NULL</p> 252</div> 253<hr> 254<div class="refsect2"> 255<a name="GstKMSSink--plane-id"></a><h3>The <code class="literal">“plane-id”</code> property</h3> 256<pre class="programlisting"> “plane-id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 257<p>DRM plane id.</p> 258<p>Flags: Read / Write / Construct</p> 259<p>Allowed values: >= G_MAXULONG</p> 260<p>Default value: -1</p> 261</div> 262<hr> 263<div class="refsect2"> 264<a name="GstKMSSink--force-modesetting"></a><h3>The <code class="literal">“force-modesetting”</code> property</h3> 265<pre class="programlisting"> “force-modesetting” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 266<p>When enabled, the sink try to configure the display mode.</p> 267<p>Flags: Read / Write / Construct</p> 268<p>Default value: FALSE</p> 269</div> 270<hr> 271<div class="refsect2"> 272<a name="GstKMSSink--bus-id"></a><h3>The <code class="literal">“bus-id”</code> property</h3> 273<pre class="programlisting"> “bus-id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 274<p>DRM bus ID.</p> 275<p>Flags: Read / Write / Construct</p> 276<p>Default value: NULL</p> 277</div> 278<hr> 279<div class="refsect2"> 280<a name="GstKMSSink--can-scale"></a><h3>The <code class="literal">“can-scale”</code> property</h3> 281<pre class="programlisting"> “can-scale” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 282<p>User can tell kmssink if the driver can support scale.</p> 283<p>Flags: Read / Write / Construct</p> 284<p>Default value: TRUE</p> 285</div> 286<hr> 287<div class="refsect2"> 288<a name="GstKMSSink--display-height"></a><h3>The <code class="literal">“display-height”</code> property</h3> 289<pre class="programlisting"> “display-height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 290<p>Height of the display surface in pixels.</p> 291<p>Flags: Read</p> 292<p>Allowed values: >= 0</p> 293<p>Default value: 0</p> 294</div> 295<hr> 296<div class="refsect2"> 297<a name="GstKMSSink--display-width"></a><h3>The <code class="literal">“display-width”</code> property</h3> 298<pre class="programlisting"> “display-width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 299<p>Width of the display surface in pixels.</p> 300<p>Flags: Read</p> 301<p>Allowed values: >= 0</p> 302<p>Default value: 0</p> 303</div> 304<hr> 305<div class="refsect2"> 306<a name="GstKMSSink--render-rectangle"></a><h3>The <code class="literal">“render-rectangle”</code> property</h3> 307<pre class="programlisting"> “render-rectangle” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstControlSource.html#GstValueArray"><span class="type">GstValueArray</span></a></pre> 308<p>The render rectangle ('<x, y, width, height>').</p> 309<p>Flags: Write</p> 310</div> 311<hr> 312<div class="refsect2"> 313<a name="GstKMSSink--connector-properties"></a><h3>The <code class="literal">“connector-properties”</code> property</h3> 314<pre class="programlisting"> “connector-properties” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</pre> 315<p>Additionnal properties for the connector.</p> 316<p>Flags: Read / Write</p> 317</div> 318<hr> 319<div class="refsect2"> 320<a name="GstKMSSink--plane-properties"></a><h3>The <code class="literal">“plane-properties”</code> property</h3> 321<pre class="programlisting"> “plane-properties” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</pre> 322<p>Additionnal properties for the plane.</p> 323<p>Flags: Read / Write</p> 324</div> 325<hr> 326<div class="refsect2"> 327<a name="GstKMSSink--restore-crtc"></a><h3>The <code class="literal">“restore-crtc”</code> property</h3> 328<pre class="programlisting"> “restore-crtc” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 329<p>When enabled and CRTC was set with a new mode, previous CRTC mode willbe restored when going to NULL state.</p> 330<p>Flags: Read / Write / Construct</p> 331<p>Default value: TRUE</p> 332</div> 333</div> 334</div> 335<div class="footer"> 336<hr>Generated by GTK-Doc V1.28</div> 337</body> 338</html>
