docs/plugins/html/gst-plugins-base-plugins-audioresample.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>audioresample</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-audiorate.html" title="audiorate">
  10 <link rel="next" href="gst-plugins-base-plugins-audiotestsrc.html" title="audiotestsrc">
  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-base-plugins-audiorate.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 Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-audiotestsrc.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-base-plugins-audioresample.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-audioresample.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-audioresample.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-audioresample.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-plugins-audioresample"></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-base-plugins-audioresample.top_of_page"></a>audioresample</span></h2>
  38 <p>audioresample — Resamples audio</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-base-plugins-audioresample.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstAudioResample"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-audioresample.html#GstAudioResample-struct" title="struct GstAudioResample">GstAudioResample</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-base-plugins-audioresample.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                      +----GstAudioResample
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gst-plugins-base-plugins-audioresample.properties"></a><h2>Properties</h2>
  59 <pre class="synopsis">
  60   "<a class="link" href="gst-plugins-base-plugins-audioresample.html#GstAudioResample--filter-length" title='The "filter-length" property'>filter-length</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  61   "<a class="link" href="gst-plugins-base-plugins-audioresample.html#GstAudioResample--quality" title='The "quality" property'>quality</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-base-plugins-audioresample.description"></a><h2>Description</h2>
  66 <p>
  67 audioresample resamples raw audio buffers to different sample rates using
  68 a configurable windowing function to enhance quality.
  69 </p>
  70 <p>
  71 </p>
  72 <div class="refsect2">
  73 <a name="idp8557472"></a><h3>Example launch line</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>sine<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisdec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> audio<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">-</span><span class="gtkdoc kwb">int</span><span class="gtkdoc opt">,</span> rate<span class="gtkdoc opt">=</span><span class="number">8000</span> <span class="gtkdoc opt">!</span> alsasink</pre></td>
  80       </tr>
  81     </tbody>
  82   </table>
  83 </div>
  84  Decode an Ogg/Vorbis downsample to 8Khz and play sound through alsa.
  85 To create the Ogg/Vorbis file refer to the documentation of vorbisenc.
  86 </div>
  87 <p>
  88 </p>
  89 <div class="refsynopsisdiv">
  90 <h2>Synopsis</h2>
  91 <div class="refsect2">
  92 <a name="idp8555248"></a><h3>Element Information</h3>
  93 <div class="variablelist"><table border="0">
  94 <col align="left" valign="top">
  95 <tbody>
  96 <tr>
  97 <td><p><span class="term">plugin</span></p></td>
  98 <td>
  99             <a class="link" href="gst-plugins-base-plugins-plugin-audioresample.html#plugin-audioresample">audioresample</a>
 100           </td>
 101 </tr>
 102 <tr>
 103 <td><p><span class="term">author</span></p></td>
 104 <td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term">class</span></p></td>
 108 <td>Filter/Converter/Audio</td>
 109 </tr>
 110 </tbody>
 111 </table></div>
 112 </div>
 113 <hr>
 114 <div class="refsect2">
 115 <a name="idp6067952"></a><h3>Element Pads</h3>
 116 <div class="variablelist"><table border="0">
 117 <col align="left" valign="top">
 118 <tbody>
 119 <tr>
 120 <td><p><span class="term">name</span></p></td>
 121 <td>sink</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">direction</span></p></td>
 125 <td>sink</td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term">presence</span></p></td>
 129 <td>always</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">details</span></p></td>
 133 <td>audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term"></span></p></td>
 137 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean)true</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term"></span></p></td>
 141 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)24, depth=(int)24, signed=(boolean)true</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term"></span></p></td>
 145 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term"></span></p></td>
 149 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean)true</td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 <div class="variablelist"><table border="0">
 154 <col align="left" valign="top">
 155 <tbody>
 156 <tr>
 157 <td><p><span class="term">name</span></p></td>
 158 <td>src</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term">direction</span></p></td>
 162 <td>source</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term">presence</span></p></td>
 166 <td>always</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term">details</span></p></td>
 170 <td>audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }</td>
 171 </tr>
 172 <tr>
 173 <td><p><span class="term"></span></p></td>
 174 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean)true</td>
 175 </tr>
 176 <tr>
 177 <td><p><span class="term"></span></p></td>
 178 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)24, depth=(int)24, signed=(boolean)true</td>
 179 </tr>
 180 <tr>
 181 <td><p><span class="term"></span></p></td>
 182 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</td>
 183 </tr>
 184 <tr>
 185 <td><p><span class="term"></span></p></td>
 186 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean)true</td>
 187 </tr>
 188 </tbody>
 189 </table></div>
 190 </div>
 191 </div>
 192 <p>
 193 </p>
 194 </div>
 195 <div class="refsect1">
 196 <a name="gst-plugins-base-plugins-audioresample.details"></a><h2>Details</h2>
 197 <div class="refsect2">
 198 <a name="GstAudioResample-struct"></a><h3>struct GstAudioResample</h3>
 199 <pre class="programlisting">struct GstAudioResample;</pre>
 200 <p>
 201 Opaque data structure.
 202 </p>
 203 </div>
 204 </div>
 205 <div class="refsect1">
 206 <a name="gst-plugins-base-plugins-audioresample.property-details"></a><h2>Property Details</h2>
 207 <div class="refsect2">
 208 <a name="GstAudioResample--filter-length"></a><h3>The <code class="literal">"filter-length"</code> property</h3>
 209 <pre class="programlisting">  "filter-length"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 210 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 211 <h3 class="title">Warning</h3>
 212 <p><code class="literal">GstAudioResample:filter-length</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="gst-plugins-base-plugins-audioresample.html#GstAudioResample--quality" title='The "quality" property'><span class="type">"quality"</span></a> property instead</p>
 213 </div>
 214 <p>
 215 Length of the resample filter
 216 </p>
 217 <p>Allowed values: &gt;= 0</p>
 218 <p>Default value: 64</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstAudioResample--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
 223 <pre class="programlisting">  "quality"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 224 <p>Resample quality with 0 being the lowest and 10 being the best.</p>
 225 <p>Allowed values: [0,10]</p>
 226 <p>Default value: 4</p>
 227 </div>
 228 </div>
 229 </div>
 230 <div class="footer">
 231 <hr>
 232           Generated by GTK-Doc V1.18</div>
 233 </body>
 234 </html>