vorbisfile - function - ov_test_callbacks

vorbisfile documentation | vorbisfile - 20011218

# ov_test_callbacks

declared in "vorbis/vorbisfile.h";

This is an alternative function used to open and test an OggVorbis_File structure when using a data source other than a file. It allows you to specify custom file manipulation routines and sets up all the related decoding structure.

Once this has been called, the same `OggVorbis_File` struct should be passed to all the vorbisfile functions.

    int ov_test_callbacks(void *datasource, OggVorbis_File *vf, char *initial, long ibytes, ov_callbacks callbacks);

### Parameters

f
  File pointer to an already opened file or pipe (it need not be seekable--though this obviously restricts what can be done with the bitstream).
vf
  A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile functions. Once this has been called, the same `OggVorbis_File` struct should be passed to all the vorbisfile functions.
initial
  Typically set to NULL. This parameter is useful if some data has already been read from the file and the stream is not seekable. It is used in conjunction with `ibytes`. In this case, `initial` should be a pointer to a buffer containing the data read.
ibytes
  Typically set to 0. This parameter is useful if some data has already been read from the file and the stream is not seekable. In this case, `ibytes` should contain the length (in bytes) of the buffer. Used together with `initial`.
callbacks
  Pointer to a completed ov_callbacks struct which indicates desired custom file manipulation routines.

### Return Values

> - 0 for success
> - less than zero for failure:
> - OV_EREAD - A read from media returned an error.
> - OV_ENOTVORBIS - Bitstream is not Vorbis data.
> - OV_EVERSION - Vorbis version mismatch.
> - OV_EBADHEADER - Invalid Vorbis bitstream header.
> - OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.

copyright © 2001 vorbis team | Ogg Vorbis team@vorbis.org
vorbisfile documentation | vorbisfile - 20011218