Index of values


B
bos [Ogg.Page]
Indicates whether this page is at the begining of the logical bitstream.

C
continued [Ogg.Page]
Indicates whether this page contains packet data which has been continued from the previous page.
create [Ogg.Stream]
Create a stream.
create [Ogg.Sync]
This function is used to initialize a Sync.t to a known initial value in preparation for manipulation of an Ogg bitstream.
create_from_file [Ogg.Sync]
Wrapper around create to open a file as the ogg stream.

E
eos [Ogg.Skeleton]
Create an end-of-stream packet for an ogg skeleton logical stream
eos [Ogg.Stream]
Returns true if the end of stream has been reached.
eos [Ogg.Page]
Indicates whether this page is at the end of the logical bitstream.

F
fishead [Ogg.Skeleton]
Create an initial ogg skeleton packet ('fishead'), to complete with data packet from the various codecs in the stream ('fishbone').
flush [Ogg.Stream]
flush_page [Ogg.Stream]
This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page.

G
get_packet [Ogg.Stream]
This function assembles a data packet for output to the codec decoding engine.
get_page [Ogg.Stream]
This function forms packets into pages.
granulepos [Ogg.Page]
Returns the exact granular position of the packet data contained at the end of this page.

P
packets [Ogg.Page]
Returns the number of packets that are completed on this page.
pageno [Ogg.Page]
Returns the sequential page number.
pageout [Ogg.Stream]
pagesout [Ogg.Stream]
pagesout_eos [Ogg.Stream]
peek_packet [Ogg.Stream]
This function assembles a data packet for output to the codec decoding engine without advancing the stream.
put_packet [Ogg.Stream]
This function submits a packet to the bitstream for page encapsulation.
put_page [Ogg.Stream]
This function adds a complete page to the bitstream.

R
read [Ogg.Sync]
Read a page from Sync.t
reset [Ogg.Sync]
This function is used to reset the internal counters of the Sync.t to initial values.

S
serialno [Ogg.Stream]
Get a stream's serial number.
serialno [Ogg.Page]
Returns the unique serial number for the logical bitstream of this page.
set_checksum [Ogg.Page]
Checksums an ogg_page.

V
version [Ogg.Page]
This function returns the version of ogg_page used in this page.