oac_callback_info Struct Reference

Callback structure provided by audio format handlers. More...

#include <ogg_afh_common.h>

Data Fields
int(*	packet_callback )(ogg_packet *packet, int packet_num, int serial, struct afh_info *afhi, void *private_data)
	ogg_get_file_info() calls this function for the first three ogg packets, or until the callback returns a non-positive value. More...
void *	private_data
	Data specific to the audio format handler. More...

Detailed Description

Callback structure provided by audio format handlers.

All audio formats which utilize the ogg container format define a callback function whose purpose is to extract the meta information about the audio file from the first few ogg packets of the bitstream.

Field Documentation

packet_callback

int(* packet_callback) (ogg_packet *packet, int packet_num, int serial, struct afh_info *afhi, void *private_data)

ogg_get_file_info() calls this function for the first three ogg packets, or until the callback returns a non-positive value.

If it returns negative, the audio file was not recognized by the audio format handler. If it returns zero, the audio file is considered valid, and no further processing by the callback is needed. In this case the header chunk, i.e. chunk number zero, is defined as the concatenation of all packets that have been processed by the callback.

private_data

void* private_data

Data specific to the audio format handler.

---

The documentation for this struct was generated from the following file:

• ogg_afh_common.h