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>burn: 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-bulge.html" title="bulge"> 10<link rel="next" href="gst-plugins-bad-plugins-bz2dec.html" title="bz2dec"> 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-burn.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-burn.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-burn.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-bad-plugins-bulge.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-bad-plugins-bz2dec.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-bad-plugins-burn"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-burn.top_of_page"></a>burn</span></h2> 32<p>burn</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-bad-plugins-burn.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-burn.html#GstBurn--silent" title="The “silent” property">silent</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-burn.html#GstBurn--adjustment" title="The “adjustment” property">adjustment</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55</tbody> 56</table></div> 57</div> 58<a name="GstBurn"></a><div class="refsect1"> 59<a name="gst-plugins-bad-plugins-burn.other"></a><h2>Types and Values</h2> 60<div class="informaltable"><table class="informaltable" width="100%" border="0"> 61<colgroup> 62<col width="150px" class="name"> 63<col class="description"> 64</colgroup> 65<tbody><tr> 66<td class="datatype_keyword">struct</td> 67<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-burn.html#GstBurn-struct" title="struct GstBurn">GstBurn</a></td> 68</tr></tbody> 69</table></div> 70</div> 71<div class="refsect1"> 72<a name="gst-plugins-bad-plugins-burn.object-hierarchy"></a><h2>Object Hierarchy</h2> 73<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 74 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 75 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 77 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 78 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 79 <span class="lineart">╰──</span> GstBurn 80</pre> 81</div> 82<div class="refsect1"> 83<a name="gst-plugins-bad-plugins-burn.description"></a><h2>Description</h2> 84<p>Burn adjusts the colors of a video stream in realtime.</p> 85<div class="refsect3"> 86<a name="id-1.2.26.7.3"></a><h4>Example launch line</h4> 87<div class="informalexample"> 88 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 89 <tbody> 90 <tr> 91 <td class="listing_lines" align="right"><pre>1</pre></td> 92 <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> burn <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 93 </tr> 94 </tbody> 95 </table> 96</div> 97 98<p> This pipeline shows the effect of burn on a test stream</p> 99</div> 100<div class="refsynopsisdiv"> 101<h2>Synopsis</h2> 102<div class="refsect2"> 103<a name="id-1.2.26.7.4.1"></a><h3>Element Information</h3> 104<div class="variablelist"><table border="0" class="variablelist"> 105<colgroup> 106<col align="left" valign="top"> 107<col> 108</colgroup> 109<tbody> 110<tr> 111<td><p><span class="term">plugin</span></p></td> 112<td> 113 <a class="link" href="gst-plugins-bad-plugins-plugin-gaudieffects.html#plugin-gaudieffects">gaudieffects</a> 114 </td> 115</tr> 116<tr> 117<td><p><span class="term">author</span></p></td> 118<td>Luis de Bethencourt <luis@debethencourt.com></td> 119</tr> 120<tr> 121<td><p><span class="term">class</span></p></td> 122<td>Filter/Effect/Video</td> 123</tr> 124</tbody> 125</table></div> 126</div> 127<hr> 128<div class="refsect2"> 129<a name="id-1.2.26.7.4.2"></a><h3>Element Pads</h3> 130<div class="variablelist"><table border="0" class="variablelist"> 131<colgroup> 132<col align="left" valign="top"> 133<col> 134</colgroup> 135<tbody> 136<tr> 137<td><p><span class="term">name</span></p></td> 138<td>sink</td> 139</tr> 140<tr> 141<td><p><span class="term">direction</span></p></td> 142<td>sink</td> 143</tr> 144<tr> 145<td><p><span class="term">presence</span></p></td> 146<td>always</td> 147</tr> 148<tr> 149<td><p><span class="term">details</span></p></td> 150<td>video/x-raw, format=(string){ BGRx, RGBx }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 151</tr> 152</tbody> 153</table></div> 154<div class="variablelist"><table border="0" class="variablelist"> 155<colgroup> 156<col align="left" valign="top"> 157<col> 158</colgroup> 159<tbody> 160<tr> 161<td><p><span class="term">name</span></p></td> 162<td>src</td> 163</tr> 164<tr> 165<td><p><span class="term">direction</span></p></td> 166<td>source</td> 167</tr> 168<tr> 169<td><p><span class="term">presence</span></p></td> 170<td>always</td> 171</tr> 172<tr> 173<td><p><span class="term">details</span></p></td> 174<td>video/x-raw, format=(string){ BGRx, RGBx }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 175</tr> 176</tbody> 177</table></div> 178</div> 179</div> 180</div> 181<div class="refsect1"> 182<a name="gst-plugins-bad-plugins-burn.functions_details"></a><h2>Functions</h2> 183<p></p> 184</div> 185<div class="refsect1"> 186<a name="gst-plugins-bad-plugins-burn.other_details"></a><h2>Types and Values</h2> 187<div class="refsect2"> 188<a name="GstBurn-struct"></a><h3>struct GstBurn</h3> 189<pre class="programlisting">struct GstBurn;</pre> 190</div> 191</div> 192<div class="refsect1"> 193<a name="gst-plugins-bad-plugins-burn.property-details"></a><h2>Property Details</h2> 194<div class="refsect2"> 195<a name="GstBurn--silent"></a><h3>The <code class="literal">“silent”</code> property</h3> 196<pre class="programlisting"> “silent” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 197<p>Produce verbose output ?.</p> 198<p>Flags: Read / Write</p> 199<p>Default value: FALSE</p> 200</div> 201<hr> 202<div class="refsect2"> 203<a name="GstBurn--adjustment"></a><h3>The <code class="literal">“adjustment”</code> property</h3> 204<pre class="programlisting"> “adjustment” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 205<p>Adjustment parameter.</p> 206<p>Flags: Read / Write</p> 207<p>Allowed values: <= 256</p> 208<p>Default value: 175</p> 209</div> 210</div> 211</div> 212<div class="footer"> 213<hr>Generated by GTK-Doc V1.28</div> 214</body> 215</html>
