diff options
| author | Monty <xiphmont@xiph.org> | 2002-09-02 22:17:22 +0000 |
|---|---|---|
| committer | Monty <xiphmont@xiph.org> | 2002-09-02 22:17:22 +0000 |
| commit | 6e70b36ec8818a090e90d0dea18b78860d1b006c (patch) | |
| tree | 67007d05d937aee95255893db26389591939e153 /doc/ov_callbacks.html | |
| parent | 56fbebdcf71ea7c8e64cb18ac3a78e5834134fa3 (diff) | |
| download | tremor-6e70b36ec8818a090e90d0dea18b78860d1b006c.tar.gz | |
Add Tremor docs to CVS
git-svn-id: https://svn.xiph.org/trunk/Tremor@3891 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'doc/ov_callbacks.html')
| -rw-r--r-- | doc/ov_callbacks.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/ov_callbacks.html b/doc/ov_callbacks.html new file mode 100644 index 0000000..776352d --- /dev/null +++ b/doc/ov_callbacks.html @@ -0,0 +1,78 @@ +<html> + +<head> +<title>Tremor - datatype - ov_callbacks</title> +<link rel=stylesheet href="style.css" type="text/css"> +</head> + +<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> +<table border=0 width=100%> +<tr> +<td><p class=tiny>Tremor documentation</p></td> +<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> +</tr> +</table> + +<h1>ov_callbacks</h1> + +<p><i>declared in "ivorbiscodec.h"</i></p> + +<p> +The ov_callbacks structure contains file manipulation function prototypes necessary for opening, closing, seeking, and location. + +<p> +The ov_callbacks structure does not need to be user-defined if you are +working with stdio-based file manipulation; the <a +href="ov_open.html">ov_open()</a> call provides default callbacks for +stdio. ov_callbacks are defined and passed to <a +href="ov_open_callbacks.html">ov_open_callbacks()</a> when +implementing non-stdio based stream manipulation (such as playback +from a memory buffer). +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b>typedef struct { + size_t (*read_func) (void *ptr, size_t size, size_t nmemb, void *datasource); + int (*seek_func) (void *datasource, ogg_int64_t offset, int whence); + int (*close_func) (void *datasource); + long (*tell_func) (void *datasource); +} ov_callbacks;</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>read_func</i></dt> +<dd>Pointer to custom data reading function.</dd> +<dt><i>seek_func</i></dt> +<dd>Pointer to custom data seeking function. If the data source is not seekable (or the application wants the data source to be treated as unseekable at all times), the provided seek callback should always return -1 (failure).</dd> +<dt><i>close_func</i></dt> +<dd>Pointer to custom data source closure function.</dd> +<dt><i>tell_func</i></dt> +<dd>Pointer to custom data location function.</dd> +</dl> + +<p> + +See <a href="callbacks.html">the callbacks and non-stdio I/O document</a> for more +detailed information on required behavior of the various callback +functions.<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> +</tr><tr> +<td><p class=tiny>Tremor documentation</p></td> +<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> +</tr> +</table> + +</body> + +</html> |