• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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: GStreamer Good 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 Good Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9<link rel="prev" href="gst-plugins-good-plugins-cpureport.html" title="cpureport">
10<link rel="next" href="gst-plugins-good-plugins-dcaparse.html" title="dcaparse">
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">|</span18                  <a href="#gst-plugins-good-plugins-cutter.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-good-plugins-cutter.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-good-plugins-cutter.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-good-plugins-cpureport.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-good-plugins-dcaparse.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-good-plugins-cutter"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-cutter.top_of_page"></a>cutter</span></h2>
32<p>cutter</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-good-plugins-cutter.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--leaky" title="The “leaky” property">leaky</a></td>
48<td class="property_flags">Read / Write</td>
49</tr>
50<tr>
51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--pre-length" title="The “pre-length” property">pre-length</a></td>
53<td class="property_flags">Read / Write</td>
54</tr>
55<tr>
56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
57<td class="property_name"><a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--run-length" title="The “run-length” property">run-length</a></td>
58<td class="property_flags">Read / Write</td>
59</tr>
60<tr>
61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
62<td class="property_name"><a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--threshold" title="The “threshold” property">threshold</a></td>
63<td class="property_flags">Read / Write</td>
64</tr>
65<tr>
66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
67<td class="property_name"><a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter--threshold-dB" title="The “threshold-dB” property">threshold-dB</a></td>
68<td class="property_flags">Read / Write</td>
69</tr>
70</tbody>
71</table></div>
72</div>
73<a name="GstCutter"></a><div class="refsect1">
74<a name="gst-plugins-good-plugins-cutter.other"></a><h2>Types and Values</h2>
75<div class="informaltable"><table class="informaltable" width="100%" border="0">
76<colgroup>
77<col width="150px" class="name">
78<col class="description">
79</colgroup>
80<tbody><tr>
81<td class="datatype_keyword">struct</td>
82<td class="function_name"><a class="link" href="gst-plugins-good-plugins-cutter.html#GstCutter-struct" title="struct GstCutter">GstCutter</a></td>
83</tr></tbody>
84</table></div>
85</div>
86<div class="refsect1">
87<a name="gst-plugins-good-plugins-cutter.object-hierarchy"></a><h2>Object Hierarchy</h2>
88<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
89    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
90        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
91            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
92                <span class="lineart">╰──</span> GstCutter
93</pre>
94</div>
95<div class="refsect1">
96<a name="gst-plugins-good-plugins-cutter.description"></a><h2>Description</h2>
97<p>Analyses the audio signal for periods of silence. The start and end of
98silence is signalled by bus messages named</p>
99<code class="classname">"cutter"</code>.
100<p>The message's structure contains two fields:</p>
101<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
102<li class="listitem"><p>
103  <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
104  <code class="classname">"timestamp"</code>:
105  the timestamp of the buffer that triggered the message.
106  </p></li>
107<li class="listitem"><p>
108  gboolean
109  <code class="classname">"above"</code>:
110  <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for begin of silence and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> for end of silence.
111  </p></li>
112</ul></div>
113<div class="refsect2">
114<a name="id-1.2.41.7.6"></a><h3>Example launch line</h3>
115<div class="informalexample">
116  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
117    <tbody>
118      <tr>
119        <td class="listing_lines" align="right"><pre>1</pre></td>
120        <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> <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>
121      </tr>
122    </tbody>
123  </table>
124</div>
125 Show cut messages.
126</div>
127<div class="refsynopsisdiv">
128<h2>Synopsis</h2>
129<div class="refsect2">
130<a name="id-1.2.41.7.7.1"></a><h3>Element Information</h3>
131<div class="variablelist"><table border="0" class="variablelist">
132<colgroup>
133<col align="left" valign="top">
134<col>
135</colgroup>
136<tbody>
137<tr>
138<td><p><span class="term">plugin</span></p></td>
139<td>
140            <a class="link" href="gst-plugins-good-plugins-plugin-cutter.html#plugin-cutter">cutter</a>
141          </td>
142</tr>
143<tr>
144<td><p><span class="term">author</span></p></td>
145<td>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</td>
146</tr>
147<tr>
148<td><p><span class="term">class</span></p></td>
149<td>Filter/Editor/Audio</td>
150</tr>
151</tbody>
152</table></div>
153</div>
154<hr>
155<div class="refsect2">
156<a name="id-1.2.41.7.7.2"></a><h3>Element Pads</h3>
157<div class="variablelist"><table border="0" class="variablelist">
158<colgroup>
159<col align="left" valign="top">
160<col>
161</colgroup>
162<tbody>
163<tr>
164<td><p><span class="term">name</span></p></td>
165<td>sink</td>
166</tr>
167<tr>
168<td><p><span class="term">direction</span></p></td>
169<td>sink</td>
170</tr>
171<tr>
172<td><p><span class="term">presence</span></p></td>
173<td>always</td>
174</tr>
175<tr>
176<td><p><span class="term">details</span></p></td>
177<td>audio/x-raw, format=(string){ S8, S16LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td>
178</tr>
179</tbody>
180</table></div>
181<div class="variablelist"><table border="0" class="variablelist">
182<colgroup>
183<col align="left" valign="top">
184<col>
185</colgroup>
186<tbody>
187<tr>
188<td><p><span class="term">name</span></p></td>
189<td>src</td>
190</tr>
191<tr>
192<td><p><span class="term">direction</span></p></td>
193<td>source</td>
194</tr>
195<tr>
196<td><p><span class="term">presence</span></p></td>
197<td>always</td>
198</tr>
199<tr>
200<td><p><span class="term">details</span></p></td>
201<td>audio/x-raw, format=(string){ S8, S16LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td>
202</tr>
203</tbody>
204</table></div>
205</div>
206</div>
207</div>
208<div class="refsect1">
209<a name="gst-plugins-good-plugins-cutter.functions_details"></a><h2>Functions</h2>
210<p></p>
211</div>
212<div class="refsect1">
213<a name="gst-plugins-good-plugins-cutter.other_details"></a><h2>Types and Values</h2>
214<div class="refsect2">
215<a name="GstCutter-struct"></a><h3>struct GstCutter</h3>
216<pre class="programlisting">struct GstCutter;</pre>
217</div>
218</div>
219<div class="refsect1">
220<a name="gst-plugins-good-plugins-cutter.property-details"></a><h2>Property Details</h2>
221<div class="refsect2">
222<a name="GstCutter--leaky"></a><h3>The <code class="literal">“leaky”</code> property</h3>
223<pre class="programlisting">  “leaky”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
224<p>do we leak buffers when below threshold ?.</p>
225<p>Flags: Read / Write</p>
226<p>Default value: FALSE</p>
227</div>
228<hr>
229<div class="refsect2">
230<a name="GstCutter--pre-length"></a><h3>The <code class="literal">“pre-length”</code> property</h3>
231<pre class="programlisting">  “pre-length”               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
232<p>Length of pre-recording buffer (in nanoseconds).</p>
233<p>Flags: Read / Write</p>
234<p>Default value: 0</p>
235</div>
236<hr>
237<div class="refsect2">
238<a name="GstCutter--run-length"></a><h3>The <code class="literal">“run-length”</code> property</h3>
239<pre class="programlisting">  “run-length”               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
240<p>Length of drop below threshold before cut_stop (in nanoseconds).</p>
241<p>Flags: Read / Write</p>
242<p>Default value: 0</p>
243</div>
244<hr>
245<div class="refsect2">
246<a name="GstCutter--threshold"></a><h3>The <code class="literal">“threshold”</code> property</h3>
247<pre class="programlisting">  “threshold”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
248<p>Volume threshold before trigger.</p>
249<p>Flags: Read / Write</p>
250<p>Default value: 0</p>
251</div>
252<hr>
253<div class="refsect2">
254<a name="GstCutter--threshold-dB"></a><h3>The <code class="literal">“threshold-dB”</code> property</h3>
255<pre class="programlisting">  “threshold-dB”             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
256<p>Volume threshold before trigger (in dB).</p>
257<p>Flags: Read / Write</p>
258<p>Default value: 0</p>
259</div>
260</div>
261</div>
262<div class="footer">
263<hr>Generated by GTK-Doc V1.28</div>
264</body>
265</html>