<!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>libkate: 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.1 -->
<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="pages.html"><span>Related Pages</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>libkate Documentation</h1><h3>0.3.7 </h3><h2><a class="anchor" id="Introduction">
Introduction</a></h2>
<p>This is the documentation for libkate.</p>
<p>libkate is an implementation of a codec for the Kate bitstream format.</p>
<p>The latest version of libkate may be found at <<a href="http://libkate.googlecode.com/">http://libkate.googlecode.com/</a>>.</p>
<p>The Kate bitstream format is a timed text codec designed for embedding in an Ogg bitstream. It was originally designed for karaoke and text. The Kate bitstream format is documented <a class="el" href="Format.html">here</a>.</p>
<p>The <a class="el" href="HOWTO.html">HOWTO</a> page shows how to use Kate streams for various purposes, such as movie subtitles, or song lyrics.</p>
<p>libkate is thread safe, with the usual caveat that a single thread may access a given kate stream at the same time (eg, two different threads may use libkate at the same time, provided they access two different streams).</p>
<p>See <a class="el" href="Support.html">here</a> for a list of software with Kate support.</p>
A commented
<a href="high_8c-example.html">high level decoding example</a>.
A commented
<a href="decoding_8c-example.html">decoding example</a>.
A commented
<a href="encoding_8c-example.html">encoding example</a>.
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Dec 23 04:05:07 2009 for libkate by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
