<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Ogg" rel="Chapter" href="Ogg.html">
<link title="Ogg_demuxer" rel="Chapter" href="Ogg_demuxer.html"><title>Index of values</title>
</head>
<body>
<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Index of values</h1>
<table>
<tr><td align="left"><br>A</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALabort">abort</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Consume all remaining pages of the current
stream.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALaudio_info">audio_info</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get informations about the
audio track.
</div>
</td></tr>
<tr><td align="left"><br>B</td></tr>
<tr><td><a href="Ogg.Page.html#VALbos">bos</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Indicates whether this page is at the begining of the logical bitstream.
</div>
</td></tr>
<tr><td align="left"><br>C</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALcan_seek">can_seek</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Returns <code class="code">true</code> if the decoder
can be used with the <code class="code">seek</code> function.
</div>
</td></tr>
<tr><td><a href="Ogg.Page.html#VALcontinued">continued</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Indicates whether this page contains packet data which has been
continued from the previous page.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALcreate">create</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
Create a <code class="code">stream</code>.
</div>
</td></tr>
<tr><td><a href="Ogg.Sync.html#VALcreate">create</a> [<a href="Ogg.Sync.html">Ogg.Sync</a>]</td>
<td><div class="info">
This function is used to initialize a <code class="code">Sync.t</code> to a known initial value
in preparation for manipulation of an Ogg bitstream.
</div>
</td></tr>
<tr><td><a href="Ogg.Sync.html#VALcreate_from_file">create_from_file</a> [<a href="Ogg.Sync.html">Ogg.Sync</a>]</td>
<td><div class="info">
Wrapper around <code class="code">create</code> to open a file as the ogg stream.
</div>
</td></tr>
<tr><td align="left"><br>D</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALdecode_audio">decode_audio</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Decode audio data, if possible.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALdecode_video">decode_video</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Decode video data, if possible.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALdrop_track">drop_track</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Remove all tracks of the given type.
</div>
</td></tr>
<tr><td align="left"><br>E</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALeos">eos</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
<code class="code">true</code> if the decoder has reached the end of each
logical streams and all data has been decoded.
</div>
</td></tr>
<tr><td><a href="Ogg.Skeleton.html#VALeos">eos</a> [<a href="Ogg.Skeleton.html">Ogg.Skeleton</a>]</td>
<td><div class="info">
Create an end-of-stream packet for
an ogg skeleton logical stream
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALeos">eos</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
Returns true if the end of stream has been reached.
</div>
</td></tr>
<tr><td><a href="Ogg.Page.html#VALeos">eos</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Indicates whether this page is at the end of the logical bitstream.
</div>
</td></tr>
<tr><td align="left"><br>F</td></tr>
<tr><td><a href="Ogg.Skeleton.html#VALfishead">fishead</a> [<a href="Ogg.Skeleton.html">Ogg.Skeleton</a>]</td>
<td><div class="info">
Create an initial ogg skeleton packet ('fishead'),
to complete with data packet from the various codecs
in the stream ('fishbone').
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALflush">flush</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td></td></tr>
<tr><td><a href="Ogg.Stream.html#VALflush_page">flush_page</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function checks for remaining packets inside the stream and forces
remaining packets into a page, regardless of the size of the page.
</div>
</td></tr>
<tr><td align="left"><br>G</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALget_ogg_sync">get_ogg_sync</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get the Ogg.Sync handler associated to
the decoder.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALget_packet">get_packet</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function assembles a data packet for output
to the codec decoding engine.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALget_page">get_page</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function forms packets into pages.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALget_position">get_position</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get absolute position in the stream.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALget_standard_tracks">get_standard_tracks</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get the first available audio and
video tracks and drop the other one.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALget_track_position">get_track_position</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get track absolute position.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALget_tracks">get_tracks</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get all decodable tracks available.
</div>
</td></tr>
<tr><td><a href="Ogg.Page.html#VALgranulepos">granulepos</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Returns the exact granular position of the packet data contained at the end of this page.
</div>
</td></tr>
<tr><td align="left"><br>I</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALinit">init</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Initiate a decoder with the given callbacks.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALinit_from_fd">init_from_fd</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Initate a decoder from a given <code class="code">Unix.file_descriptor</code>
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALinit_from_file">init_from_file</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Initiate a decoder from a given file name.
</div>
</td></tr>
<tr><td align="left"><br>O</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALogg_decoders">ogg_decoders</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Register a new decoder.
</div>
</td></tr>
<tr><td align="left"><br>P</td></tr>
<tr><td><a href="Ogg.Stream.html#VALpacket_granulepos">packet_granulepos</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
Returns a packet's granule position.
</div>
</td></tr>
<tr><td><a href="Ogg.Page.html#VALpackets">packets</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Returns the number of packets that are completed on this page.
</div>
</td></tr>
<tr><td><a href="Ogg.Page.html#VALpageno">pageno</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Returns the sequential page number.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALpageout">pageout</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td></td></tr>
<tr><td><a href="Ogg.Stream.html#VALpagesout">pagesout</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td></td></tr>
<tr><td><a href="Ogg.Stream.html#VALpagesout_eos">pagesout_eos</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td></td></tr>
<tr><td><a href="Ogg.Stream.html#VALpeek_granulepos">peek_granulepos</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function picks up the granule position
of the next packet in the stream without advancing it.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALpeek_packet">peek_packet</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function assembles a data packet for output
to the codec decoding engine without advancing the stream.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALput_packet">put_packet</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function submits a packet to the bitstream for page encapsulation.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALput_page">put_page</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function adds a complete page to the bitstream.
</div>
</td></tr>
<tr><td align="left"><br>R</td></tr>
<tr><td><a href="Ogg.Sync.html#VALread">read</a> [<a href="Ogg.Sync.html">Ogg.Sync</a>]</td>
<td><div class="info">
Read a page from <code class="code">Sync.t</code>
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALreset">reset</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Reset encoder, try to parse a new sequentialized stream.
</div>
</td></tr>
<tr><td><a href="Ogg.Sync.html#VALreset">reset</a> [<a href="Ogg.Sync.html">Ogg.Sync</a>]</td>
<td><div class="info">
This function is used to reset the internal counters of the
<code class="code">Sync.t</code> to initial values.
</div>
</td></tr>
<tr><td align="left"><br>S</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALsample_rate">sample_rate</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get the sample_rate of the track
of that type.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALseek">seek</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Seek to an absolute or relative position in seconds.
</div>
</td></tr>
<tr><td><a href="Ogg.Sync.html#VALseek">seek</a> [<a href="Ogg.Sync.html">Ogg.Sync</a>]</td>
<td><div class="info">
This function synchronizes the ogg_sync_state struct to the next ogg_page.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALserialno">serialno</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
Get a stream's serial number.
</div>
</td></tr>
<tr><td><a href="Ogg.Page.html#VALserialno">serialno</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Returns the unique serial number for the logical bitstream of this page.
</div>
</td></tr>
<tr><td><a href="Ogg.Page.html#VALset_checksum">set_checksum</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
Checksums an ogg_page.
</div>
</td></tr>
<tr><td><a href="Ogg.Stream.html#VALskip_packet">skip_packet</a> [<a href="Ogg.Stream.html">Ogg.Stream</a>]</td>
<td><div class="info">
This function discards the next packet in the stream.
</div>
</td></tr>
<tr><td align="left"><br>U</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALupdate_standard_tracks">update_standard_tracks</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Update a given record of standard tracks.
</div>
</td></tr>
<tr><td align="left"><br>V</td></tr>
<tr><td><a href="Ogg.Page.html#VALversion">version</a> [<a href="Ogg.Page.html">Ogg.Page</a>]</td>
<td><div class="info">
This function returns the version of ogg_page used in this page.
</div>
</td></tr>
<tr><td><a href="Ogg_demuxer.html#VALvideo_info">video_info</a> [<a href="Ogg_demuxer.html">Ogg_demuxer</a>]</td>
<td><div class="info">
Get informations about the
video track.
</div>
</td></tr>
</table>
</body>
</html>
