<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>kateenc</title> <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual"> <link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> <link rel="prev" href="gst-plugins-bad-plugins-kaleidoscope.html" title="kaleidoscope"> <link rel="next" href="gst-plugins-bad-plugins-katedec.html" title="katedec"> <meta name="generator" content="GTK-Doc V1.18 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> <tr valign="middle"> <td><a accesskey="p" href="gst-plugins-bad-plugins-kaleidoscope.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">GStreamer Bad Plugins 0.10 Plugins Reference Manual</th> <td><a accesskey="n" href="gst-plugins-bad-plugins-katedec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#gst-plugins-bad-plugins-kateenc.synopsis" class="shortcut">Top</a> | <a href="#gst-plugins-bad-plugins-kateenc.description" class="shortcut">Description</a> | <a href="#gst-plugins-bad-plugins-kateenc.object-hierarchy" class="shortcut">Object Hierarchy</a> | <a href="#gst-plugins-bad-plugins-kateenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a> | <a href="#gst-plugins-bad-plugins-kateenc.properties" class="shortcut">Properties</a> </td></tr> </table> <div class="refentry"> <a name="gst-plugins-bad-plugins-kateenc"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-kateenc.top_of_page"></a>kateenc</span></h2> <p>kateenc — Encodes Kate streams from text or subpictures</p> </td> <td valign="top" align="right"></td> </tr></table></div> <div class="refsynopsisdiv"> <a name="gst-plugins-bad-plugins-kateenc.synopsis"></a><h2>Synopsis</h2> <a name="GstKateEnc"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc-struct" title="struct GstKateEnc">GstKateEnc</a>; </pre> </div> <div class="refsect1"> <a name="gst-plugins-bad-plugins-kateenc.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a> +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a> +----GstKateEnc </pre> </div> <div class="refsect1"> <a name="gst-plugins-bad-plugins-kateenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2> <p> GstKateEnc implements <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a>.</p> </div> <div class="refsect1"> <a name="gst-plugins-bad-plugins-kateenc.properties"></a><h2>Properties</h2> <pre class="synopsis"> "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--category" title='The "category" property'>category</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--default-spu-duration" title='The "default-spu-duration" property'>default-spu-duration</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--granule-rate-denominator" title='The "granule-rate-denominator" property'>granule-rate-denominator</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--granule-rate-numerator" title='The "granule-rate-numerator" property'>granule-rate-numerator</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--granule-shift" title='The "granule-shift" property'>granule-shift</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--keepalive-min-time" title='The "keepalive-min-time" property'>keepalive-min-time</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--language" title='The "language" property'>language</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--original-canvas-height" title='The "original-canvas-height" property'>original-canvas-height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write "<a class="link" href="gst-plugins-bad-plugins-kateenc.html#GstKateEnc--original-canvas-width" title='The "original-canvas-width" property'>original-canvas-width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write </pre> </div> <div class="refsect1"> <a name="gst-plugins-bad-plugins-kateenc.description"></a><h2>Description</h2> <div class="refsynopsisdiv"> <h2>Synopsis</h2> <div class="refsect2"> <a name="idp14204752"></a><h3>Element Information</h3> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term">plugin</span></p></td> <td> <a class="link" href="gst-plugins-bad-plugins-plugin-kate.html#plugin-kate">kate</a> </td> </tr> <tr> <td><p><span class="term">author</span></p></td> <td>Vincent Penquerc'h <ogg.k.ogg.k@googlemail.com></td> </tr> <tr> <td><p><span class="term">class</span></p></td> <td>Codec/Encoder/Subtitle</td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2"> <a name="idp14212160"></a><h3>Element Pads</h3> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term">name</span></p></td> <td>sink</td> </tr> <tr> <td><p><span class="term">direction</span></p></td> <td>sink</td> </tr> <tr> <td><p><span class="term">presence</span></p></td> <td>always</td> </tr> <tr> <td><p><span class="term">details</span></p></td> <td>text/plain</td> </tr> <tr> <td><p><span class="term"></span></p></td> <td> text/x-pango-markup</td> </tr> <tr> <td><p><span class="term"></span></p></td> <td> video/x-dvd-subpicture</td> </tr> </tbody> </table></div> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term">name</span></p></td> <td>src</td> </tr> <tr> <td><p><span class="term">direction</span></p></td> <td>source</td> </tr> <tr> <td><p><span class="term">presence</span></p></td> <td>always</td> </tr> <tr> <td><p><span class="term">details</span></p></td> <td>subtitle/x-kate</td> </tr> <tr> <td><p><span class="term"></span></p></td> <td> application/x-kate</td> </tr> </tbody> </table></div> </div> </div> <p> </p> </div> <div class="refsect1"> <a name="gst-plugins-bad-plugins-kateenc.details"></a><h2>Details</h2> <div class="refsect2"> <a name="GstKateEnc-struct"></a><h3>struct GstKateEnc</h3> <pre class="programlisting">struct GstKateEnc;</pre> <p> </p> </div> </div> <div class="refsect1"> <a name="gst-plugins-bad-plugins-kateenc.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="GstKateEnc--category"></a><h3>The <code class="literal">"category"</code> property</h3> <pre class="programlisting"> "category" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p>The category of the stream.</p> <p>Default value: ""</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--default-spu-duration"></a><h3>The <code class="literal">"default-spu-duration"</code> property</h3> <pre class="programlisting"> "default-spu-duration" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre> <p>The assumed max duration (in seconds) of SPUs with no duration specified.</p> <p>Allowed values: >= 0</p> <p>Default value: 1.5</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--granule-rate-denominator"></a><h3>The <code class="literal">"granule-rate-denominator"</code> property</h3> <pre class="programlisting"> "granule-rate-denominator" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre> <p>The denominator of the granule rate.</p> <p>Allowed values: >= 1</p> <p>Default value: 1000</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--granule-rate-numerator"></a><h3>The <code class="literal">"granule-rate-numerator"</code> property</h3> <pre class="programlisting"> "granule-rate-numerator" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre> <p>The numerator of the granule rate.</p> <p>Allowed values: >= 1</p> <p>Default value: 1</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--granule-shift"></a><h3>The <code class="literal">"granule-shift"</code> property</h3> <pre class="programlisting"> "granule-shift" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre> <p>The granule shift.</p> <p>Allowed values: [0,64]</p> <p>Default value: 32</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--keepalive-min-time"></a><h3>The <code class="literal">"keepalive-min-time"</code> property</h3> <pre class="programlisting"> "keepalive-min-time" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre> <p>Minimum time to emit keepalive packets (0 disables keepalive packets).</p> <p>Allowed values: >= 0</p> <p>Default value: 2.5</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--language"></a><h3>The <code class="literal">"language"</code> property</h3> <pre class="programlisting"> "language" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p>The language of the stream (e.g. "fr" or "fr_FR" for French).</p> <p>Default value: ""</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--original-canvas-height"></a><h3>The <code class="literal">"original-canvas-height"</code> property</h3> <pre class="programlisting"> "original-canvas-height" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre> <p>The height of the canvas this stream was authored for (0 is unspecified).</p> <p>Allowed values: >= 0</p> <p>Default value: 0</p> </div> <hr> <div class="refsect2"> <a name="GstKateEnc--original-canvas-width"></a><h3>The <code class="literal">"original-canvas-width"</code> property</h3> <pre class="programlisting"> "original-canvas-width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre> <p>The width of the canvas this stream was authored for (0 is unspecified).</p> <p>Allowed values: >= 0</p> <p>Default value: 0</p> </div> </div> </div> <div class="footer"> <hr> Generated by GTK-Doc V1.18</div> </body> </html>