Module Ogg.Sync

module Sync: sig .. end

type t 

val create : (int -> string * int) -> t

This function is used to initialize a Sync.t to a known initial value in preparation for manipulation of an Ogg bitstream.

The function passed is used to fill the stream with new data. It receives a number of bytes to read and returns a string read and its size.

val create_from_file : string -> t * Unix.file_descr

Wrapper around create to open a file as the ogg stream.

val read : t -> Ogg.Page.t

Read a page from Sync.t

Raises Not_enough_data if the reading function returned an empty string.

val reset : ?read_func:(int -> string * int) -> t -> unit

This function is used to reset the internal counters of the Sync.t to initial values.

read_func is optional and is a new function to read new data.