Google Git
Sign in
coral / mtk-gst-plugins-bad-debian / 9a6b9ee2ad9136de028eec974900a2ef0158488b / . / docs / plugins / html / gst-plugins-bad-plugins-compositor.html
blob: 3183ec09b3e6d1e45ae9b5db0fd0d7cafd31fda9 [file] [log] [blame]
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]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">
Sebastian Dröge78ac2892015-06-07 10:59:27 +0200[diff] [blame]5<title>compositor: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
Sebastian Dröge3cc648b2016-02-19 11:22:31 +0200[diff] [blame]6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]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-coloreffects.html" title="coloreffects">
10<link rel="next" href="gst-plugins-bad-plugins-cvdilate.html" title="cvdilate">
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]11<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]12<link rel="stylesheet" href="style.css" type="text/css">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]16<td width="100%" align="left" class="shortcuts">
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gst-plugins-bad-plugins-compositor.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]19 <a href="#gst-plugins-bad-plugins-compositor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
20 <a href="#gst-plugins-bad-plugins-compositor.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]21 <a href="#gst-plugins-bad-plugins-compositor.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-coloreffects.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-cvdilate.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-compositor"></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-compositor.top_of_page"></a>compositor</span></h2>
Sebastian Dröged1702b92015-06-24 23:26:45 +0200[diff] [blame]33<p>compositor</p>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]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-compositor.properties"></a><h2>Properties</h2>
Sebastian Dröge3cc648b2016-02-19 11:22:31 +0200[diff] [blame]39<div class="informaltable"><table class="informaltable" border="0">
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]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><tr>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]46<td class="property_type"><a class="link" href="gst-plugins-bad-plugins-compositor.html#GstCompositorBackground" title="enum GstCompositorBackground"><span class="type">GstCompositorBackground</span></a></td>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-compositor.html#GstCompositor--background" title="The “background” property">background</a></td>
48<td class="property_flags">Read / Write</td>
49</tr></tbody>
50</table></div>
51</div>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]52<a name="GstCompositor"></a><div class="refsect1">
53<a name="gst-plugins-bad-plugins-compositor.other"></a><h2>Types and Values</h2>
54<div class="informaltable"><table class="informaltable" width="100%" border="0">
55<colgroup>
56<col width="150px" class="name">
57<col class="description">
58</colgroup>
59<tbody>
60<tr>
61<td class="datatype_keyword">struct</td>
62<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-compositor.html#GstCompositor-struct" title="struct GstCompositor">GstCompositor</a></td>
63</tr>
64<tr>
65<td class="datatype_keyword">enum</td>
66<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-compositor.html#GstCompositorBackground" title="enum GstCompositorBackground">GstCompositorBackground</a></td>
67</tr>
68</tbody>
69</table></div>
70</div>
71<div class="refsect1">
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]72<a name="gst-plugins-bad-plugins-compositor.object-hierarchy"></a><h2>Object Hierarchy</h2>
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]73<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
74 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
75 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstObject.html#GstObject-struct">GstObject</a>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct">GstElement</a>
Sebastian Dröge69c23d62017-01-30 15:48:41 +0200[diff] [blame]77 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-bad-libs-1.0GstAggregator.html#GstAggregator-struct">GstAggregator</a>
78 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-bad-libs-1.0GstVideoAggregator.html#GstVideoAggregator-struct">GstVideoAggregator</a>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]79 <span class="lineart">╰──</span> GstCompositor
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]80</pre>
81</div>
82<div class="refsect1">
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]83<a name="gst-plugins-bad-plugins-compositor.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
84<p>
85GstCompositor implements
86 <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a>.</p>
87</div>
88<div class="refsect1">
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]89<a name="gst-plugins-bad-plugins-compositor.description"></a><h2>Description</h2>
90<p>Compositor can accept AYUV, ARGB and BGRA video streams. For each of the requested
91sink pads it will compare the incoming geometry and framerate to define the
92output parameters. Indeed output video frames will have the geometry of the
93biggest incoming video stream and the framerate of the fastest incoming one.</p>
94<p>Compositor will do colorspace conversion.</p>
95<p>Individual parameters for each input stream can be configured on the
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]96<span class="type">GstCompositorPad</span>:</p>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]97<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
98<li class="listitem">
99"xpos": The x-coordinate position of the top-left corner of the picture
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]100(<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a>)
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]101</li>
102<li class="listitem">
103"ypos": The y-coordinate position of the top-left corner of the picture
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]104(<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a>)
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]105</li>
106<li class="listitem">
107"width": The width of the picture; the input will be scaled if necessary
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]108(<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a>)
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]109</li>
110<li class="listitem">
111"height": The height of the picture; the input will be scaled if necessary
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]112(<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a>)
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]113</li>
114<li class="listitem">
115"alpha": The transparency of the picture; between 0.0 and 1.0. The blending
116is a simple copy when fully-transparent (0.0) and fully-opaque (1.0).
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]117(<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>)
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]118</li>
119<li class="listitem">
Sebastian Dröged1702b92015-06-24 23:26:45 +0200[diff] [blame]120"zorder": The z-order position of the picture in the composition
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]121(<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a>)
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]122</li>
123</ul></div>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]124<div class="refsect2">
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300[diff] [blame]125<a name="id-1.2.17.8.6"></a><h3>Sample pipelines</h3>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]126<div class="informalexample">
127 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
128 <tbody>
129 <tr>
130 <td class="listing_lines" align="right"><pre>1
1312
1323
1334
1345
1356
1367
1378</pre></td>
138 <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> \
139 videotestsrc pattern<span class="gtkdoc opt">=</span><span class="number">1</span> <span class="gtkdoc opt">!</span> \
140 video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=</span>AYUV<span class="gtkdoc opt">,</span>framerate<span class="gtkdoc opt">=</span>\<span class="gtkdoc opt">(</span>fraction\<span class="gtkdoc opt">)</span><span class="number">10</span><span class="gtkdoc opt">/</span><span class="number">1</span><span class="gtkdoc opt">,</span>width<span class="gtkdoc opt">=</span><span class="number">100</span><span class="gtkdoc opt">,</span>height<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> \
141 videobox border<span class="gtkdoc opt">-</span>alpha<span class="gtkdoc opt">=</span><span class="number">0</span> top<span class="gtkdoc opt">=-</span><span class="number">70</span> bottom<span class="gtkdoc opt">=-</span><span class="number">70</span> right<span class="gtkdoc opt">=-</span><span class="number">220</span> <span class="gtkdoc opt">!</span> \
142 compositor name<span class="gtkdoc opt">=</span>comp sink_0<span class="gtkdoc opt">::</span>alpha<span class="gtkdoc opt">=</span><span class="number">0.7</span> sink_1<span class="gtkdoc opt">::</span>alpha<span class="gtkdoc opt">=</span><span class="number">0.5</span> <span class="gtkdoc opt">!</span> \
143 videoconvert <span class="gtkdoc opt">!</span> xvimagesink \
144 videotestsrc <span class="gtkdoc opt">!</span> \
145 video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=</span>AYUV<span class="gtkdoc opt">,</span>framerate<span class="gtkdoc opt">=</span>\<span class="gtkdoc opt">(</span>fraction\<span class="gtkdoc opt">)</span><span class="number">5</span><span class="gtkdoc opt">/</span><span class="number">1</span><span class="gtkdoc opt">,</span>width<span class="gtkdoc opt">=</span><span class="number">320</span><span class="gtkdoc opt">,</span>height<span class="gtkdoc opt">=</span><span class="number">240</span> <span class="gtkdoc opt">!</span> comp<span class="gtkdoc opt">.</span></pre></td>
146 </tr>
147 </tbody>
148 </table>
149</div>
150 A pipeline to demonstrate compositor used together with videobox.
151This should show a 320x240 pixels video test source with some transparency
152showing the background checker pattern. Another video test source with just
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]153the snow pattern of 100x100 pixels is overlaid on top of the first one on
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]154the left vertically centered with a small transparency showing the first
155video test source behind and the checker pattern under it. Note that the
156framerate of the output video is 10 frames per second.
157<div class="informalexample">
158 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
159 <tbody>
160 <tr>
161 <td class="listing_lines" align="right"><pre>1
1622
1633
1644
1655</pre></td>
166 <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 pattern<span class="gtkdoc opt">=</span><span class="number">1</span> <span class="gtkdoc opt">!</span> \
167 video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span> framerate<span class="gtkdoc opt">=</span>\<span class="gtkdoc opt">(</span>fraction\<span class="gtkdoc opt">)</span><span class="number">10</span><span class="gtkdoc opt">/</span><span class="number">1</span><span class="gtkdoc opt">,</span> width<span class="gtkdoc opt">=</span><span class="number">100</span><span class="gtkdoc opt">,</span> height<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> \
168 compositor name<span class="gtkdoc opt">=</span>comp <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> ximagesink \
169 videotestsrc <span class="gtkdoc opt">!</span> \
170 video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span> framerate<span class="gtkdoc opt">=</span>\<span class="gtkdoc opt">(</span>fraction\<span class="gtkdoc opt">)</span><span class="number">5</span><span class="gtkdoc opt">/</span><span class="number">1</span><span class="gtkdoc opt">,</span> width<span class="gtkdoc opt">=</span><span class="number">320</span><span class="gtkdoc opt">,</span> height<span class="gtkdoc opt">=</span><span class="number">240</span> <span class="gtkdoc opt">!</span> comp<span class="gtkdoc opt">.</span></pre></td>
171 </tr>
172 </tbody>
173 </table>
174</div>
175 A pipeline to demostrate bgra comping. (This does not demonstrate alpha blending).
176<div class="informalexample">
177 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
178 <tbody>
179 <tr>
180 <td class="listing_lines" align="right"><pre>1
1812
1823
1834
1845</pre></td>
185 <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 pattern<span class="gtkdoc opt">=</span><span class="number">1</span> <span class="gtkdoc opt">!</span> \
186 video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>format <span class="gtkdoc opt">=</span>I420<span class="gtkdoc opt">,</span> framerate<span class="gtkdoc opt">=</span>\<span class="gtkdoc opt">(</span>fraction\<span class="gtkdoc opt">)</span><span class="number">10</span><span class="gtkdoc opt">/</span><span class="number">1</span><span class="gtkdoc opt">,</span> width<span class="gtkdoc opt">=</span><span class="number">100</span><span class="gtkdoc opt">,</span> height<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> \
187 compositor name<span class="gtkdoc opt">=</span>comp <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> ximagesink \
188 videotestsrc <span class="gtkdoc opt">!</span> \
189 video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=</span>I420<span class="gtkdoc opt">,</span> framerate<span class="gtkdoc opt">=</span>\<span class="gtkdoc opt">(</span>fraction\<span class="gtkdoc opt">)</span><span class="number">5</span><span class="gtkdoc opt">/</span><span class="number">1</span><span class="gtkdoc opt">,</span> width<span class="gtkdoc opt">=</span><span class="number">320</span><span class="gtkdoc opt">,</span> height<span class="gtkdoc opt">=</span><span class="number">240</span> <span class="gtkdoc opt">!</span> comp<span class="gtkdoc opt">.</span></pre></td>
190 </tr>
191 </tbody>
192 </table>
193</div>
194 A pipeline to test I420
195<div class="informalexample">
196 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
197 <tbody>
198 <tr>
199 <td class="listing_lines" align="right"><pre>1
2002
2013
2024
2035
2046
2057
2068</pre></td>
207 <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> compositor name<span class="gtkdoc opt">=</span>comp sink_1<span class="gtkdoc opt">::</span>alpha<span class="gtkdoc opt">=</span><span class="number">0.5</span> sink_1<span class="gtkdoc opt">::</span>xpos<span class="gtkdoc opt">=</span><span class="number">50</span> sink_1<span class="gtkdoc opt">::</span>ypos<span class="gtkdoc opt">=</span><span class="number">50</span> <span class="gtkdoc opt">!</span> \
208 videoconvert <span class="gtkdoc opt">!</span> ximagesink \
209 videotestsrc pattern<span class="gtkdoc opt">=</span>snow timestamp<span class="gtkdoc opt">-</span>offset<span class="gtkdoc opt">=</span><span class="number">3000000000</span> <span class="gtkdoc opt">!</span> \
210 <span class="string">&quot;video/x-raw,format=AYUV,width=640,height=480,framerate=(fraction)30/1&quot;</span> <span class="gtkdoc opt">!</span> \
211 timeoverlay <span class="gtkdoc opt">!</span> queue2 <span class="gtkdoc opt">!</span> comp<span class="gtkdoc opt">.</span> \
212 videotestsrc pattern<span class="gtkdoc opt">=</span>smpte <span class="gtkdoc opt">!</span> \
213 <span class="string">&quot;video/x-raw,format=AYUV,width=800,height=600,framerate=(fraction)10/1&quot;</span> <span class="gtkdoc opt">!</span> \
214 timeoverlay <span class="gtkdoc opt">!</span> queue2 <span class="gtkdoc opt">!</span> comp<span class="gtkdoc opt">.</span></pre></td>
215 </tr>
216 </tbody>
217 </table>
218</div>
219 A pipeline to demonstrate synchronized compositing (the second stream starts after 3 seconds)
220</div>
Sebastian Dröge78ac2892015-06-07 10:59:27 +0200[diff] [blame]221<div class="refsynopsisdiv">
222<h2>Synopsis</h2>
223<div class="refsect2">
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300[diff] [blame]224<a name="id-1.2.17.8.7.1"></a><h3>Element Information</h3>
Sebastian Dröge78ac2892015-06-07 10:59:27 +0200[diff] [blame]225<div class="variablelist"><table border="0" class="variablelist">
226<colgroup>
227<col align="left" valign="top">
228<col>
229</colgroup>
230<tbody>
231<tr>
232<td><p><span class="term">plugin</span></p></td>
233<td>
234 compositor
235 </td>
236</tr>
237<tr>
238<td><p><span class="term">author</span></p></td>
239<td>Wim Taymans &lt;wim@fluendo.com&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
240</tr>
241<tr>
242<td><p><span class="term">class</span></p></td>
243<td>Filter/Editor/Video/Compositor</td>
244</tr>
245</tbody>
246</table></div>
247</div>
248<hr>
249<div class="refsect2">
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300[diff] [blame]250<a name="id-1.2.17.8.7.2"></a><h3>Element Pads</h3>
Sebastian Dröge78ac2892015-06-07 10:59:27 +0200[diff] [blame]251<div class="variablelist"><table border="0" class="variablelist">
252<colgroup>
253<col align="left" valign="top">
254<col>
255</colgroup>
256<tbody>
257<tr>
258<td><p><span class="term">name</span></p></td>
259<td>sink_%u</td>
260</tr>
261<tr>
262<td><p><span class="term">direction</span></p></td>
263<td>sink</td>
264</tr>
265<tr>
266<td><p><span class="term">presence</span></p></td>
267<td>request</td>
268</tr>
269<tr>
270<td><p><span class="term">details</span></p></td>
271<td>video/x-raw, format=(string){ AYUV, BGRA, ARGB, RGBA, ABGR, Y444, Y42B, YUY2, UYVY, YVYU, I420, YV12, NV12, NV21, Y41B, RGB, BGR, xRGB, xBGR, RGBx, BGRx }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
272</tr>
273</tbody>
274</table></div>
275<div class="variablelist"><table border="0" class="variablelist">
276<colgroup>
277<col align="left" valign="top">
278<col>
279</colgroup>
280<tbody>
281<tr>
282<td><p><span class="term">name</span></p></td>
283<td>src</td>
284</tr>
285<tr>
286<td><p><span class="term">direction</span></p></td>
287<td>source</td>
288</tr>
289<tr>
290<td><p><span class="term">presence</span></p></td>
291<td>always</td>
292</tr>
293<tr>
294<td><p><span class="term">details</span></p></td>
295<td>video/x-raw, format=(string){ AYUV, BGRA, ARGB, RGBA, ABGR, Y444, Y42B, YUY2, UYVY, YVYU, I420, YV12, NV12, NV21, Y41B, RGB, BGR, xRGB, xBGR, RGBx, BGRx }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
296</tr>
297</tbody>
298</table></div>
299</div>
300</div>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]301</div>
302<div class="refsect1">
303<a name="gst-plugins-bad-plugins-compositor.functions_details"></a><h2>Functions</h2>
Sebastian Dröge78ac2892015-06-07 10:59:27 +0200[diff] [blame]304<p></p>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]305</div>
306<div class="refsect1">
307<a name="gst-plugins-bad-plugins-compositor.other_details"></a><h2>Types and Values</h2>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]308<div class="refsect2">
309<a name="GstCompositor-struct"></a><h3>struct GstCompositor</h3>
310<pre class="programlisting">struct GstCompositor;</pre>
311<p>The opaque <a class="link" href="gst-plugins-bad-plugins-compositor.html#GstCompositor"><span class="type">GstCompositor</span></a> structure.</p>
312</div>
313<hr>
314<div class="refsect2">
315<a name="GstCompositorBackground"></a><h3>enum GstCompositorBackground</h3>
316<div class="refsect3">
317<a name="GstCompositorBackground.members"></a><h4>Members</h4>
318<div class="informaltable"><table class="informaltable" width="100%" border="0">
319<colgroup>
320<col width="300px" class="enum_members_name">
321<col class="enum_members_description">
322<col width="200px" class="enum_members_annotations">
323</colgroup>
324<tbody>
325<tr>
326<td class="enum_member_name"><p><a name="COMPOSITOR-BACKGROUND-CHECKER:CAPS"></a>COMPOSITOR_BACKGROUND_CHECKER</p></td>
327<td> </td>
328<td> </td>
329</tr>
330<tr>
331<td class="enum_member_name"><p><a name="COMPOSITOR-BACKGROUND-BLACK:CAPS"></a>COMPOSITOR_BACKGROUND_BLACK</p></td>
332<td> </td>
333<td> </td>
334</tr>
335<tr>
336<td class="enum_member_name"><p><a name="COMPOSITOR-BACKGROUND-WHITE:CAPS"></a>COMPOSITOR_BACKGROUND_WHITE</p></td>
337<td> </td>
338<td> </td>
339</tr>
340<tr>
341<td class="enum_member_name"><p><a name="COMPOSITOR-BACKGROUND-TRANSPARENT:CAPS"></a>COMPOSITOR_BACKGROUND_TRANSPARENT</p></td>
342<td> </td>
343<td> </td>
344</tr>
345</tbody>
346</table></div>
347</div>
348</div>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]349</div>
350<div class="refsect1">
351<a name="gst-plugins-bad-plugins-compositor.property-details"></a><h2>Property Details</h2>
352<div class="refsect2">
353<a name="GstCompositor--background"></a><h3>The <code class="literal">“background”</code> property</h3>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]354<pre class="programlisting"> “background” <a class="link" href="gst-plugins-bad-plugins-compositor.html#GstCompositorBackground" title="enum GstCompositorBackground"><span class="type">GstCompositorBackground</span></a></pre>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]355<p>Background type.</p>
356<p>Flags: Read / Write</p>
357<p>Default value: Checker pattern</p>
358</div>
359</div>
360</div>
361<div class="footer">
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]362<hr>Generated by GTK-Doc V1.25</div>
Sebastian Dröge1491e032014-06-22 19:09:53 +0200[diff] [blame]363</body>
364</html>