<!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: /home/mandrake/rpm/BUILD/libkate-0.3.7/include/kate/oggkate.h File Reference</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><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 class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>/home/mandrake/rpm/BUILD/libkate-0.3.7/include/kate/oggkate.h File Reference</h1><code>#include <stddef.h></code><br/>
<code>#include <stdint.h></code><br/>
<code>#include <ogg/ogg.h></code><br/>
<code>#include "<a class="el" href="kate_8h_source.html">kate/kate.h</a>"</code><br/>
<p><a href="oggkate_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#ac9f5a00fc71e781a8c18bccb12c3f9f7">kate_ogg_encode_headers</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="structkate__comment.html">kate_comment</a> *kc, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#aa66db5293b6c4afa2fbbf536d0d1e4dd">kate_ogg_encode_text</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float start_time, kate_float stop_time, const char *text, size_t sz, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#ac42f22888e1bce25470f87b4755d193f">kate_ogg_encode_text_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t start_time, kate_int64_t stop_time, const char *text, size_t sz, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a629373fe1cd3e95b034eb80ed052f81f">kate_ogg_encode_repeat</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float t, kate_float threshold, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a2c9ad275ed12b8b7d18bdcd5f23e9c6c">kate_ogg_encode_repeat_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t t, kate_int64_t threshold, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a988aae105909e4ce28916e8ba53f7926">kate_ogg_encode_keepalive</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float t, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a53b3e5069d5e54a1c51a31daf4391208">kate_ogg_encode_keepalive_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t t, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a28a9b117b4051ed02c761f279d5c34ee">kate_ogg_encode_finish</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float t, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a733dd994159e7349d26d25debc27aaee">kate_ogg_encode_finish_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t t, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a76fb6b637e8608f2c1f482d72e8f04de">kate_ogg_decode_is_idheader</a> (const ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#ad9a723eff7f66cadae79719d09aebd4d">kate_ogg_decode_headerin</a> (<a class="el" href="structkate__info.html">kate_info</a> *ki, <a class="el" href="structkate__comment.html">kate_comment</a> *kc, ogg_packet *op)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggkate_8h.html#a66a5a414cf4ad9b094b27a78c00e83a7">kate_ogg_decode_packetin</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, ogg_packet *op)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The libkate Ogg interface public API. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ad9a723eff7f66cadae79719d09aebd4d"></a><!-- doxytag: member="oggkate.h::kate_ogg_decode_headerin" ref="ad9a723eff7f66cadae79719d09aebd4d" args="(kate_info *ki, kate_comment *kc, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_decode_headerin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"> <em>ki</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__comment.html">kate_comment</a> * </td>
<td class="paramname"> <em>kc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decodes a Kate header </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ki</em> </td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure to fill from headers </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kc</em> </td><td>the <a class="el" href="structkate__comment.html">kate_comment</a> structure to fill from headers </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to test </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
1 success, and all headers have been decoded </dd>
<dd>
KATE_E_* error </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="decoding_8c-example.html#a6">decoding.c</a>.</dd>
</dl>
<p>References <a class="el" href="kate__decode_8c_source.html#l00950">kate_decode_headerin()</a>, <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>, and <a class="el" href="kate__ogg_8c_source.html#l00240">kate_ogg_decode_headerin()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00240">kate_ogg_decode_headerin()</a>.</p>
</div>
</div>
<a class="anchor" id="a76fb6b637e8608f2c1f482d72e8f04de"></a><!-- doxytag: member="oggkate.h::kate_ogg_decode_is_idheader" ref="a76fb6b637e8608f2c1f482d72e8f04de" args="(const ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_decode_is_idheader </td>
<td>(</td>
<td class="paramtype">const ogg_packet * </td>
<td class="paramname"> <em>op</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks whether an Ogg packet contains a Kate identification header. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to test </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 success, and the packet contains a Kate identification header </dd>
<dd>
0 success, and the packet does not contain a Kate identification header </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate__decode_8c_source.html#l00174">kate_decode_is_idheader()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00222">kate_ogg_decode_is_idheader()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00222">kate_ogg_decode_is_idheader()</a>.</p>
</div>
</div>
<a class="anchor" id="a66a5a414cf4ad9b094b27a78c00e83a7"></a><!-- doxytag: member="oggkate.h::kate_ogg_decode_packetin" ref="a66a5a414cf4ad9b094b27a78c00e83a7" args="(kate_state *k, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_decode_packetin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decodes a Kate data packet </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to decode a packet for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to test </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
1 success, and we're at end of stream </dd>
<dd>
KATE_E_* error </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="decoding_8c-example.html#a8">decoding.c</a>.</dd>
</dl>
<p>References <a class="el" href="kate__decode_8c_source.html#l01421">kate_decode_packetin()</a>, <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>, and <a class="el" href="kate__ogg_8c_source.html#l00256">kate_ogg_decode_packetin()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00256">kate_ogg_decode_packetin()</a>.</p>
</div>
</div>
<a class="anchor" id="a28a9b117b4051ed02c761f279d5c34ee"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_finish" ref="a28a9b117b4051ed02c761f279d5c34ee" args="(kate_state *k, kate_float t, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_finish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes an end-of-stream data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. No other packet may be encoded afer an end of stream packet is encoded. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the time at which to insert the packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="encoding_8c-example.html#a11">encoding.c</a>.</dd>
</dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l01181">kate_encode_finish()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00187">kate_ogg_encode_finish()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00187">kate_ogg_encode_finish()</a>.</p>
</div>
</div>
<a class="anchor" id="a733dd994159e7349d26d25debc27aaee"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_finish_raw_times" ref="a733dd994159e7349d26d25debc27aaee" args="(kate_state *k, kate_int64_t t, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_finish_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes an end-of-stream data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. No other packet may be encoded afer an end of stream packet is encoded. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the time at which to insert the packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l01134">kate_encode_finish_raw_times()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00206">kate_ogg_encode_finish_raw_times()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00206">kate_ogg_encode_finish_raw_times()</a>.</p>
</div>
</div>
<a class="anchor" id="ac9f5a00fc71e781a8c18bccb12c3f9f7"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_headers" ref="ac9f5a00fc71e781a8c18bccb12c3f9f7" args="(kate_state *k, kate_comment *kc, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_headers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__comment.html">kate_comment</a> * </td>
<td class="paramname"> <em>kc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a Kate header to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kc</em> </td><td>the comments to encode in headers </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode headers to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
1 success, and all headers have been encoded </dd>
<dd>
KATE_E_* error </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="encoding_8c-example.html#a9">encoding.c</a>.</dd>
</dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l01199">kate_encode_headers()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00049">kate_ogg_encode_headers()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00049">kate_ogg_encode_headers()</a>.</p>
</div>
</div>
<a class="anchor" id="a988aae105909e4ce28916e8ba53f7926"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_keepalive" ref="a988aae105909e4ce28916e8ba53f7926" args="(kate_state *k, kate_float t, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_keepalive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a keepalive data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the time at which to insert the keepalive packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l01042">kate_encode_keepalive()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00150">kate_ogg_encode_keepalive()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00150">kate_ogg_encode_keepalive()</a>.</p>
</div>
</div>
<a class="anchor" id="a53b3e5069d5e54a1c51a31daf4391208"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_keepalive_raw_times" ref="a53b3e5069d5e54a1c51a31daf4391208" args="(kate_state *k, kate_int64_t t, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_keepalive_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a keepalive data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the time at which to insert the keepalive packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l00996">kate_encode_keepalive_raw_times()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00168">kate_ogg_encode_keepalive_raw_times()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00168">kate_ogg_encode_keepalive_raw_times()</a>.</p>
</div>
</div>
<a class="anchor" id="a629373fe1cd3e95b034eb80ed052f81f"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_repeat" ref="a629373fe1cd3e95b034eb80ed052f81f" args="(kate_state *k, kate_float t, kate_float threshold, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_repeat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>threshold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a repeat data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the time at which to insert the repeat packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>threshold</em> </td><td>the minimum age an active event must be for a repeat packet to be encoded </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success, and no repeat packets were needed </dd>
<dd>
1 success, and a repeat packet was encoded </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l01117">kate_encode_repeat()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00112">kate_ogg_encode_repeat()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00112">kate_ogg_encode_repeat()</a>.</p>
</div>
</div>
<a class="anchor" id="a2c9ad275ed12b8b7d18bdcd5f23e9c6c"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_repeat_raw_times" ref="a2c9ad275ed12b8b7d18bdcd5f23e9c6c" args="(kate_state *k, kate_int64_t t, kate_int64_t threshold, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_repeat_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>threshold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a repeat data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the time at which to insert the repeat packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>threshold</em> </td><td>the minimum age an active event must be for a repeat packet to be encoded </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success, and no repeat packets were needed </dd>
<dd>
1 success, and a repeat packet was encoded </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l01066">kate_encode_repeat_raw_times()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00132">kate_ogg_encode_repeat_raw_times()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00132">kate_ogg_encode_repeat_raw_times()</a>.</p>
</div>
</div>
<a class="anchor" id="aa66db5293b6c4afa2fbbf536d0d1e4dd"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_text" ref="aa66db5293b6c4afa2fbbf536d0d1e4dd" args="(kate_state *k, kate_float start_time, kate_float stop_time, const char *text, size_t sz, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>start_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>stop_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a text data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>start_time</em> </td><td>the start time, in seconds, of the event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stop_time</em> </td><td>the stop time, in seconds, of the event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>the text this event will hold (may be empty if none) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sz</em> </td><td>the size, in bytes, of the text </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="encoding_8c-example.html#a10">encoding.c</a>.</dd>
</dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l00981">kate_encode_text()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00071">kate_ogg_encode_text()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00071">kate_ogg_encode_text()</a>.</p>
</div>
</div>
<a class="anchor" id="ac42f22888e1bce25470f87b4755d193f"></a><!-- doxytag: member="oggkate.h::kate_ogg_encode_text_raw_times" ref="ac42f22888e1bce25470f87b4755d193f" args="(kate_state *k, kate_int64_t start_time, kate_int64_t stop_time, const char *text, size_t sz, ogg_packet *op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_ogg_encode_text_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>start_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>stop_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_packet * </td>
<td class="paramname"> <em>op</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a text data packet to an Ogg packet The <a class="el" href="structkate__state.html">kate_state</a> structure should have been initialized with kate_decode_init or kate_encode_init. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to encode headers for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>start_time</em> </td><td>the start time, in seconds, of the event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stop_time</em> </td><td>the stop time, in seconds, of the event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>the text this event will hold (may be empty if none) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sz</em> </td><td>the size, in bytes, of the text </td></tr>
<tr><td valign="top"></td><td valign="top"><em>op</em> </td><td>the ogg_packet to encode the packet to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate__encode_8c_source.html#l00878">kate_encode_text_raw_times()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00092">kate_ogg_encode_text_raw_times()</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00092">kate_ogg_encode_text_raw_times()</a>.</p>
</div>
</div>
</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>
