liboggz  1.1.1
Typedefs | Functions
oggz_read.h File Reference

Interfaces for reading Ogg files and streams. More...

#include <oggz/oggz_packet.h>

Go to the source code of this file.

Typedefs

typedef int(* OggzReadPacket )(OGGZ *oggz, oggz_packet *packet, long serialno, void *user_data)
 This is the signature of a callback which you must provide for Oggz to call whenever it finds a new packet in the Ogg stream associated with oggz. More...
 
typedef int(* OggzReadPage )(OGGZ *oggz, const ogg_page *og, long serialno, void *user_data)
 This is the signature of a callback which you must provide for Oggz to call whenever it finds a new page in the Ogg stream associated with oggz. More...
 

Functions

int oggz_set_read_callback (OGGZ *oggz, long serialno, OggzReadPacket read_packet, void *user_data)
 Set a callback for Oggz to call when a new Ogg packet is found in the stream. More...
 
int oggz_set_read_page (OGGZ *oggz, long serialno, OggzReadPage read_page, void *user_data)
 Set a callback for Oggz to call when a new Ogg page is found in the stream. More...
 
long oggz_read (OGGZ *oggz, long n)
 Read n bytes into oggz, calling any read callbacks on the fly. More...
 
long oggz_read_input (OGGZ *oggz, unsigned char *buf, long n)
 Input data into oggz. More...
 
int oggz_purge (OGGZ *oggz)
 Erase any input buffered in Oggz. More...
 
OggzStreamContent oggz_stream_get_content (OGGZ *oggz, long serialno)
 Determine the content type of the oggz stream referred to by serialno. More...
 
const char * oggz_stream_get_content_type (OGGZ *oggz, long serialno)
 Return human-readable string representation of content type of oggz stream referred to by serialno. More...
 
int oggz_stream_get_numheaders (OGGZ *oggz, long serialno)
 Determine the number of headers of the oggz stream referred to by serialno. More...
 

Detailed Description

Interfaces for reading Ogg files and streams.

Function Documentation

int oggz_purge ( OGGZ oggz)

Erase any input buffered in Oggz.

This discards any input read from the underlying IO system but not yet delivered as ogg_packets.

Parameters
oggzAn OGGZ handle
Return values
0Success
OGGZ_ERR_SYSTEMError seeking on underlying IO.
OGGZ_ERR_BAD_OGGZoggz does not refer to an existing OGGZ
OGGZ_ERR_INVALIDOperation not suitable for this OGGZ
OggzStreamContent oggz_stream_get_content ( OGGZ oggz,
long  serialno 
)

Determine the content type of the oggz stream referred to by serialno.

Parameters
oggzAn OGGZ handle
serialnoAn ogg stream serialno
Return values
OGGZ_CONTENT_THEORA..OGGZ_CONTENT_UNKNOWNcontent successfully identified
OGGZ_ERR_BAD_OGGZoggz does not refer to an existing OGGZ
OGGZ_ERR_BAD_SERIALNOserialno does not refer to an existing stream
const char* oggz_stream_get_content_type ( OGGZ oggz,
long  serialno 
)

Return human-readable string representation of content type of oggz stream referred to by serialno.

Parameters
oggzAn OGGZ handle
serialnoAn ogg stream serialno
Return values
stringthe name of the content type
NULLoggz or serialno invalid
int oggz_stream_get_numheaders ( OGGZ oggz,
long  serialno 
)

Determine the number of headers of the oggz stream referred to by serialno.

Parameters
oggzAn OGGZ handle
serialnoAn ogg stream serialno
Return values
OGGZ_CONTENT_THEORA..OGGZ_CONTENT_UNKNOWNcontent successfully identified
OGGZ_ERR_BAD_OGGZoggz does not refer to an existing OGGZ
OGGZ_ERR_BAD_SERIALNOserialno does not refer to an existing stream