Vorbisfile - API Overview

Vorbisfile documentation | vorbisfile version 1.2.0 - 20070723

# Vorbisfile API Overview

The makeup of the Vorbisfile libvorbisfile library API is relatively simple. It revolves around a single file resource. This file resource is passed to libvorbisfile, where it is opened, manipulated, and closed, in the form of an OggVorbis_File struct.

The Vorbisfile API consists of the following functional categories:

- Base data structures

- Setup/Teardown

- Decoding

- Seeking

- File Information

In addition, the following subjects deserve attention additional to the above general overview:

- Threading and thread safety

- Using [non stdio] custom stream I/O via callbacks

- Sample crosslapping

copyright © 2007 Xiph.org | Ogg Vorbis
Vorbisfile documentation | vorbisfile version 1.2.0 - 20070723