| 1 |
<html> |
| 2 |
|
| 3 |
<head> |
| 4 |
<title>Tremor - API Overview</title> |
| 5 |
<link rel=stylesheet href="style.css" type="text/css"> |
| 6 |
</head> |
| 7 |
|
| 8 |
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| 9 |
<table border=0 width=100%> |
| 10 |
<tr> |
| 11 |
<td><p class=tiny>Tremor documentation</p></td> |
| 12 |
<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> |
| 13 |
</tr> |
| 14 |
</table> |
| 15 |
|
| 16 |
<h1>Tremor API Overview</h1> |
| 17 |
|
| 18 |
<p>The makeup of the Tremor libvorbisidec library API is relatively |
| 19 |
simple. It revolves around a single file resource. This file resource is |
| 20 |
passed to libvorbisidec, where it is opened, manipulated, and closed, |
| 21 |
in the form of an <a href="OggVorbis_File.html">OggVorbis_File</a> |
| 22 |
struct. |
| 23 |
<p> |
| 24 |
The Tremor API consists of the following functional categories: |
| 25 |
<p> |
| 26 |
<ul> |
| 27 |
<li><p><a href="datastructures.html">Base data structures</a> |
| 28 |
<li><p><a href="initialization.html">Setup/Teardown</a> |
| 29 |
<li><p><a href="decoding.html">Decoding</a> |
| 30 |
<li><p><a href="seeking.html">Seeking</a> |
| 31 |
<li><p><a href="fileinfo.html">File Information</a> |
| 32 |
</ul> |
| 33 |
<p> |
| 34 |
In addition, the following subjects deserve attention additional to |
| 35 |
the above general overview: |
| 36 |
<p> |
| 37 |
<ul> |
| 38 |
<li><p><a href="threads.html">Threading and thread safety</a> |
| 39 |
<li><p><a href="callbacks.html">Using [non stdio] custom stream I/O |
| 40 |
via callbacks</a> |
| 41 |
<li><a href="diff.html">Tremor / vorbisfile API differences</a><br> |
| 42 |
</ul> |
| 43 |
<p> |
| 44 |
|
| 45 |
|
| 46 |
<br><br> |
| 47 |
<hr noshade> |
| 48 |
<table border=0 width=100%> |
| 49 |
<tr valign=top> |
| 50 |
<td><p class=tiny>copyright © 2002 Xiph.org</p></td> |
| 51 |
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> |
| 52 |
</tr><tr> |
| 53 |
<td><p class=tiny>Tremor documentation</p></td> |
| 54 |
<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> |
| 55 |
</tr> |
| 56 |
</table> |
| 57 |
|
| 58 |
</body> |
| 59 |
|
| 60 |
</html> |
| 61 |
|