<!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="Flac.Encoder.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="Flac" rel="Chapter" href="Flac.html">
<link title="Ogg_flac" rel="Chapter" href="Ogg_flac.html">
<link title="Ogg_demuxer_flac_decoder" rel="Chapter" href="Ogg_demuxer_flac_decoder.html"><link title="Types" rel="Section" href="#3_Types">
<link title="Functions" rel="Section" href="#3_Functions">
<title>Flac.Encoder.File</title>
</head>
<body>
<div class="navbar"> <a class="up" href="Flac.Encoder.html" title="Flac.Encoder">Up</a>
</div>
<h1>Module <a href="type_Flac.Encoder.File.html">Flac.Encoder.File</a></h1>
<pre><span class="keyword">module</span> File: <code class="code">sig</code> <a href="Flac.Encoder.File.html">..</a> <code class="code">end</code></pre><div class="info module top">
Encode to a local file<br>
</div>
<hr width="100%">
<br>
Convenience module to encode to a local native FLAC file.<br>
<br>
<h3 id="3_Types">Types</h3><br>
<pre><span id="TYPEfile"><span class="keyword">type</span> <code class="type"></code>file</span> </pre>
<div class="info ">
Generic variant type for file encoder<br>
</div>
<pre><code><span id="TYPEhandle"><span class="keyword">type</span> <code class="type"></code>handle</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThandle.fd">fd</span> : <code class="type">Unix.file_descr</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThandle.enc">enc</span> : <code class="type"><a href="Flac.Encoder.File.html#TYPEfile">file</a> <a href="Flac.Encoder.html#TYPEt">Flac.Encoder.t</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThandle.callbacks">callbacks</span> : <code class="type"><a href="Flac.Encoder.File.html#TYPEfile">file</a> <a href="Flac.Encoder.html#TYPEcallbacks">Flac.Encoder.callbacks</a></code>;</code></td>
</tr></table>
}
<div class="info ">
Handle for file encoder<br>
</div>
<br>
<h3 id="3_Functions">Functions</h3><br>
<pre><span id="VALcreate_from_fd"><span class="keyword">val</span> create_from_fd</span> : <code class="type">?comments:<a href="Flac.Encoder.html#TYPEcomments">Flac.Encoder.comments</a> -><br> <a href="Flac.Encoder.html#TYPEparams">Flac.Encoder.params</a> -> Unix.file_descr -> <a href="Flac.Encoder.File.html#TYPEhandle">handle</a></code></pre><div class="info ">
Create a file encoder writing data to a given Unix file descriptor.
<p>
Note: this encoder requires seeking thus will only work on seekable
file descriptor.<br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">?comments:<a href="Flac.Encoder.html#TYPEcomments">Flac.Encoder.comments</a> -><br> <a href="Flac.Encoder.html#TYPEparams">Flac.Encoder.params</a> -> string -> <a href="Flac.Encoder.File.html#TYPEhandle">handle</a></code></pre><div class="info ">
Create a file encoder writing data to the given file URI<br>
</div>
</body></html>
