← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/ocaml-vorbis/oneiric

« back to all changes in this revision

Viewing changes to doc/html/Vorbis.html

  • Committer: Bazaar Package Importer
  • Author(s): Samuel Mimram
  • Date: 2009-02-23 14:14:09 UTC
  • mfrom: (1.1.9 upstream) (2.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090223141409-4zao0op85s333ygh
Tags: 0.5.0-1
* New Upstream Version.
* Switch packaging to git.
* Use dh-ocaml's predefined variables.
* Update compat to 7.
* Update standards version to 3.8.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/Vorbis.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<link rel="stylesheet" href="style.css" type="text/css">
5
 
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6
 
<link rel="Start" href="index.html">
7
 
<link rel="Up" href="index.html">
8
 
<link title="Index of types" rel=Appendix href="index_types.html">
9
 
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
10
 
<link title="Index of values" rel=Appendix href="index_values.html">
11
 
<link title="Index of modules" rel=Appendix href="index_modules.html">
12
 
<link title="Vorbis" rel="Chapter" href="Vorbis.html"><link title="Exceptions" rel="Section" href="#1_Exceptions">
13
 
<link title="Useful types" rel="Section" href="#1_Usefultypes">
14
 
<link title="Operations with vorbis files" rel="Section" href="#1_Operationswithvorbisfiles">
15
 
<link title="Encoding" rel="Subsection" href="#2_Encoding">
16
 
<link title="Decoding" rel="Subsection" href="#2_Decoding">
17
 
<title>Vorbis</title>
18
 
</head>
19
 
<body>
20
 
<div class="navbar">&nbsp;<a href="index.html">Up</a>
21
 
&nbsp;</div>
22
 
<center><h1>Module <a href="type_Vorbis.html">Vorbis</a></h1></center>
23
 
<br>
24
 
<pre><span class="keyword">module</span> Vorbis: <code class="code">sig</code> <a href="Vorbis.html">..</a> <code class="code">end</code></pre> Decode from or encode to the Ogg Vorbis compressed audio format;
25
 
 or get informations about an Ogg Vorbis file.
26
 
<p>
27
 
 
28
 
<br>
29
 
<b>Author(s):</b> Samuel Mimram, Julien Cristau, David Baelde<br>
30
 
<hr width="100%">
31
 
<br>
32
 
<a name="1_Exceptions"></a>
33
 
<h1>Exceptions</h1><br>
34
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONInvalid_parameters"></a>Invalid_parameters</pre>
35
 
<div class="info">
36
 
Some parameters are invalid for this function.<br>
37
 
</div>
38
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONInvalid_quality"></a>Invalid_quality</pre>
39
 
<div class="info">
40
 
The given quality in invalid.<br>
41
 
</div>
42
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONInvalid_bitrate"></a>Invalid_bitrate</pre>
43
 
<div class="info">
44
 
The given bitrate is invalid.<br>
45
 
</div>
46
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONInvalid_channels"></a>Invalid_channels</pre>
47
 
<div class="info">
48
 
The given number of channels is invalid.<br>
49
 
</div>
50
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONInvalid_sample_freq"></a>Invalid_sample_freq</pre>
51
 
<div class="info">
52
 
The given sampling frequency is invalid.<br>
53
 
</div>
54
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONInvalid_argument"></a>Invalid_argument</pre>
55
 
<div class="info">
56
 
Invalid setup request, e.g. out of range argument.<br>
57
 
</div>
58
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONCould_not_open_file"></a>Could_not_open_file</pre>
59
 
<div class="info">
60
 
The given file could not be opened.<br>
61
 
</div>
62
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONNot_vorbis"></a>Not_vorbis</pre>
63
 
<div class="info">
64
 
Bitstream is not Vorbis data.<br>
65
 
</div>
66
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONBad_header"></a>Bad_header</pre>
67
 
<div class="info">
68
 
Invalid Vorbis bitstream header.<br>
69
 
</div>
70
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONRead_error"></a>Read_error</pre>
71
 
<div class="info">
72
 
A read from media returned an error.<br>
73
 
</div>
74
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONInternal_fault"></a>Internal_fault</pre>
75
 
<div class="info">
76
 
Internal logic fault; indicates a bug or heap/stack corruption.<br>
77
 
</div>
78
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONHole_in_data"></a>Hole_in_data</pre>
79
 
<div class="info">
80
 
Indicates there was an interruption in the data (one of: garbage between
81
 
 pages, loss of sync followed by recapture, or a corrupt page).<br>
82
 
</div>
83
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONBad_link"></a>Bad_link</pre>
84
 
<div class="info">
85
 
Indicates that an invalid stream section was supplied,
86
 
 or the requested link is corrupt.<br>
87
 
</div>
88
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONVersion_mismatch"></a>Version_mismatch</pre>
89
 
<div class="info">
90
 
Invalid Vorbis bitstream header.<br>
91
 
</div>
92
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONNot_implemented"></a>Not_implemented</pre>
93
 
<div class="info">
94
 
Unimplemented mode.<br>
95
 
</div>
96
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONUnknown_error"></a>Unknown_error <span class="keyword">of</span> <code class="type">int</code></pre>
97
 
<div class="info">
98
 
An unknown error happened (it should not have happened, please report).<br>
99
 
</div>
100
 
<pre><span class="keyword">exception</span> <a name="EXCEPTIONUtf8_failure"></a>Utf8_failure <span class="keyword">of</span> <code class="type">string</code></pre>
101
 
<div class="info">
102
 
Error while converting utf8.<br>
103
 
</div>
104
 
<br>
105
 
<a name="1_Usefultypes"></a>
106
 
<h1>Useful types</h1><br>
107
 
<pre><span class="keyword">type</span> <a name="TYPEbitstream"></a><code class="type"></code>bitstream = <code class="type">int</code> </pre>
108
 
<div class="info">
109
 
Index of a logical bitstream. The special value -1 means the physical
110
 
 bitsream.<br>
111
 
</div>
112
 
 
113
 
<br><code><span class="keyword">type</span> <a name="TYPEinfo"></a><code class="type"></code>info = {</code><table class="typetable">
114
 
<tr>
115
 
<td align="left" valign="top" >
116
 
<code>&nbsp;&nbsp;</code></td>
117
 
<td align="left" valign="top" >
118
 
<code>vorbis_version&nbsp;: <code class="type">int</code>;</code></td>
119
 
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >version of vorbis codec, must be 0</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
120
 
</tr>
121
 
<tr>
122
 
<td align="left" valign="top" >
123
 
<code>&nbsp;&nbsp;</code></td>
124
 
<td align="left" valign="top" >
125
 
<code>audio_channels&nbsp;: <code class="type">int</code>;</code></td>
126
 
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >number of audio channels</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
127
 
</tr>
128
 
<tr>
129
 
<td align="left" valign="top" >
130
 
<code>&nbsp;&nbsp;</code></td>
131
 
<td align="left" valign="top" >
132
 
<code>audio_samplerate&nbsp;: <code class="type">int</code>;</code></td>
133
 
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >samplerate in Hertz</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
134
 
</tr>
135
 
<tr>
136
 
<td align="left" valign="top" >
137
 
<code>&nbsp;&nbsp;</code></td>
138
 
<td align="left" valign="top" >
139
 
<code>bitrate_upper&nbsp;: <code class="type">int</code>;</code></td>
140
 
 
141
 
</tr>
142
 
<tr>
143
 
<td align="left" valign="top" >
144
 
<code>&nbsp;&nbsp;</code></td>
145
 
<td align="left" valign="top" >
146
 
<code>bitrate_nominal&nbsp;: <code class="type">int</code>;</code></td>
147
 
 
148
 
</tr>
149
 
<tr>
150
 
<td align="left" valign="top" >
151
 
<code>&nbsp;&nbsp;</code></td>
152
 
<td align="left" valign="top" >
153
 
<code>bitrate_lower&nbsp;: <code class="type">int</code>;</code></td>
154
 
 
155
 
</tr>
156
 
<tr>
157
 
<td align="left" valign="top" >
158
 
<code>&nbsp;&nbsp;</code></td>
159
 
<td align="left" valign="top" >
160
 
<code>bitrate_window&nbsp;: <code class="type">int</code>;</code></td>
161
 
 
162
 
</tr></table>
163
 
}
164
 
 
165
 
<div class="info">
166
 
Vorbis informations about a file.<br>
167
 
</div>
168
 
 
169
 
<br>
170
 
<a name="1_Operationswithvorbisfiles"></a>
171
 
<h1>Operations with vorbis files</h1><br>
172
 
<br>
173
 
<a name="2_Encoding"></a>
174
 
<h2>Encoding</h2><br>
175
 
<pre><span class="keyword">val</span> <a name="VALtags"></a>tags : <code class="type">?title:string -><br>       ?artist:string -><br>       ?genre:string -><br>       ?date:string -><br>       ?album:string -><br>       ?tracknumber:string -> ?comment:string -> unit -> (string * string) list</code></pre><div class="info">
176
 
Create a list of vorbis tags.<br>
177
 
</div>
178
 
<pre><span class="keyword">module</span> <a href="Vorbis.Encoder.html">Encoder</a>: <code class="code">sig</code> <a href="Vorbis.Encoder.html">..</a> <code class="code">end</code></pre><br>
179
 
<a name="2_Decoding"></a>
180
 
<h2>Decoding</h2><br>
181
 
<pre><span class="keyword">module</span> <a href="Vorbis.Decoder.html">Decoder</a>: <code class="code">sig</code> <a href="Vorbis.Decoder.html">..</a> <code class="code">end</code></pre></body></html>
 
 
b'\\ No newline at end of file'