<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>liboggz: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>liboggz Documentation</h1><h3 class="version">1.0.1 </h3><h2><a class="anchor" id="intro">
Oggz makes programming with Ogg easy!</a></h2>
<p>This is the documentation for the Oggz C API. Oggz provides a simple programming interface for reading and writing Ogg files and streams. Ogg is an interleaving data container developed by Monty at <a href="http://www.xiph.org/">Xiph.Org</a>, originally to support the Ogg Vorbis audio format.</p>
<p>liboggz supports the flexibility afforded by the Ogg file format while presenting the following API niceties:</p>
<ul>
<li>Strict adherence to the formatting requirements of Ogg <a class="el" href="group__basics.html">bitstreams </a>, to ensure that only valid bitstreams are generated</li>
<li>A simple, callback based open/read/close or open/write/close <a class="el" href="oggz_8h.html">interface </a> to raw Ogg files</li>
<li>A customisable <a class="el" href="group__seek__api.html">seeking </a> abstraction for seeking on multitrack Ogg data</li>
<li>A packet queue for feeding incoming packets for writing, with callback based notification when this queue is empty</li>
<li>A means of overriding the <a class="el" href="oggz__io_8h.html">IO functions </a> used by Oggz, for easier integration with media frameworks and similar systems.</li>
<li>A handy <a class="el" href="oggz__table_8h.html">table </a> structure for storing information on each logical bitstream</li>
</ul>
<h3><a class="anchor" id="contents">
Contents</a></h3>
<ul>
<li><a class="el" href="group__basics.html">Basics </a>: Information about Ogg required to understand liboggz</li>
</ul>
<ul>
<li><a class="el" href="oggz_8h.html">oggz.h </a>: Documentation of the Oggz C API</li>
</ul>
<ul>
<li><a class="el" href="group__configuration.html">Configuration </a>: Customizing liboggz to only read or write.</li>
</ul>
<ul>
<li><a class="el" href="group__building.html">Building </a>: Information related to building software that uses liboggz.</li>
</ul>
<h2><a class="anchor" id="Licensing">
Licensing</a></h2>
<p>liboggz is provided under the following BSD-style open source license:</p>
<div class="fragment"><pre class="fragment"></pre></div> </div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Apr 24 09:13:55 2010 for liboggz by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>