Index of values

A
abort [Ogg_demuxer]

Consume all remaining pages of the current stream.

audio_info [Ogg_demuxer]

Get informations about the audio track.

B
bos [Ogg.Page]

Indicates whether this page is at the begining of the logical bitstream.

C
can_seek [Ogg_demuxer]

Returns true if the decoder can be used with the seek function.

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.

D
decode_audio [Ogg_demuxer]

Decode audio data, if possible.

decode_video [Ogg_demuxer]

Decode video data, if possible.

drop_track [Ogg_demuxer]

Remove all tracks of the given type.

E
eos [Ogg_demuxer]

true if the decoder has reached the end of each logical streams and all data has been decoded.

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_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_ogg_sync [Ogg_demuxer]

Get the Ogg.Sync handler associated to the decoder.

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.

get_position [Ogg_demuxer]

Get absolute position in the stream.

get_standard_tracks [Ogg_demuxer]

Get the first available audio and video tracks and drop the other one.

get_track_position [Ogg_demuxer]

Get track absolute position.

get_tracks [Ogg_demuxer]

Get all decodable tracks available.

granulepos [Ogg.Page]

Returns the exact granular position of the packet data contained at the end of this page.

I
init [Ogg_demuxer]

Initiate a decoder with the given callbacks.

init_from_fd [Ogg_demuxer]

Initate a decoder from a given Unix.file_descriptor

init_from_file [Ogg_demuxer]

Initiate a decoder from a given file name.

O
ogg_decoders [Ogg_demuxer]

Register a new decoder.

P
packet_granulepos [Ogg.Stream]

Returns a packet's granule position.

packets [Ogg.Page]

Returns the number of packets that are completed on this page.

pageno [Ogg.Page]

Returns the sequential page number.

peek_granulepos [Ogg.Stream]

This function picks up the granule position of the next packet in the stream without advancing it.

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_demuxer]

Reset encoder, try to parse a new sequentialized stream.

reset [Ogg.Sync]

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

S
sample_rate [Ogg_demuxer]

Get the sample_rate of the track of that type.

seek [Ogg_demuxer]

Seek to an absolute or relative position in seconds.

seek [Ogg.Sync]

This function synchronizes the ogg_sync_state struct to the next ogg_page.

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.

skip_packet [Ogg.Stream]

This function discards the next packet in the stream.

U
update_standard_tracks [Ogg_demuxer]

Update a given record of standard tracks.

V
version [Ogg.Page]

This function returns the version of ogg_page used in this page.

video_info [Ogg_demuxer]

Get informations about the video track.