<!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"> <meta name="viewport" content="width=device-width, initial-scale=1"> <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"> <link title="Ogg_demuxer_speex_decoder" rel="Chapter" href="Ogg_demuxer_speex_decoder.html"><title>Speex.Wrapper.Decoder</title> </head> <body> <div class="navbar"> <a class="up" href="Speex.Wrapper.html" title="Speex.Wrapper">Up</a> </div> <h1>Module <a href="type_Speex.Wrapper.Decoder.html">Speex.Wrapper.Decoder</a></h1> <pre><span id="MODULEDecoder"><span class="keyword">module</span> Decoder</span>: <code class="code">sig</code> <a href="Speex.Wrapper.Decoder.html">..</a> <code class="code">end</code></pre><hr width="100%"> <p>High level wrapper to easily decode speex files.</p> <pre><span id="EXCEPTIONNot_speex"><span class="keyword">exception</span> Not_speex</span></pre> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre> <div class="info "> <div class="info-desc"> <p>Opaque type for the decoder.</p> </div> </div> <pre><span id="VALopen_sync"><span class="keyword">val</span> open_sync</span> : <code class="type">Ogg.Sync.t -> <a href="Speex.Wrapper.Decoder.html#TYPEt">t</a></code></pre><div class="info "> <div class="info-desc"> <p>Open the passed <code class="code">Ogg.Sync</code> as a new speex stream.</p> </div> </div> <pre><span id="VALopen_file"><span class="keyword">val</span> open_file</span> : <code class="type">string -> <a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> * Unix.file_descr</code></pre><div class="info "> <div class="info-desc"> <p>Open the passed file name as a new speex stream.</p> </div> </div> <pre><span id="VALopen_feed"><span class="keyword">val</span> open_feed</span> : <code class="type">(int -> string * int) -> <a href="Speex.Wrapper.Decoder.html#TYPEt">t</a></code></pre><div class="info "> <div class="info-desc"> <p>Open the passed feed as a new speex stream.</p> </div> </div> <pre><span id="VALserial"><span class="keyword">val</span> serial</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> nativeint</code></pre><div class="info "> <div class="info-desc"> <p>Get the serial of the stream currently being decoded. This value may change if the stream contains sequentialized ogg streams.</p> </div> </div> <pre><span id="VALcomments"><span class="keyword">val</span> comments</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (string * string) list</code></pre><div class="info "> <div class="info-desc"> <p>Get current comments.</p> </div> </div> <pre><span id="VALheader"><span class="keyword">val</span> header</span> : <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 "> <div class="info-desc"> <p>Get current header.</p> </div> </div> <pre><span id="VALdecode"><span class="keyword">val</span> decode</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> float array list</code></pre><div class="info "> <div class="info-desc"> <p>Decode audio data.</p> </div> </div> <pre><span id="VALdecode_stereo"><span class="keyword">val</span> decode_stereo</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> float array array list</code></pre><div class="info "> <div class="info-desc"> <p>Decode stereo audio data.</p> </div> </div> <pre><span id="VALdecode_feed"><span class="keyword">val</span> decode_feed</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (float array -> unit) -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Decode audio data, passing it to a feed.</p> </div> </div> <pre><span id="VALdecode_feed_stereo"><span class="keyword">val</span> decode_feed_stereo</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (float array array -> unit) -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Same as <code class="code">decode_feed</code> but with stereo data.</p> </div> </div> <pre><span id="VALdecode_int"><span class="keyword">val</span> decode_int</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> int array list</code></pre><div class="info "> <div class="info-desc"> <p>Same as <code class="code">decode</code> but with integers.</p> </div> </div> <pre><span id="VALdecode_int_stereo"><span class="keyword">val</span> decode_int_stereo</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> int array array list</code></pre><div class="info "> <div class="info-desc"> <p>Same as <code class="code">decode_stereo</code> but with integers.</p> </div> </div> <pre><span id="VALdecode_int_feed"><span class="keyword">val</span> decode_int_feed</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (int array -> unit) -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Same as <code class="code">decode_feed</code> but with integers.</p> </div> </div> <pre><span id="VALdecode_int_feed_stereo"><span class="keyword">val</span> decode_int_feed_stereo</span> : <code class="type"><a href="Speex.Wrapper.Decoder.html#TYPEt">t</a> -> (int array array -> unit) -> unit</code></pre><div class="info "> <div class="info-desc"> <p>Same as <code class="code">decode_int_feed_stereo</code> but with integers.</p> </div> </div> </body></html>