<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="Up" href="Speex.Wrapper.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Speex" rel="Chapter" href="Speex.html"><title>Speex.Wrapper.Decoder</title> </head> <body> <div class="navbar"> <a href="Speex.Wrapper.html">Up</a> </div> <center><h1>Module <a href="type_Speex.Wrapper.Decoder.html">Speex.Wrapper.Decoder</a></h1></center> <br> <pre><span class="keyword">module</span> Decoder: <code class="code">sig</code> <a href="Speex.Wrapper.Decoder.html">..</a> <code class="code">end</code></pre><hr width="100%"> <br> High level wrapper to easily decode speex files.<br> <pre><span class="keyword">exception</span> <a name="EXCEPTIONNot_speex"></a>Not_speex</pre> <pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre> <div class="info"> Opaque type for the decoder.<br> </div> <pre><span class="keyword">val</span> <a name="VALopen_sync"></a>open_sync : <code class="type">Ogg.Sync.t -> <a href="Speex.Wrapper.Decoder.html#TYPEt">t</a></code></pre><div class="info"> Open the passed <code class="code">Ogg.Sync</code> as a new speex stream.<br> </div> <pre><span class="keyword">val</span> <a name="VALopen_file"></a>open_file : <code class="type">string -> <a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> * Unix.file_descr</code></pre><div class="info"> Open the passed file name as a new speex stream.<br> </div> <pre><span class="keyword">val</span> <a name="VALopen_feed"></a>open_feed : <code class="type">(int -> string * int) -> <a href="Speex.Wrapper.Decoder.html#TYPEt">t</a></code></pre><div class="info"> Open the passed feed as a new speex stream.<br> </div> <pre><span class="keyword">val</span> <a name="VALserial"></a>serial : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> nativeint</code></pre><div class="info"> Get the serial of the stream currently being decoded. This value may change if the stream contains sequentialized ogg streams.<br> </div> <pre><span class="keyword">val</span> <a name="VALcomments"></a>comments : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (string * string) list</code></pre><div class="info"> Get current comments.<br> </div> <pre><span class="keyword">val</span> <a name="VALheader"></a>header : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> <a href="Speex.Header.html#TYPEt">Speex.Header.t</a></code></pre><div class="info"> Get current header.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode"></a>decode : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> float array list</code></pre><div class="info"> Decode audio data.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode_stereo"></a>decode_stereo : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> float array array list</code></pre><div class="info"> Decode stereo audio data.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode_feed"></a>decode_feed : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (float array -> unit) -> unit</code></pre><div class="info"> Decode audio data, passing it to a feed.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode_feed_stereo"></a>decode_feed_stereo : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (float array array -> unit) -> unit</code></pre><div class="info"> Same as <code class="code">decode_feed</code> but with stereo data.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode_int"></a>decode_int : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> int array list</code></pre><div class="info"> Same as <code class="code">decode</code> but with integers.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode_int_stereo"></a>decode_int_stereo : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> int array array list</code></pre><div class="info"> Same as <code class="code">decode_stereo</code> but with integers.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode_int_feed"></a>decode_int_feed : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (int array -> unit) -> unit</code></pre><div class="info"> Same as <code class="code">decode_feed</code> but with integers.<br> </div> <pre><span class="keyword">val</span> <a name="VALdecode_int_feed_stereo"></a>decode_int_feed_stereo : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (int array array -> unit) -> unit</code></pre><div class="info"> Same as <code class="code">decode_int_feed_stereo</code> but with integers.<br> </div> </body></html>