module Page:Thesig
..end
page
struct encapsulates the data for an Ogg page.
Ogg pages are the fundamental unit of framing and interleave in an ogg
bitstream. They are made up of packet segments of 255 bytes each. There can
be as many as 255 packet segments per page, for a maximum page size of a
little under 64 kB. This is not a practical limitation as the segments can be
joined across page boundaries allowing packets of arbitrary size. In practice
pages are usually around 4 kB.
typet =
string * string
val serialno : t -> nativeint
val eos : t -> bool
val bos : t -> bool
val continued : t -> bool
val packets : t -> int
If a page consists of a packet begun on a previous page, and a new packet begun (but not completed) on this page, the return will be:
packets page
will return 1
,
continued paged
will return true
If a page happens to be a single packet that was begun on a previous page, and spans to the next page (in the case of a three or more page packet), the return will be:
packets page
will return 0,
continued page
will return true
.
val version : t -> int
0
should always be returned.val granulepos : t -> Int64.t
This is useful for tracking location when seeking or decoding.
For example, in audio codecs this position is the pcm sample number and
in video this is the frame number.
val pageno : t -> nativeint
This is useful for ordering pages or determining when pages have been lost.
val set_checksum : t -> unit