docs/plugins/html/gst-plugins-good-plugins-cmmlenc.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>cmmlenc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-cmmldec.html" title="cmmldec">
  10 <link rel="next" href="gst-plugins-good-plugins-cutter.html" title="cutter">
  11 <meta name="generator" content="GTK-Doc V1.17 (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-good-plugins-cmmldec.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 Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-cutter.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-good-plugins-cmmlenc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-cmmlenc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-cmmlenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-cmmlenc.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-cmmlenc"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-cmmlenc.top_of_page"></a>cmmlenc</span></h2>
  38 <p>cmmlenc — Encodes CMML streams</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-cmmlenc.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstCmmlEnc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-cmmlenc.html#GstCmmlEnc-struct" title="struct GstCmmlEnc">GstCmmlEnc</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-cmmlenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----GstCmmlEnc
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gst-plugins-good-plugins-cmmlenc.properties"></a><h2>Properties</h2>
  58 <pre class="synopsis">
  59   "<a class="link" href="gst-plugins-good-plugins-cmmlenc.html#GstCmmlEnc--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#gint64"><span class="type">gint64</span></a>                : Read / Write / Construct
  60   "<a class="link" href="gst-plugins-good-plugins-cmmlenc.html#GstCmmlEnc--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#gint64"><span class="type">gint64</span></a>                : Read / Write / Construct
  61   "<a class="link" href="gst-plugins-good-plugins-cmmlenc.html#GstCmmlEnc--granule-shift" title='The "granule-shift" property'>granule-shift</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a>                : Read / Write / Construct
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-good-plugins-cmmlenc.description"></a><h2>Description</h2>
  66 <p>
  67 Cmmlenc encodes a CMML document into a CMML stream.  <a class="ulink" href="http://www.annodex.net/TR/draft-pfeiffer-cmml-02.html" target="_top">CMML</a> is
  68 an XML markup language for time-continuous data maintained by the <a class="ulink" href="http:/www.annodex.org/" target="_top">Annodex Foundation</a>.
  69 </p>
  70 <p>
  71 </p>
  72 <div class="refsect2">
  73 <a name="idp5818560"></a><h3>Example pipeline</h3>
  74 <div class="informalexample">
  75   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  76     <tbody>
  77       <tr>
  78         <td class="listing_lines" align="right"><pre>1</pre></td>
  79         <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>annotations<span class="gtkdoc opt">.</span>cmml <span class="gtkdoc opt">!</span> cmmlenc <span class="gtkdoc opt">!</span> oggmux name<span class="gtkdoc opt">=</span>mux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>annotated<span class="gtkdoc opt">.</span>ogg</pre></td>
  80       </tr>
  81     </tbody>
  82   </table>
  83 </div>
  84
  85 </div>
  86 <p>
  87 </p>
  88 <div class="refsynopsisdiv">
  89 <h2>Synopsis</h2>
  90 <div class="refsect2">
  91 <a name="idp10439424"></a><h3>Element Information</h3>
  92 <div class="variablelist"><table border="0">
  93 <col align="left" valign="top">
  94 <tbody>
  95 <tr>
  96 <td><p><span class="term">plugin</span></p></td>
  97 <td>
  98             <a class="link" href="gst-plugins-good-plugins-plugin-annodex.html#plugin-annodex">annodex</a>
  99           </td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term">author</span></p></td>
 103 <td>Alessandro Decina &lt;alessandro@nnva.org&gt;</td>
 104 </tr>
 105 <tr>
 106 <td><p><span class="term">class</span></p></td>
 107 <td>Codec/Encoder</td>
 108 </tr>
 109 </tbody>
 110 </table></div>
 111 </div>
 112 <hr>
 113 <div class="refsect2">
 114 <a name="idp7784976"></a><h3>Element Pads</h3>
 115 <div class="variablelist"><table border="0">
 116 <col align="left" valign="top">
 117 <tbody>
 118 <tr>
 119 <td><p><span class="term">name</span></p></td>
 120 <td>sink</td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term">direction</span></p></td>
 124 <td>sink</td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term">presence</span></p></td>
 128 <td>always</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term">details</span></p></td>
 132 <td>text/x-cmml, encoded=(boolean)false</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>text/x-cmml, encoded=(boolean)true</td>
 154 </tr>
 155 </tbody>
 156 </table></div>
 157 </div>
 158 </div>
 159 <p>
 160 </p>
 161 </div>
 162 <div class="refsect1">
 163 <a name="gst-plugins-good-plugins-cmmlenc.details"></a><h2>Details</h2>
 164 <div class="refsect2">
 165 <a name="GstCmmlEnc-struct"></a><h3>struct GstCmmlEnc</h3>
 166 <pre class="programlisting">struct GstCmmlEnc;</pre>
 167 <p>
 168 </p>
 169 </div>
 170 </div>
 171 <div class="refsect1">
 172 <a name="gst-plugins-good-plugins-cmmlenc.property-details"></a><h2>Property Details</h2>
 173 <div class="refsect2">
 174 <a name="GstCmmlEnc--granule-rate-denominator"></a><h3>The <code class="literal">"granule-rate-denominator"</code> property</h3>
 175 <pre class="programlisting">  "granule-rate-denominator" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write / Construct</pre>
 176 <p>Granulerate denominator.</p>
 177 <p>Allowed values: &gt;= 0</p>
 178 <p>Default value: 1</p>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="GstCmmlEnc--granule-rate-numerator"></a><h3>The <code class="literal">"granule-rate-numerator"</code> property</h3>
 183 <pre class="programlisting">  "granule-rate-numerator"   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read / Write / Construct</pre>
 184 <p>Granulerate numerator.</p>
 185 <p>Allowed values: &gt;= 0</p>
 186 <p>Default value: 1000</p>
 187 </div>
 188 <hr>
 189 <div class="refsect2">
 190 <a name="GstCmmlEnc--granule-shift"></a><h3>The <code class="literal">"granule-shift"</code> property</h3>
 191 <pre class="programlisting">  "granule-shift"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a>                : Read / Write / Construct</pre>
 192 <p>The number of lower bits to use for partitioning a granule position.</p>
 193 <p>Allowed values: &lt;= 64</p>
 194 <p>Default value: 32</p>
 195 </div>
 196 </div>
 197 <div class="refsect1">
 198 <a name="gst-plugins-good-plugins-cmmlenc.see-also"></a><h2>See Also</h2>
 199 cmmldec, oggmux
 200 </div>
 201 </div>
 202 <div class="footer">
 203 <hr>
 204           Generated by GTK-Doc V1.17</div>
 205 </body>
 206 </html>