docs/plugins/html/gst-plugins-good-plugins-audiokaraoke.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>audiokaraoke</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-audiopanorama.html" title="audiopanorama">
  10 <link rel="next" href="gst-plugins-good-plugins-auparse.html" title="auparse">
  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-audiopanorama.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-auparse.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-audiokaraoke.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-audiokaraoke.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-audiokaraoke.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-audiokaraoke.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-audiokaraoke"></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-audiokaraoke.top_of_page"></a>audiokaraoke</span></h2>
  38 <p>audiokaraoke — Removes voice from sound</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-audiokaraoke.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstAudioKaraoke"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-audiokaraoke.html#GstAudioKaraoke-struct" title="struct GstAudioKaraoke">GstAudioKaraoke</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-audiokaraoke.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                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter">GstAudioFilter</a>
  55                            +----GstAudioKaraoke
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-audiokaraoke.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<a class="link" href="gst-plugins-good-plugins-audiokaraoke.html#GstAudioKaraoke--filter-band" title='The "filter-band" property'>filter-band</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-audiokaraoke.html#GstAudioKaraoke--filter-width" title='The "filter-width" property'>filter-width</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-audiokaraoke.html#GstAudioKaraoke--level" title='The "level" property'>level</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  64   "<a class="link" href="gst-plugins-good-plugins-audiokaraoke.html#GstAudioKaraoke--mono-level" title='The "mono-level" property'>mono-level</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-good-plugins-audiokaraoke.description"></a><h2>Description</h2>
  69 <p>
  70 Remove the voice from audio by filtering the center channel.
  71 This plugin is useful for karaoke applications.
  72 </p>
  73 <p>
  74 </p>
  75 <div class="refsect2">
  76 <a name="idp7387952"></a><h3>Example launch line</h3>
  77 <div class="informalexample">
  78   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  79     <tbody>
  80       <tr>
  81         <td class="listing_lines" align="right"><pre>1</pre></td>
  82         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>song<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisdec <span class="gtkdoc opt">!</span> audiokaraoke <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td>
  83       </tr>
  84     </tbody>
  85   </table>
  86 </div>
  87
  88 </div>
  89 <p>
  90 </p>
  91 <div class="refsynopsisdiv">
  92 <h2>Synopsis</h2>
  93 <div class="refsect2">
  94 <a name="idp9600096"></a><h3>Element Information</h3>
  95 <div class="variablelist"><table border="0">
  96 <col align="left" valign="top">
  97 <tbody>
  98 <tr>
  99 <td><p><span class="term">plugin</span></p></td>
 100 <td>
 101             <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a>
 102           </td>
 103 </tr>
 104 <tr>
 105 <td><p><span class="term">author</span></p></td>
 106 <td>Wim Taymans &lt;wim.taymans@gmail.com&gt;</td>
 107 </tr>
 108 <tr>
 109 <td><p><span class="term">class</span></p></td>
 110 <td>Filter/Effect/Audio</td>
 111 </tr>
 112 </tbody>
 113 </table></div>
 114 </div>
 115 <hr>
 116 <div class="refsect2">
 117 <a name="idp7756720"></a><h3>Element Pads</h3>
 118 <div class="variablelist"><table border="0">
 119 <col align="left" valign="top">
 120 <tbody>
 121 <tr>
 122 <td><p><span class="term">name</span></p></td>
 123 <td>sink</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term">direction</span></p></td>
 127 <td>sink</td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term">presence</span></p></td>
 131 <td>always</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term">details</span></p></td>
 135 <td>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"></span></p></td>
 139 <td> audio/x-raw-float, width=(int)32, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term">name</span></p></td>
 148 <td>src</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term">direction</span></p></td>
 152 <td>source</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term">presence</span></p></td>
 156 <td>always</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term">details</span></p></td>
 160 <td>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"></span></p></td>
 164 <td> audio/x-raw-float, width=(int)32, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 165 </tr>
 166 </tbody>
 167 </table></div>
 168 </div>
 169 </div>
 170 <p>
 171 </p>
 172 </div>
 173 <div class="refsect1">
 174 <a name="gst-plugins-good-plugins-audiokaraoke.details"></a><h2>Details</h2>
 175 <div class="refsect2">
 176 <a name="GstAudioKaraoke-struct"></a><h3>struct GstAudioKaraoke</h3>
 177 <pre class="programlisting">struct GstAudioKaraoke;</pre>
 178 <p>
 179 </p>
 180 </div>
 181 </div>
 182 <div class="refsect1">
 183 <a name="gst-plugins-good-plugins-audiokaraoke.property-details"></a><h2>Property Details</h2>
 184 <div class="refsect2">
 185 <a name="GstAudioKaraoke--filter-band"></a><h3>The <code class="literal">"filter-band"</code> property</h3>
 186 <pre class="programlisting">  "filter-band"              <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 Frequency band of the filter.</p>
 188 <p>Allowed values: [0,441]</p>
 189 <p>Default value: 220</p>
 190 </div>
 191 <hr>
 192 <div class="refsect2">
 193 <a name="GstAudioKaraoke--filter-width"></a><h3>The <code class="literal">"filter-width"</code> property</h3>
 194 <pre class="programlisting">  "filter-width"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 195 <p>The Frequency width of the filter.</p>
 196 <p>Allowed values: [0,100]</p>
 197 <p>Default value: 100</p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="GstAudioKaraoke--level"></a><h3>The <code class="literal">"level"</code> property</h3>
 202 <pre class="programlisting">  "level"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 203 <p>Level of the effect (1.0 = full).</p>
 204 <p>Allowed values: [0,1]</p>
 205 <p>Default value: 1</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="GstAudioKaraoke--mono-level"></a><h3>The <code class="literal">"mono-level"</code> property</h3>
 210 <pre class="programlisting">  "mono-level"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 211 <p>Level of the mono channel (1.0 = full).</p>
 212 <p>Allowed values: [0,1]</p>
 213 <p>Default value: 1</p>
 214 </div>
 215 </div>
 216 </div>
 217 <div class="footer">
 218 <hr>
 219           Generated by GTK-Doc V1.18</div>
 220 </body>
 221 </html>