docs/plugins/html/gst-plugins-bad-plugins-kateenc.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>kateenc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
   9 <link rel="prev" href="gst-plugins-bad-plugins-kaleidoscope.html" title="kaleidoscope">
  10 <link rel="next" href="gst-plugins-bad-plugins-katedec.html" title="katedec">
  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-bad-plugins-kaleidoscope.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 Bad Plugins 0.10 Plugins Reference Manual</th>
  21 <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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-bad-plugins-kateenc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-bad-plugins-kateenc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-bad-plugins-kateenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-bad-plugins-kateenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-bad-plugins-kateenc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-bad-plugins-kateenc"></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-bad-plugins-kateenc.top_of_page"></a>kateenc</span></h2>
  40 <p>kateenc — Encodes Kate streams from text or subpictures</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-bad-plugins-kateenc.synopsis"></a><h2>Synopsis</h2>
  46 <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>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-bad-plugins-kateenc.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                +----GstKateEnc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-bad-plugins-kateenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  60 <p>
  61 GstKateEnc implements
  62  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a>.</p>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-bad-plugins-kateenc.properties"></a><h2>Properties</h2>
  66 <pre class="synopsis">
  67   "<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
  68   "<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
  69   "<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
  70   "<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
  71   "<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
  72   "<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
  73   "<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
  74   "<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
  75   "<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
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="gst-plugins-bad-plugins-kateenc.description"></a><h2>Description</h2>
  80 <div class="refsynopsisdiv">
  81 <h2>Synopsis</h2>
  82 <div class="refsect2">
  83 <a name="idp14204752"></a><h3>Element Information</h3>
  84 <div class="variablelist"><table border="0">
  85 <col align="left" valign="top">
  86 <tbody>
  87 <tr>
  88 <td><p><span class="term">plugin</span></p></td>
  89 <td>
  90             <a class="link" href="gst-plugins-bad-plugins-plugin-kate.html#plugin-kate">kate</a>
  91           </td>
  92 </tr>
  93 <tr>
  94 <td><p><span class="term">author</span></p></td>
  95 <td>Vincent Penquerc'h &lt;ogg.k.ogg.k@googlemail.com&gt;</td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term">class</span></p></td>
  99 <td>Codec/Encoder/Subtitle</td>
 100 </tr>
 101 </tbody>
 102 </table></div>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="idp14212160"></a><h3>Element Pads</h3>
 107 <div class="variablelist"><table border="0">
 108 <col align="left" valign="top">
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term">name</span></p></td>
 112 <td>sink</td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">direction</span></p></td>
 116 <td>sink</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">presence</span></p></td>
 120 <td>always</td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term">details</span></p></td>
 124 <td>text/plain</td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term"></span></p></td>
 128 <td> text/x-pango-markup</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term"></span></p></td>
 132 <td> video/x-dvd-subpicture</td>
 133 </tr>
 134 </tbody>
 135 </table></div>
 136 <div class="variablelist"><table border="0">
 137 <col align="left" valign="top">
 138 <tbody>
 139 <tr>
 140 <td><p><span class="term">name</span></p></td>
 141 <td>src</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">direction</span></p></td>
 145 <td>source</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term">presence</span></p></td>
 149 <td>always</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term">details</span></p></td>
 153 <td>subtitle/x-kate</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"></span></p></td>
 157 <td> application/x-kate</td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 </div>
 162 </div>
 163 <p>
 164 </p>
 165 </div>
 166 <div class="refsect1">
 167 <a name="gst-plugins-bad-plugins-kateenc.details"></a><h2>Details</h2>
 168 <div class="refsect2">
 169 <a name="GstKateEnc-struct"></a><h3>struct GstKateEnc</h3>
 170 <pre class="programlisting">struct GstKateEnc;</pre>
 171 <p>
 172 </p>
 173 </div>
 174 </div>
 175 <div class="refsect1">
 176 <a name="gst-plugins-bad-plugins-kateenc.property-details"></a><h2>Property Details</h2>
 177 <div class="refsect2">
 178 <a name="GstKateEnc--category"></a><h3>The <code class="literal">"category"</code> property</h3>
 179 <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>
 180 <p>The category of the stream.</p>
 181 <p>Default value: ""</p>
 182 </div>
 183 <hr>
 184 <div class="refsect2">
 185 <a name="GstKateEnc--default-spu-duration"></a><h3>The <code class="literal">"default-spu-duration"</code> property</h3>
 186 <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>
 187 <p>The assumed max duration (in seconds) of SPUs with no duration specified.</p>
 188 <p>Allowed values: &gt;= 0</p>
 189 <p>Default value: 1.5</p>
 190 </div>
 191 <hr>
 192 <div class="refsect2">
 193 <a name="GstKateEnc--granule-rate-denominator"></a><h3>The <code class="literal">"granule-rate-denominator"</code> property</h3>
 194 <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>
 195 <p>The denominator of the granule rate.</p>
 196 <p>Allowed values: &gt;= 1</p>
 197 <p>Default value: 1000</p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="GstKateEnc--granule-rate-numerator"></a><h3>The <code class="literal">"granule-rate-numerator"</code> property</h3>
 202 <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>
 203 <p>The numerator of the granule rate.</p>
 204 <p>Allowed values: &gt;= 1</p>
 205 <p>Default value: 1</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="GstKateEnc--granule-shift"></a><h3>The <code class="literal">"granule-shift"</code> property</h3>
 210 <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>
 211 <p>The granule shift.</p>
 212 <p>Allowed values: [0,64]</p>
 213 <p>Default value: 32</p>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="GstKateEnc--keepalive-min-time"></a><h3>The <code class="literal">"keepalive-min-time"</code> property</h3>
 218 <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>
 219 <p>Minimum time to emit keepalive packets (0 disables keepalive packets).</p>
 220 <p>Allowed values: &gt;= 0</p>
 221 <p>Default value: 2.5</p>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="GstKateEnc--language"></a><h3>The <code class="literal">"language"</code> property</h3>
 226 <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>
 227 <p>The language of the stream (e.g. "fr" or "fr_FR" for French).</p>
 228 <p>Default value: ""</p>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="GstKateEnc--original-canvas-height"></a><h3>The <code class="literal">"original-canvas-height"</code> property</h3>
 233 <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>
 234 <p>The height of the canvas this stream was authored for (0 is unspecified).</p>
 235 <p>Allowed values: &gt;= 0</p>
 236 <p>Default value: 0</p>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="GstKateEnc--original-canvas-width"></a><h3>The <code class="literal">"original-canvas-width"</code> property</h3>
 241 <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>
 242 <p>The width of the canvas this stream was authored for (0 is unspecified).</p>
 243 <p>Allowed values: &gt;= 0</p>
 244 <p>Default value: 0</p>
 245 </div>
 246 </div>
 247 </div>
 248 <div class="footer">
 249 <hr>
 250           Generated by GTK-Doc V1.18</div>
 251 </body>
 252 </html>