docs/plugins/html/gst-plugins-base-plugins-subtitleoverlay.html

   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</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-playbin2.html" title="playbin2">
  10 <link rel="next" href="gst-plugins-base-plugins-tcpclientsrc.html" title="tcpclientsrc">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-plugins-playbin2.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-tcpclientsrc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-plugins-subtitleoverlay.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-subtitleoverlay.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-subtitleoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-subtitleoverlay.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-subtitleoverlay.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-subtitleoverlay"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-subtitleoverlay.top_of_page"></a>subtitleoverlay</span></h2>
  40 <p>subtitleoverlay — Overlays a video stream with subtitles</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-base-plugins-subtitleoverlay.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstSubtitleOverlay"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay-struct" title="struct GstSubtitleOverlay">GstSubtitleOverlay</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-plugins-subtitleoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstBin.html">GstBin</a>
  56                      +----GstSubtitleOverlay
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-base-plugins-subtitleoverlay.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  61 <p>
  62 GstSubtitleOverlay implements
  63  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstChildProxy.html">GstChildProxy</a>.</p>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-base-plugins-subtitleoverlay.properties"></a><h2>Properties</h2>
  67 <pre class="synopsis">
  68   "<a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay--font-desc" title='The "font-desc" property'>font-desc</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  69   "<a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay--silent" title='The "silent" property'>silent</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  70   "<a class="link" href="gst-plugins-base-plugins-subtitleoverlay.html#GstSubtitleOverlay--subtitle-encoding" title='The "subtitle-encoding" property'>subtitle-encoding</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  71 </pre>
  72 </div>
  73 <div class="refsect1">
  74 <a name="gst-plugins-base-plugins-subtitleoverlay.description"></a><h2>Description</h2>
  75 <p>
  76 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstBin.html"><span class="type">GstBin</span></a> that auto-magically overlays a video stream with subtitles by
  77 autoplugging the required elements.
  78 </p>
  79 <p>
  80 It supports raw, timestamped text, different textual subtitle formats and
  81 DVD subpicture subtitles.
  82 </p>
  83 <p>
  84 </p>
  85 <div class="refsect2">
  86 <a name="idp9764400"></a><h3>Examples</h3>
  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>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> <span class="string">&quot;video/x-h264&quot;</span> <span class="gtkdoc opt">!</span> queue2 <span class="gtkdoc opt">!</span> decodebin2 <span class="gtkdoc opt">!</span> subtitleoverlay name<span class="gtkdoc opt">=</span>overlay <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> autovideosink  demux<span class="gtkdoc opt">. !</span> <span class="string">&quot;video/x-dvd-subpicture&quot;</span> <span class="gtkdoc opt">!</span> queue2 <span class="gtkdoc opt">!</span> overlay<span class="gtkdoc opt">.</span></pre></td>
  93       </tr>
  94     </tbody>
  95   </table>
  96 </div>
  97  This will play back the given Matroska file with h264 video and subpicture subtitles.
  98 </div>
  99 <p>
 100 </p>
 101 <div class="refsynopsisdiv">
 102 <h2>Synopsis</h2>
 103 <div class="refsect2">
 104 <a name="idp6545120"></a><h3>Element Information</h3>
 105 <div class="variablelist"><table border="0">
 106 <col align="left" valign="top">
 107 <tbody>
 108 <tr>
 109 <td><p><span class="term">plugin</span></p></td>
 110 <td>
 111             <a class="link" href="gst-plugins-base-plugins-plugin-playback.html#plugin-playback">playback</a>
 112           </td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">author</span></p></td>
 116 <td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">class</span></p></td>
 120 <td>Video/Overlay/Subtitle</td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="idp13490496"></a><h3>Element Pads</h3>
 128 <div class="variablelist"><table border="0">
 129 <col align="left" valign="top">
 130 <tbody>
 131 <tr>
 132 <td><p><span class="term">name</span></p></td>
 133 <td>subtitle_sink</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">direction</span></p></td>
 137 <td>sink</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">presence</span></p></td>
 141 <td>always</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">details</span></p></td>
 145 <td>ANY</td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 <div class="variablelist"><table border="0">
 150 <col align="left" valign="top">
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term">name</span></p></td>
 154 <td>video_sink</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term">direction</span></p></td>
 158 <td>sink</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term">presence</span></p></td>
 162 <td>always</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term">details</span></p></td>
 166 <td>ANY</td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 <div class="variablelist"><table border="0">
 171 <col align="left" valign="top">
 172 <tbody>
 173 <tr>
 174 <td><p><span class="term">name</span></p></td>
 175 <td>src</td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term">direction</span></p></td>
 179 <td>source</td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term">presence</span></p></td>
 183 <td>always</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term">details</span></p></td>
 187 <td>ANY</td>
 188 </tr>
 189 </tbody>
 190 </table></div>
 191 </div>
 192 </div>
 193 <p>
 194 </p>
 195 </div>
 196 <div class="refsect1">
 197 <a name="gst-plugins-base-plugins-subtitleoverlay.details"></a><h2>Details</h2>
 198 <div class="refsect2">
 199 <a name="GstSubtitleOverlay-struct"></a><h3>struct GstSubtitleOverlay</h3>
 200 <pre class="programlisting">struct GstSubtitleOverlay;</pre>
 201 <p>
 202 </p>
 203 </div>
 204 </div>
 205 <div class="refsect1">
 206 <a name="gst-plugins-base-plugins-subtitleoverlay.property-details"></a><h2>Property Details</h2>
 207 <div class="refsect2">
 208 <a name="GstSubtitleOverlay--font-desc"></a><h3>The <code class="literal">"font-desc"</code> property</h3>
 209 <pre class="programlisting">  "font-desc"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 210 <p>Pango font description of font to be used for subtitle rendering.</p>
 211 <p>Default value: NULL</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="GstSubtitleOverlay--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
 216 <pre class="programlisting">  "silent"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 217 <p>Whether to show subtitles.</p>
 218 <p>Default value: FALSE</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstSubtitleOverlay--subtitle-encoding"></a><h3>The <code class="literal">"subtitle-encoding"</code> property</h3>
 223 <pre class="programlisting">  "subtitle-encoding"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 224 <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>
 225 <p>Default value: NULL</p>
 226 </div>
 227 </div>
 228 </div>
 229 <div class="footer">
 230 <hr>
 231           Generated by GTK-Doc V1.18</div>
 232 </body>
 233 </html>