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>kateenc: 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-katedec.html" title="katedec"> 10<link rel="next" href="gst-plugins-bad-plugins-kateparse.html" title="kateparse"> 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-kateenc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-kateenc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-kateenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-kateenc.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-katedec.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-kateparse.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-kateenc"></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-kateenc.top_of_page"></a>kateenc</span></h2> 33<p>kateenc</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-bad-plugins-kateenc.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-bad-plugins-kateenc.html#GstKateEnc--category" title="The “category” property">category</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#gfloat"><span class="type">gfloat</span></a></td> 54<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--default-spu-duration" title="The “default-spu-duration” property">default-spu-duration</a></td> 55<td class="property_flags">Read / Write</td> 56</tr> 57<tr> 58<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 59<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--granule-rate-denominator" title="The “granule-rate-denominator” property">granule-rate-denominator</a></td> 60<td class="property_flags">Read / Write</td> 61</tr> 62<tr> 63<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 64<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--granule-rate-numerator" title="The “granule-rate-numerator” property">granule-rate-numerator</a></td> 65<td class="property_flags">Read / Write</td> 66</tr> 67<tr> 68<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 69<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--granule-shift" title="The “granule-shift” property">granule-shift</a></td> 70<td class="property_flags">Read / Write</td> 71</tr> 72<tr> 73<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 74<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--keepalive-min-time" title="The “keepalive-min-time” property">keepalive-min-time</a></td> 75<td class="property_flags">Read / Write</td> 76</tr> 77<tr> 78<td class="property_type"> 79<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 80<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--language" title="The “language” property">language</a></td> 81<td class="property_flags">Read / Write</td> 82</tr> 83<tr> 84<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 85<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--original-canvas-height" title="The “original-canvas-height” property">original-canvas-height</a></td> 86<td class="property_flags">Read / Write</td> 87</tr> 88<tr> 89<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 90<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--original-canvas-width" title="The “original-canvas-width” property">original-canvas-width</a></td> 91<td class="property_flags">Read / Write</td> 92</tr> 93</tbody> 94</table></div> 95</div> 96<a name="GstKateEnc"></a><div class="refsect1"> 97<a name="gst-plugins-bad-plugins-kateenc.other"></a><h2>Types and Values</h2> 98<div class="informaltable"><table class="informaltable" width="100%" border="0"> 99<colgroup> 100<col width="150px" class="name"> 101<col class="description"> 102</colgroup> 103<tbody><tr> 104<td class="datatype_keyword">struct</td> 105<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc-struct" title="struct GstKateEnc">GstKateEnc</a></td> 106</tr></tbody> 107</table></div> 108</div> 109<div class="refsect1"> 110<a name="gst-plugins-bad-plugins-kateenc.object-hierarchy"></a><h2>Object Hierarchy</h2> 111<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 112 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 113 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 114 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 115 <span class="lineart">╰──</span> GstKateEnc 116</pre> 117</div> 118<div class="refsect1"> 119<a name="gst-plugins-bad-plugins-kateenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 120<p> 121GstKateEnc implements 122 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstTagSetter.html#GstTagSetter-struct">GstTagSetter</a>.</p> 123</div> 124<div class="refsect1"> 125<a name="gst-plugins-bad-plugins-kateenc.description"></a><h2>Description</h2> 126<p>This element encodes Kate streams</p> 127<a class="ulink" href="http://libkate.googlecode.com/" target="_top">Kate</a> is a free codec 128<p>for text based data, such as subtitles. Any number of kate streams can be 129embedded in an Ogg stream.</p> 130<p>libkate (see above url) is needed to build this plugin.</p> 131<div class="refsect3"> 132<a name="id-1.2.130.8.6"></a><h4>Example pipeline</h4> 133<p>This encodes a DVD SPU track to a Kate stream:</p> 134<div class="informalexample"> 135 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 136 <tbody> 137 <tr> 138 <td class="listing_lines" align="right"><pre>1</pre></td> 139 <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> dvdreadsrc <span class="gtkdoc opt">!</span> dvddemux <span class="gtkdoc opt">!</span> dvdsubparse <span class="gtkdoc opt">!</span> kateenc category<span class="gtkdoc opt">=</span>spu<span class="gtkdoc opt">-</span>subtitles <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>ogg</pre></td> 140 </tr> 141 </tbody> 142 </table> 143</div> 144 145<p></p> 146</div> 147<div class="refsynopsisdiv"> 148<h2>Synopsis</h2> 149<div class="refsect2"> 150<a name="id-1.2.130.8.7.1"></a><h3>Element Information</h3> 151<div class="variablelist"><table border="0" class="variablelist"> 152<colgroup> 153<col align="left" valign="top"> 154<col> 155</colgroup> 156<tbody> 157<tr> 158<td><p><span class="term">plugin</span></p></td> 159<td> 160 <a class="link" href="gst-plugins-bad-plugins-plugin-kate.html#plugin-kate">kate</a> 161 </td> 162</tr> 163<tr> 164<td><p><span class="term">author</span></p></td> 165<td>Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com></td> 166</tr> 167<tr> 168<td><p><span class="term">class</span></p></td> 169<td>Codec/Encoder/Subtitle</td> 170</tr> 171</tbody> 172</table></div> 173</div> 174<hr> 175<div class="refsect2"> 176<a name="id-1.2.130.8.7.2"></a><h3>Element Pads</h3> 177<div class="variablelist"><table border="0" class="variablelist"> 178<colgroup> 179<col align="left" valign="top"> 180<col> 181</colgroup> 182<tbody> 183<tr> 184<td><p><span class="term">name</span></p></td> 185<td>sink</td> 186</tr> 187<tr> 188<td><p><span class="term">direction</span></p></td> 189<td>sink</td> 190</tr> 191<tr> 192<td><p><span class="term">presence</span></p></td> 193<td>always</td> 194</tr> 195<tr> 196<td><p><span class="term">details</span></p></td> 197<td>text/x-raw, format=(string){ pango-markup, utf8 }</td> 198</tr> 199<tr> 200<td><p><span class="term"></span></p></td> 201<td> subpicture/x-dvd</td> 202</tr> 203</tbody> 204</table></div> 205<div class="variablelist"><table border="0" class="variablelist"> 206<colgroup> 207<col align="left" valign="top"> 208<col> 209</colgroup> 210<tbody> 211<tr> 212<td><p><span class="term">name</span></p></td> 213<td>src</td> 214</tr> 215<tr> 216<td><p><span class="term">direction</span></p></td> 217<td>source</td> 218</tr> 219<tr> 220<td><p><span class="term">presence</span></p></td> 221<td>always</td> 222</tr> 223<tr> 224<td><p><span class="term">details</span></p></td> 225<td>subtitle/x-kate</td> 226</tr> 227<tr> 228<td><p><span class="term"></span></p></td> 229<td> application/x-kate</td> 230</tr> 231</tbody> 232</table></div> 233</div> 234</div> 235</div> 236<div class="refsect1"> 237<a name="gst-plugins-bad-plugins-kateenc.functions_details"></a><h2>Functions</h2> 238<p></p> 239</div> 240<div class="refsect1"> 241<a name="gst-plugins-bad-plugins-kateenc.other_details"></a><h2>Types and Values</h2> 242<div class="refsect2"> 243<a name="GstKateEnc-struct"></a><h3>struct GstKateEnc</h3> 244<pre class="programlisting">struct GstKateEnc;</pre> 245</div> 246</div> 247<div class="refsect1"> 248<a name="gst-plugins-bad-plugins-kateenc.property-details"></a><h2>Property Details</h2> 249<div class="refsect2"> 250<a name="GstKateEnc--category"></a><h3>The <code class="literal">“category”</code> property</h3> 251<pre class="programlisting"> “category” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 252<p>The category of the stream.</p> 253<p>Flags: Read / Write</p> 254<p>Default value: ""</p> 255</div> 256<hr> 257<div class="refsect2"> 258<a name="GstKateEnc--default-spu-duration"></a><h3>The <code class="literal">“default-spu-duration”</code> property</h3> 259<pre class="programlisting"> “default-spu-duration” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 260<p>The assumed max duration (in seconds) of SPUs with no duration specified.</p> 261<p>Flags: Read / Write</p> 262<p>Allowed values: >= 0</p> 263<p>Default value: 1.5</p> 264</div> 265<hr> 266<div class="refsect2"> 267<a name="GstKateEnc--granule-rate-denominator"></a><h3>The <code class="literal">“granule-rate-denominator”</code> property</h3> 268<pre class="programlisting"> “granule-rate-denominator” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 269<p>The denominator of the granule rate.</p> 270<p>Flags: Read / Write</p> 271<p>Allowed values: >= 1</p> 272<p>Default value: 1000</p> 273</div> 274<hr> 275<div class="refsect2"> 276<a name="GstKateEnc--granule-rate-numerator"></a><h3>The <code class="literal">“granule-rate-numerator”</code> property</h3> 277<pre class="programlisting"> “granule-rate-numerator” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 278<p>The numerator of the granule rate.</p> 279<p>Flags: Read / Write</p> 280<p>Allowed values: >= 1</p> 281<p>Default value: 1</p> 282</div> 283<hr> 284<div class="refsect2"> 285<a name="GstKateEnc--granule-shift"></a><h3>The <code class="literal">“granule-shift”</code> property</h3> 286<pre class="programlisting"> “granule-shift” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 287<p>The granule shift.</p> 288<p>Flags: Read / Write</p> 289<p>Allowed values: [0,64]</p> 290<p>Default value: 32</p> 291</div> 292<hr> 293<div class="refsect2"> 294<a name="GstKateEnc--keepalive-min-time"></a><h3>The <code class="literal">“keepalive-min-time”</code> property</h3> 295<pre class="programlisting"> “keepalive-min-time” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 296<p>Minimum time to emit keepalive packets (0 disables keepalive packets).</p> 297<p>Flags: Read / Write</p> 298<p>Allowed values: >= 0</p> 299<p>Default value: 2.5</p> 300</div> 301<hr> 302<div class="refsect2"> 303<a name="GstKateEnc--language"></a><h3>The <code class="literal">“language”</code> property</h3> 304<pre class="programlisting"> “language” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 305<p>The language of the stream (e.g. "fr" or "fr_FR" for French).</p> 306<p>Flags: Read / Write</p> 307<p>Default value: ""</p> 308</div> 309<hr> 310<div class="refsect2"> 311<a name="GstKateEnc--original-canvas-height"></a><h3>The <code class="literal">“original-canvas-height”</code> property</h3> 312<pre class="programlisting"> “original-canvas-height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 313<p>The height of the canvas this stream was authored for (0 is unspecified).</p> 314<p>Flags: Read / Write</p> 315<p>Allowed values: >= 0</p> 316<p>Default value: 0</p> 317</div> 318<hr> 319<div class="refsect2"> 320<a name="GstKateEnc--original-canvas-width"></a><h3>The <code class="literal">“original-canvas-width”</code> property</h3> 321<pre class="programlisting"> “original-canvas-width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 322<p>The width of the canvas this stream was authored for (0 is unspecified).</p> 323<p>Flags: Read / Write</p> 324<p>Allowed values: >= 0</p> 325<p>Default value: 0</p> 326</div> 327</div> 328<div class="refsect1"> 329<a name="gst-plugins-bad-plugins-kateenc.see-also"></a><h2>See Also</h2> 330<p>oggmux</p> 331</div> 332</div> 333<div class="footer"> 334<hr>Generated by GTK-Doc V1.28</div> 335</body> 336</html>
