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>dvbsuboverlay: 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-dvbsrc.html" title="dvbsrc"> 10<link rel="next" href="gst-plugins-bad-plugins-dvdspu.html" title="dvdspu"> 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-dvbsuboverlay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-dvbsuboverlay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-dvbsuboverlay.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-dvbsrc.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-dvdspu.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-dvbsuboverlay"></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-dvbsuboverlay.top_of_page"></a>dvbsuboverlay</span></h2> 32<p>dvbsuboverlay</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-dvbsuboverlay.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-dvbsuboverlay.html#GstDVBSubOverlay--enable" title="The “enable” property">enable</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#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-dvbsuboverlay.html#GstDVBSubOverlay--max-page-timeout" title="The “max-page-timeout” property">max-page-timeout</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-dvbsuboverlay.html#GstDVBSubOverlay--force-end" title="The “force-end” property">force-end</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60</tbody> 61</table></div> 62</div> 63<a name="GstDVBSubOverlay"></a><div class="refsect1"> 64<a name="gst-plugins-bad-plugins-dvbsuboverlay.other"></a><h2>Types and Values</h2> 65<div class="informaltable"><table class="informaltable" width="100%" border="0"> 66<colgroup> 67<col width="150px" class="name"> 68<col class="description"> 69</colgroup> 70<tbody><tr> 71<td class="datatype_keyword">struct</td> 72<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-dvbsuboverlay.html#GstDVBSubOverlay-struct" title="struct GstDVBSubOverlay">GstDVBSubOverlay</a></td> 73</tr></tbody> 74</table></div> 75</div> 76<div class="refsect1"> 77<a name="gst-plugins-bad-plugins-dvbsuboverlay.object-hierarchy"></a><h2>Object Hierarchy</h2> 78<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 79 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 80 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 82 <span class="lineart">╰──</span> GstDVBSubOverlay 83</pre> 84</div> 85<div class="refsect1"> 86<a name="gst-plugins-bad-plugins-dvbsuboverlay.description"></a><h2>Description</h2> 87<p>Renders DVB subtitles on top of a video stream.</p> 88<div class="refsect3"> 89<a name="id-1.2.75.7.3"></a><h4>Example launch line</h4> 90<div class="informalexample"> 91 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 92 <tbody> 93 <tr> 94 <td class="listing_lines" align="right"><pre>1 952 963</pre></td> 97 <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 filesrc location<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>ts <span class="gtkdoc opt">!</span> mpegtsdemux name<span class="gtkdoc opt">=</span>d <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> mpegaudioparse <span class="gtkdoc opt">!</span> mpg123audiodec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> autoaudiosink \ 98 d<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> mpegvideoparse <span class="gtkdoc opt">!</span> mpeg2dec <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> r<span class="gtkdoc opt">.</span> \ 99 d<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> <span class="string">"subpicture/x-dvb"</span> <span class="gtkdoc opt">!</span> dvbsuboverlay name<span class="gtkdoc opt">=</span>r <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 100 </tr> 101 </tbody> 102 </table> 103</div> 104 105<p> This pipeline demuxes a MPEG-TS file with MPEG2 video, MP3 audio and embedded DVB subtitles and renders the subtitles on top of the video.</p> 106</div> 107<div class="refsynopsisdiv"> 108<h2>Synopsis</h2> 109<div class="refsect2"> 110<a name="id-1.2.75.7.4.1"></a><h3>Element Information</h3> 111<div class="variablelist"><table border="0" class="variablelist"> 112<colgroup> 113<col align="left" valign="top"> 114<col> 115</colgroup> 116<tbody> 117<tr> 118<td><p><span class="term">plugin</span></p></td> 119<td> 120 <a class="link" href="gst-plugins-bad-plugins-plugin-dvbsuboverlay.html#plugin-dvbsuboverlay">dvbsuboverlay</a> 121 </td> 122</tr> 123<tr> 124<td><p><span class="term">author</span></p></td> 125<td>Mart Raudsepp <mart.raudsepp@collabora.co.uk></td> 126</tr> 127<tr> 128<td><p><span class="term">class</span></p></td> 129<td>Mixer/Video/Overlay/Subtitle</td> 130</tr> 131</tbody> 132</table></div> 133</div> 134<hr> 135<div class="refsect2"> 136<a name="id-1.2.75.7.4.2"></a><h3>Element Pads</h3> 137<div class="variablelist"><table border="0" class="variablelist"> 138<colgroup> 139<col align="left" valign="top"> 140<col> 141</colgroup> 142<tbody> 143<tr> 144<td><p><span class="term">name</span></p></td> 145<td>text_sink</td> 146</tr> 147<tr> 148<td><p><span class="term">direction</span></p></td> 149<td>sink</td> 150</tr> 151<tr> 152<td><p><span class="term">presence</span></p></td> 153<td>always</td> 154</tr> 155<tr> 156<td><p><span class="term">details</span></p></td> 157<td>subpicture/x-dvb</td> 158</tr> 159</tbody> 160</table></div> 161<div class="variablelist"><table border="0" class="variablelist"> 162<colgroup> 163<col align="left" valign="top"> 164<col> 165</colgroup> 166<tbody> 167<tr> 168<td><p><span class="term">name</span></p></td> 169<td>video_sink</td> 170</tr> 171<tr> 172<td><p><span class="term">direction</span></p></td> 173<td>sink</td> 174</tr> 175<tr> 176<td><p><span class="term">presence</span></p></td> 177<td>always</td> 178</tr> 179<tr> 180<td><p><span class="term">details</span></p></td> 181<td>video/x-raw, format=(string){ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444, NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 182</tr> 183<tr> 184<td><p><span class="term"></span></p></td> 185<td> video/x-raw(ANY), format=(string){ I420, YV12, YUY2, UYVY, AYUV, VUYA, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, Y210, Y410, NV12, NV21, GRAY8, GRAY16_BE, GRAY16_LE, v308, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10BE, I420_10LE, I422_10BE, I422_10LE, Y444_10BE, Y444_10LE, GBR, GBR_10BE, GBR_10LE, NV16, NV24, NV12_64Z32, A420_10BE, A420_10LE, A422_10BE, A422_10LE, A444_10BE, A444_10LE, NV61, P010_10BE, P010_10LE, IYU2, VYUY, GBRA, GBRA_10BE, GBRA_10LE, BGR10A2_LE, GBR_12BE, GBR_12LE, GBRA_12BE, GBRA_12LE, I420_12BE, I420_12LE, I422_12BE, I422_12LE, Y444_12BE, Y444_12LE, GRAY10_LE32, NV12_10LE32, NV16_10LE32, NV12_10LE40 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 186</tr> 187</tbody> 188</table></div> 189<div class="variablelist"><table border="0" class="variablelist"> 190<colgroup> 191<col align="left" valign="top"> 192<col> 193</colgroup> 194<tbody> 195<tr> 196<td><p><span class="term">name</span></p></td> 197<td>src</td> 198</tr> 199<tr> 200<td><p><span class="term">direction</span></p></td> 201<td>source</td> 202</tr> 203<tr> 204<td><p><span class="term">presence</span></p></td> 205<td>always</td> 206</tr> 207<tr> 208<td><p><span class="term">details</span></p></td> 209<td>video/x-raw, format=(string){ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444, NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 210</tr> 211<tr> 212<td><p><span class="term"></span></p></td> 213<td> video/x-raw(ANY), format=(string){ I420, YV12, YUY2, UYVY, AYUV, VUYA, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, Y210, Y410, NV12, NV21, GRAY8, GRAY16_BE, GRAY16_LE, v308, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10BE, I420_10LE, I422_10BE, I422_10LE, Y444_10BE, Y444_10LE, GBR, GBR_10BE, GBR_10LE, NV16, NV24, NV12_64Z32, A420_10BE, A420_10LE, A422_10BE, A422_10LE, A444_10BE, A444_10LE, NV61, P010_10BE, P010_10LE, IYU2, VYUY, GBRA, GBRA_10BE, GBRA_10LE, BGR10A2_LE, GBR_12BE, GBR_12LE, GBRA_12BE, GBRA_12LE, I420_12BE, I420_12LE, I422_12BE, I422_12LE, Y444_12BE, Y444_12LE, GRAY10_LE32, NV12_10LE32, NV16_10LE32, NV12_10LE40 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 214</tr> 215</tbody> 216</table></div> 217</div> 218</div> 219</div> 220<div class="refsect1"> 221<a name="gst-plugins-bad-plugins-dvbsuboverlay.functions_details"></a><h2>Functions</h2> 222<p></p> 223</div> 224<div class="refsect1"> 225<a name="gst-plugins-bad-plugins-dvbsuboverlay.other_details"></a><h2>Types and Values</h2> 226<div class="refsect2"> 227<a name="GstDVBSubOverlay-struct"></a><h3>struct GstDVBSubOverlay</h3> 228<pre class="programlisting">struct GstDVBSubOverlay;</pre> 229</div> 230</div> 231<div class="refsect1"> 232<a name="gst-plugins-bad-plugins-dvbsuboverlay.property-details"></a><h2>Property Details</h2> 233<div class="refsect2"> 234<a name="GstDVBSubOverlay--enable"></a><h3>The <code class="literal">“enable”</code> property</h3> 235<pre class="programlisting"> “enable” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 236<p>Enable rendering of subtitles.</p> 237<p>Flags: Read / Write</p> 238<p>Default value: TRUE</p> 239</div> 240<hr> 241<div class="refsect2"> 242<a name="GstDVBSubOverlay--max-page-timeout"></a><h3>The <code class="literal">“max-page-timeout”</code> property</h3> 243<pre class="programlisting"> “max-page-timeout” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 244<p>Limit maximum display time of a subtitle page (0 - disabled, value in seconds).</p> 245<p>Flags: Read / Write</p> 246<p>Allowed values: >= 0</p> 247<p>Default value: 0</p> 248</div> 249<hr> 250<div class="refsect2"> 251<a name="GstDVBSubOverlay--force-end"></a><h3>The <code class="literal">“force-end”</code> property</h3> 252<pre class="programlisting"> “force-end” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 253<p>Assume PES-aligned subtitles and force end-of-display.</p> 254<p>Flags: Read / Write</p> 255<p>Default value: FALSE</p> 256</div> 257</div> 258</div> 259<div class="footer"> 260<hr>Generated by GTK-Doc V1.28</div> 261</body> 262</html>
