/usr/share/doc/libvoaacenc-ocaml-dev/html/Voaacenc.html is in libvoaacenc-ocaml-dev 0.1.0-1build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 | <!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="index.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="Voaacenc" rel="Chapter" href="Voaacenc.html"><link title="Exceptions" rel="Section" href="#2_Exceptions">
<link title="Types" rel="Section" href="#2_Types">
<link title="Functions" rel="Section" href="#2_Functions">
<title>Voaacenc</title>
</head>
<body>
<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Module <a href="type_Voaacenc.html">Voaacenc</a></h1>
<pre><span class="keyword">module</span> Voaacenc: <code class="code">sig</code> <a href="Voaacenc.html">..</a> <code class="code">end</code></pre><div class="info module top">
<h1 id="1_AACencodingmoduleforOCaml">AAC encoding module for OCaml</h1><br>
</div>
<hr width="100%">
<br>
<h2 id="2_Exceptions">Exceptions</h2><br>
<pre><span id="EXCEPTIONFailed"><span class="keyword">exception</span> Failed</span></pre>
<pre><span id="EXCEPTIONNot_implemented"><span class="keyword">exception</span> Not_implemented</span></pre>
<pre><span id="EXCEPTIONInvalid_voaacenc_argument"><span class="keyword">exception</span> Invalid_voaacenc_argument</span></pre>
<pre><span id="EXCEPTIONInput_buffer_too_small"><span class="keyword">exception</span> Input_buffer_too_small</span></pre>
<pre><span id="EXCEPTIONOutput_buffer_too_small"><span class="keyword">exception</span> Output_buffer_too_small</span></pre>
<pre><span id="EXCEPTIONUnknown"><span class="keyword">exception</span> Unknown</span> <span class="keyword">of</span> <code class="type">int</code></pre>
<pre><span id="VALstring_of_exception"><span class="keyword">val</span> string_of_exception</span> : <code class="type">exn -> string option</code></pre><br>
<h2 id="2_Types">Types</h2><br>
<pre><code><span id="TYPEparameters"><span class="keyword">type</span> <code class="type"></code>parameters</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparameters.samplerate">samplerate</span> : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparameters.channels">channels</span> : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparameters.bitrate">bitrate</span> : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparameters.adts">adts</span> : <code class="type">bool</code>;</code></td>
</tr></table>
}
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<br>
<h2 id="2_Functions">Functions</h2><br>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type"><a href="Voaacenc.html#TYPEparameters">parameters</a> -> <a href="Voaacenc.html#TYPEt">t</a></code></pre><div class="info ">
Create a new encoder.<br>
</div>
<pre><span id="VALrecommended_minimum_input"><span class="keyword">val</span> recommended_minimum_input</span> : <code class="type"><a href="Voaacenc.html#TYPEt">t</a> -> int</code></pre><div class="info ">
Recommended minimun input to
feed to the decoder.<br>
</div>
<pre><span id="VALencode_string"><span class="keyword">val</span> encode_string</span> : <code class="type"><a href="Voaacenc.html#TYPEt">t</a> -> string -> string * int</code></pre><div class="info ">
<code class="code">encode_string enc data</code> encodes the
given S16LE pcm buffer and returns
AAC data and the number of input bytes
consumed by the decoder.<br>
</div>
<pre><span id="VALencode_substring"><span class="keyword">val</span> encode_substring</span> : <code class="type"><a href="Voaacenc.html#TYPEt">t</a> -> string -> int -> int -> string * int</code></pre><div class="info ">
<code class="code">encode_substring enc data offset len</code> encodes
the sub-string of <code class="code">data</code> starting at
position <code class="code">offset</code> and of length <code class="code">len</code>.
Raises <code class="code">Invalid_argument</code> if such sub-string
does not exist.<br>
</div>
<pre><span id="VALencode_buffer"><span class="keyword">val</span> encode_buffer</span> : <code class="type"><a href="Voaacenc.html#TYPEt">t</a> -> Buffer.t -> string</code></pre><div class="info ">
<code class="code">encode_buffer enc buffer</code> encodes S16LE
data from the string buffer <code class="code">buffer</code> and
drops consumed data from <code class="code">buffer</code>. This
does nothing if <code class="code">Buffer.length buffer < recommended_minumun_input enc</code><br>
</div>
</body></html>
|