<!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: Configuration</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><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>Configuration</h1><table border="0" cellpadding="0" cellspacing="0">
</table>
<h2><a class="anchor" id="configure">
./configure</a></h2>
<p>It is possible to customize the functionality of liboggz by using various ./configure flags when building it from source. You can build a smaller version of liboggz to only read or write. By default, both reading and writing support is built.</p>
<p>For general information about using ./configure, see the file <a class="el" href="group__install.html">INSTALL </a></p>
<h3><a class="anchor" id="no_encode">
Removing writing support</a></h3>
<p>Configuring with <em>--disable-write</em> will remove all support for writing:</p>
<ul>
<li>All internal write related functions will not be built</li>
<li>Any attempt to call <a class="el" href="oggz_8h.html#a6eb34d123389ae38d993601f9e7bb9d6" title="Create a new OGGZ object.">oggz_new()</a>, <a class="el" href="oggz_8h.html#a65197cdd03f755f7ebfabf2fdff4c7db" title="Open an Ogg file, creating an OGGZ handle for it.">oggz_open()</a> or <a class="el" href="oggz_8h.html#ac49e9de0bc4ef1d91b43b13605f98b19" title="Create an OGGZ handle associated with a stdio stream.">oggz_open_stdio()</a> with <em>flags</em> == OGGZ_WRITE will fail, returning NULL</li>
<li>Any attempt to call <a class="el" href="group__write__api.html#ga3c97d94ea425d64546adf9c368b71904" title="Write n bytes from an OGGZ handle.">oggz_write()</a>, <a class="el" href="group__write__api.html#ga5606dff01964caec4582eb172fde0c1c" title="Output data from an OGGZ handle.">oggz_write_output()</a>, <a class="el" href="group__write__api.html#ga6ccaceb107db1fd2eae047dbdbaa5889" title="Add a packet to oggz's packet queue.">oggz_write_feed()</a>, <a class="el" href="group__write__api.html#gaf362c030bc7a7f57cb23f2b863a59389" title="Set a callback for Oggz to call when oggz is hungry .">oggz_write_set_hungry_callback()</a>, or <a class="el" href="group__write__api.html#gab25da7d2cbf39585357f2a426d3dba2f" title="Query the number of bytes in the next page to be written.">oggz_write_get_next_page_size()</a> will return OGGZ_ERR_DISABLED</li>
</ul>
<h3><a class="anchor" id="no_decode">
Removing reading support</a></h3>
<p>Configuring with <em>--disable-read</em> will remove all support for reading:</p>
<ul>
<li>All internal reading related functions will not be built</li>
<li>Any attempt to call <a class="el" href="oggz_8h.html#a6eb34d123389ae38d993601f9e7bb9d6" title="Create a new OGGZ object.">oggz_new()</a>, <a class="el" href="oggz_8h.html#a65197cdd03f755f7ebfabf2fdff4c7db" title="Open an Ogg file, creating an OGGZ handle for it.">oggz_open()</a> or <a class="el" href="oggz_8h.html#ac49e9de0bc4ef1d91b43b13605f98b19" title="Create an OGGZ handle associated with a stdio stream.">oggz_open_stdio()</a> with <em>flags</em> == OGGZ_READ will fail, returning NULL</li>
<li>Any attempt to call <a class="el" href="group__read__api.html#ga3ce7a31de5da56375057436c6b5108f2" title="Read n bytes into oggz, calling any read callbacks on the fly.">oggz_read()</a>, <a class="el" href="group__read__api.html#ga77d4158dd119f496f73311ace7f630d6" title="Input data into oggz.">oggz_read_input()</a>, <a class="el" href="group__read__api.html#ga6d5aae4f7f186fffe19d4fd3cd63148d" title="Set a callback for Oggz to call when a new Ogg packet is found in the stream.">oggz_set_read_callback()</a>, <a class="el" href="group__seek__api.html#gaeef4b261d443701207954e5a636d6817" title="Seek to a specific byte offset.">oggz_seek()</a>, or <a class="el" href="group__seek__api.html#ga60bac88ef3695629efacec43a21927e5" title="Seek to an offset in milliseconds, or custom units as specified by a Metric function...">oggz_seek_units()</a> will return OGGZ_ERR_DISABLED </li>
</ul>
</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>