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>subtitleoverlay: GStreamer Base 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 Base Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-base Elements"> 9<link rel="prev" href="gst-plugins-base-plugins-subparse.html" title="subparse"> 10<link rel="next" href="gst-plugins-base-plugins-tcpclientsink.html" title="tcpclientsink"> 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-base-plugins-subtitleoverlay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-subtitleoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-subtitleoverlay.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-base-plugins-subtitleoverlay.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-base-plugins-subparse.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-base-plugins-tcpclientsink.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-base-plugins-subtitleoverlay"></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-base-plugins-subtitleoverlay.top_of_page"></a>subtitleoverlay</span></h2> 33<p>subtitleoverlay</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-base-plugins-subtitleoverlay.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"> 48<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 49<td class="property_name"><a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay--font-desc" title="The “font-desc” property">font-desc</a></td> 50<td class="property_flags">Read / Write</td> 51</tr> 52<tr> 53<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 54<td class="property_name"><a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay--silent" title="The “silent” property">silent</a></td> 55<td class="property_flags">Read / Write</td> 56</tr> 57<tr> 58<td class="property_type"> 59<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 60<td class="property_name"><a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay--subtitle-encoding" title="The “subtitle-encoding” property">subtitle-encoding</a></td> 61<td class="property_flags">Read / Write</td> 62</tr> 63<tr> 64<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td> 65<td class="property_name"><a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay--subtitle-ts-offset" title="The “subtitle-ts-offset” property">subtitle-ts-offset</a></td> 66<td class="property_flags">Read / Write</td> 67</tr> 68</tbody> 69</table></div> 70</div> 71<a name="GstSubtitleOverlay"></a><div class="refsect1"> 72<a name="gst-plugins-base-plugins-subtitleoverlay.other"></a><h2>Types and Values</h2> 73<div class="informaltable"><table class="informaltable" width="100%" border="0"> 74<colgroup> 75<col width="150px" class="name"> 76<col class="description"> 77</colgroup> 78<tbody><tr> 79<td class="datatype_keyword">struct</td> 80<td class="function_name"><a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay-struct" title="struct GstSubtitleOverlay">GstSubtitleOverlay</a></td> 81</tr></tbody> 82</table></div> 83</div> 84<div class="refsect1"> 85<a name="gst-plugins-base-plugins-subtitleoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2> 86<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 87 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 88 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 89 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 90 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBin.html#GstBin-struct">GstBin</a> 91 <span class="lineart">╰──</span> GstSubtitleOverlay 92</pre> 93</div> 94<div class="refsect1"> 95<a name="gst-plugins-base-plugins-subtitleoverlay.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 96<p> 97GstSubtitleOverlay implements 98 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a>.</p> 99</div> 100<div class="refsect1"> 101<a name="gst-plugins-base-plugins-subtitleoverlay.description"></a><h2>Description</h2> 102<p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBin.html#GstBin-struct"><span class="type">GstBin</span></a> that auto-magically overlays a video stream with subtitles by 103autoplugging the required elements.</p> 104<p>It supports raw, timestamped text, different textual subtitle formats and 105DVD subpicture subtitles.</p> 106<div class="refsect3"> 107<a name="id-1.2.92.8.4"></a><h4>Examples</h4> 108<div class="informalexample"> 109 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 110 <tbody> 111 <tr> 112 <td class="listing_lines" align="right"><pre>1</pre></td> 113 <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>test<span class="gtkdoc opt">.</span>mkv <span class="gtkdoc opt">!</span> matroskademux name<span class="gtkdoc opt">=</span>demux <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>h264 <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> subtitleoverlay name<span class="gtkdoc opt">=</span>overlay <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink demux<span class="gtkdoc opt">. !</span> subpicture<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>dvd <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> overlay<span class="gtkdoc opt">.</span></pre></td> 114 </tr> 115 </tbody> 116 </table> 117</div> 118 119<p> 120 This will play back the given Matroska file with h264 video and dvd subpicture style subtitles.</p> 121</div> 122<div class="refsynopsisdiv"> 123<h2>Synopsis</h2> 124<div class="refsect2"> 125<a name="id-1.2.92.8.5.1"></a><h3>Element Information</h3> 126<div class="variablelist"><table border="0" class="variablelist"> 127<colgroup> 128<col align="left" valign="top"> 129<col> 130</colgroup> 131<tbody> 132<tr> 133<td><p><span class="term">plugin</span></p></td> 134<td> 135 <a class="link" href="gst-plugins-base-plugins-plugin-playback.html#plugin-playback">playback</a> 136 </td> 137</tr> 138<tr> 139<td><p><span class="term">author</span></p></td> 140<td>Sebastian Dröge <sebastian.droege@collabora.co.uk></td> 141</tr> 142<tr> 143<td><p><span class="term">class</span></p></td> 144<td>Video/Overlay/Subtitle</td> 145</tr> 146</tbody> 147</table></div> 148</div> 149<hr> 150<div class="refsect2"> 151<a name="id-1.2.92.8.5.2"></a><h3>Element Pads</h3> 152<div class="variablelist"><table border="0" class="variablelist"> 153<colgroup> 154<col align="left" valign="top"> 155<col> 156</colgroup> 157<tbody> 158<tr> 159<td><p><span class="term">name</span></p></td> 160<td>subtitle_sink</td> 161</tr> 162<tr> 163<td><p><span class="term">direction</span></p></td> 164<td>sink</td> 165</tr> 166<tr> 167<td><p><span class="term">presence</span></p></td> 168<td>always</td> 169</tr> 170<tr> 171<td><p><span class="term">details</span></p></td> 172<td>ANY</td> 173</tr> 174</tbody> 175</table></div> 176<div class="variablelist"><table border="0" class="variablelist"> 177<colgroup> 178<col align="left" valign="top"> 179<col> 180</colgroup> 181<tbody> 182<tr> 183<td><p><span class="term">name</span></p></td> 184<td>video_sink</td> 185</tr> 186<tr> 187<td><p><span class="term">direction</span></p></td> 188<td>sink</td> 189</tr> 190<tr> 191<td><p><span class="term">presence</span></p></td> 192<td>always</td> 193</tr> 194<tr> 195<td><p><span class="term">details</span></p></td> 196<td>ANY</td> 197</tr> 198</tbody> 199</table></div> 200<div class="variablelist"><table border="0" class="variablelist"> 201<colgroup> 202<col align="left" valign="top"> 203<col> 204</colgroup> 205<tbody> 206<tr> 207<td><p><span class="term">name</span></p></td> 208<td>src</td> 209</tr> 210<tr> 211<td><p><span class="term">direction</span></p></td> 212<td>source</td> 213</tr> 214<tr> 215<td><p><span class="term">presence</span></p></td> 216<td>always</td> 217</tr> 218<tr> 219<td><p><span class="term">details</span></p></td> 220<td>ANY</td> 221</tr> 222</tbody> 223</table></div> 224</div> 225</div> 226</div> 227<div class="refsect1"> 228<a name="gst-plugins-base-plugins-subtitleoverlay.functions_details"></a><h2>Functions</h2> 229<p></p> 230</div> 231<div class="refsect1"> 232<a name="gst-plugins-base-plugins-subtitleoverlay.other_details"></a><h2>Types and Values</h2> 233<div class="refsect2"> 234<a name="GstSubtitleOverlay-struct"></a><h3>struct GstSubtitleOverlay</h3> 235<pre class="programlisting">struct GstSubtitleOverlay;</pre> 236</div> 237</div> 238<div class="refsect1"> 239<a name="gst-plugins-base-plugins-subtitleoverlay.property-details"></a><h2>Property Details</h2> 240<div class="refsect2"> 241<a name="GstSubtitleOverlay--font-desc"></a><h3>The <code class="literal">“font-desc”</code> property</h3> 242<pre class="programlisting"> “font-desc” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 243<p>Pango font description of font to be used for subtitle rendering.</p> 244<p>Flags: Read / Write</p> 245<p>Default value: NULL</p> 246</div> 247<hr> 248<div class="refsect2"> 249<a name="GstSubtitleOverlay--silent"></a><h3>The <code class="literal">“silent”</code> property</h3> 250<pre class="programlisting"> “silent” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 251<p>Whether to show subtitles.</p> 252<p>Flags: Read / Write</p> 253<p>Default value: FALSE</p> 254</div> 255<hr> 256<div class="refsect2"> 257<a name="GstSubtitleOverlay--subtitle-encoding"></a><h3>The <code class="literal">“subtitle-encoding”</code> property</h3> 258<pre class="programlisting"> “subtitle-encoding” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 259<p>Encoding to assume if input subtitles are not in UTF-8 encoding. If not set, the GST_SUBTITLE_ENCODING environment variable will be checked for an encoding to use. If that is not set either, ISO-8859-15 will be assumed.</p> 260<p>Flags: Read / Write</p> 261<p>Default value: NULL</p> 262</div> 263<hr> 264<div class="refsect2"> 265<a name="GstSubtitleOverlay--subtitle-ts-offset"></a><h3>The <code class="literal">“subtitle-ts-offset”</code> property</h3> 266<pre class="programlisting"> “subtitle-ts-offset” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre> 267<p>The synchronisation offset between text and video in nanoseconds.</p> 268<p>Flags: Read / Write</p> 269<p>Default value: 0</p> 270</div> 271</div> 272</div> 273<div class="footer"> 274<hr>Generated by GTK-Doc V1.28</div> 275</body> 276</html>
