libkate 0.4.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files
- Examples

libkate Documentation

# Introduction

This is the documentation for libkate.

libkate is an implementation of a codec for the Kate bitstream format.

The latest version of libkate may be found at http://libkate.googlecode.com/.

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 here.

The HOWTO page shows how to use Kate streams for various purposes, such as movie subtitles, or song lyrics.

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).

See here for a list of software with Kate support.

A commented high level decoding example.

A commented decoding example.

A commented encoding example.