docs/plugins/html/gst-plugins-good-plugins-cutter.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>cutter</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   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-cmmlenc.html" title="cmmlenc">
  10 <link rel="next" href="gst-plugins-good-plugins-dcaparse.html" title="dcaparse">
  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-good-plugins-cmmlenc.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-dcaparse.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-cutter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-cutter.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-cutter.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-cutter.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-cutter"></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-cutter.top_of_page"></a>cutter</span></h2>
  38 <p>cutter — Audio Cutter to split audio into non-silent bits</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-cutter.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstCutter"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter-struct" title="struct GstCutter">GstCutter</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-cutter.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                +----GstCutter
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gst-plugins-good-plugins-cutter.properties"></a><h2>Properties</h2>
  58 <pre class="synopsis">
  59   "<a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--leaky" title='The "leaky" property'>leaky</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  60   "<a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--pre-length" title='The "pre-length" property'>pre-length</a>"               <span class="type">guint64</span>               : Read / Write
  61   "<a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--run-length" title='The "run-length" property'>run-length</a>"               <span class="type">guint64</span>               : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--threshold" title='The "threshold" property'>threshold</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--threshold-dB" title='The "threshold-dB" property'>threshold-dB</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-good-plugins-cutter.description"></a><h2>Description</h2>
  68 <p>
  69 Analyses the audio signal for periods of silence. The start and end of
  70 silence is signalled by bus messages named
  71 <code class="classname">"cutter"</code>.
  72 The message's structure contains two fields:
  73 </p>
  74 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
  75 <li class="listitem"><p>
  76   <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
  77   <code class="classname">"timestamp"</code>:
  78   the timestamp of the buffer that triggered the message.
  79   </p></li>
  80 <li class="listitem"><p>
  81   gboolean
  82   <code class="classname">"above"</code>:
  83   <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for begin of silence and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> for end of silence.
  84   </p></li>
  85 </ul></div>
  86 <p>
  87 </p>
  88 <p>
  89 </p>
  90 <div class="refsect2">
  91 <a name="idp7347408"></a><h3>Example launch line</h3>
  92 <div class="informalexample">
  93   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  94     <tbody>
  95       <tr>
  96         <td class="listing_lines" align="right"><pre>1</pre></td>
  97         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>m filesrc location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> cutter <span class="gtkdoc opt">!</span> autoaudiosink</pre></td>
  98       </tr>
  99     </tbody>
 100   </table>
 101 </div>
 102  Show cut messages.
 103 </div>
 104 <p>
 105 </p>
 106 <div class="refsynopsisdiv">
 107 <h2>Synopsis</h2>
 108 <div class="refsect2">
 109 <a name="idp6678288"></a><h3>Element Information</h3>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term">plugin</span></p></td>
 115 <td>
 116             <a class="link" href="gst-plugins-good-plugins-plugin-cutter.html#plugin-cutter">cutter</a>
 117           </td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">author</span></p></td>
 121 <td>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">class</span></p></td>
 125 <td>Filter/Editor/Audio</td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="idp13375152"></a><h3>Element Pads</h3>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term">name</span></p></td>
 138 <td>sink</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">direction</span></p></td>
 142 <td>sink</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">presence</span></p></td>
 146 <td>always</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term">details</span></p></td>
 150 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 8, 16 }, depth=(int){ 8, 16 }, signed=(boolean)true</td>
 151 </tr>
 152 </tbody>
 153 </table></div>
 154 <div class="variablelist"><table border="0">
 155 <col align="left" valign="top">
 156 <tbody>
 157 <tr>
 158 <td><p><span class="term">name</span></p></td>
 159 <td>src</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term">direction</span></p></td>
 163 <td>source</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term">presence</span></p></td>
 167 <td>always</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term">details</span></p></td>
 171 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 8, 16 }, depth=(int){ 8, 16 }, signed=(boolean)true</td>
 172 </tr>
 173 </tbody>
 174 </table></div>
 175 </div>
 176 </div>
 177 <p>
 178 </p>
 179 </div>
 180 <div class="refsect1">
 181 <a name="gst-plugins-good-plugins-cutter.details"></a><h2>Details</h2>
 182 <div class="refsect2">
 183 <a name="GstCutter-struct"></a><h3>struct GstCutter</h3>
 184 <pre class="programlisting">struct GstCutter;</pre>
 185 <p>
 186 </p>
 187 </div>
 188 </div>
 189 <div class="refsect1">
 190 <a name="gst-plugins-good-plugins-cutter.property-details"></a><h2>Property Details</h2>
 191 <div class="refsect2">
 192 <a name="GstCutter--leaky"></a><h3>The <code class="literal">"leaky"</code> property</h3>
 193 <pre class="programlisting">  "leaky"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 194 <p>do we leak buffers when below threshold ?.</p>
 195 <p>Default value: FALSE</p>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="GstCutter--pre-length"></a><h3>The <code class="literal">"pre-length"</code> property</h3>
 200 <pre class="programlisting">  "pre-length"               <span class="type">guint64</span>               : Read / Write</pre>
 201 <p>Length of pre-recording buffer (in nanoseconds).</p>
 202 <p>Default value: 0</p>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="GstCutter--run-length"></a><h3>The <code class="literal">"run-length"</code> property</h3>
 207 <pre class="programlisting">  "run-length"               <span class="type">guint64</span>               : Read / Write</pre>
 208 <p>Length of drop below threshold before cut_stop (in nanoseconds).</p>
 209 <p>Default value: 0</p>
 210 </div>
 211 <hr>
 212 <div class="refsect2">
 213 <a name="GstCutter--threshold"></a><h3>The <code class="literal">"threshold"</code> property</h3>
 214 <pre class="programlisting">  "threshold"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 215 <p>Volume threshold before trigger.</p>
 216 <p>Default value: 0</p>
 217 </div>
 218 <hr>
 219 <div class="refsect2">
 220 <a name="GstCutter--threshold-dB"></a><h3>The <code class="literal">"threshold-dB"</code> property</h3>
 221 <pre class="programlisting">  "threshold-dB"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 222 <p>Volume threshold before trigger (in dB).</p>
 223 <p>Default value: 0</p>
 224 </div>
 225 </div>
 226 </div>
 227 <div class="footer">
 228 <hr>
 229           Generated by GTK-Doc V1.18</div>
 230 </body>
 231 </html>