|
libkate 0.4.3
|
Go to the source code of this file.
Functions | |
| int | kate_ogg_encode_headers (kate_state *k, kate_comment *kc, ogg_packet *op) |
| int | kate_ogg_encode_text (kate_state *k, kate_float start_time, kate_float stop_time, const char *text, size_t sz, ogg_packet *op) |
| int | kate_ogg_encode_text_raw_times (kate_state *k, kate_int64_t start_time, kate_int64_t stop_time, const char *text, size_t sz, ogg_packet *op) |
| int | kate_ogg_encode_repeat (kate_state *k, kate_float t, kate_float threshold, ogg_packet *op) |
| int | kate_ogg_encode_repeat_raw_times (kate_state *k, kate_int64_t t, kate_int64_t threshold, ogg_packet *op) |
| int | kate_ogg_encode_keepalive (kate_state *k, kate_float t, ogg_packet *op) |
| int | kate_ogg_encode_keepalive_raw_times (kate_state *k, kate_int64_t t, ogg_packet *op) |
| int | kate_ogg_encode_finish (kate_state *k, kate_float t, ogg_packet *op) |
| int | kate_ogg_encode_finish_raw_times (kate_state *k, kate_int64_t t, ogg_packet *op) |
| int | kate_ogg_decode_is_idheader (const ogg_packet *op) |
| int | kate_ogg_decode_headerin (kate_info *ki, kate_comment *kc, ogg_packet *op) |
| int | kate_ogg_decode_packetin (kate_state *k, ogg_packet *op) |
The libkate Ogg interface public API.
| int kate_ogg_decode_headerin | ( | kate_info * | ki, |
| kate_comment * | kc, | ||
| ogg_packet * | op | ||
| ) |
Decodes a Kate header
| ki | the kate_info structure to fill from headers |
| kc | the kate_comment structure to fill from headers |
| op | the ogg_packet to test |
References kate_decode_headerin(), and KATE_E_INVALID_PARAMETER.
| int kate_ogg_decode_is_idheader | ( | const ogg_packet * | op | ) |
Checks whether an Ogg packet contains a Kate identification header.
| op | the ogg_packet to test |
References kate_decode_is_idheader().
| int kate_ogg_decode_packetin | ( | kate_state * | k, |
| ogg_packet * | op | ||
| ) |
Decodes a Kate data packet
| k | the kate_state structure to decode a packet for |
| op | the ogg_packet to test |
References kate_decode_packetin(), and KATE_E_INVALID_PARAMETER.
| int kate_ogg_encode_finish | ( | kate_state * | k, |
| kate_float | t, | ||
| ogg_packet * | op | ||
| ) |
Encodes an end-of-stream data packet to an Ogg packet The kate_state 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.
| k | the kate_state structure to encode headers for |
| t | the time at which to insert the packet |
| op | the ogg_packet to encode the packet to |
References kate_encode_finish().
| int kate_ogg_encode_finish_raw_times | ( | kate_state * | k, |
| kate_int64_t | t, | ||
| ogg_packet * | op | ||
| ) |
Encodes an end-of-stream data packet to an Ogg packet The kate_state 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.
| k | the kate_state structure to encode headers for |
| t | the time at which to insert the packet |
| op | the ogg_packet to encode the packet to |
References kate_encode_finish_raw_times().
| int kate_ogg_encode_headers | ( | kate_state * | k, |
| kate_comment * | kc, | ||
| ogg_packet * | op | ||
| ) |
Encodes a Kate header to an Ogg packet The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
| k | the kate_state structure to encode headers for |
| kc | the comments to encode in headers |
| op | the ogg_packet to encode headers to |
References kate_encode_headers().
| int kate_ogg_encode_keepalive | ( | kate_state * | k, |
| kate_float | t, | ||
| ogg_packet * | op | ||
| ) |
Encodes a keepalive data packet to an Ogg packet The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
| k | the kate_state structure to encode headers for |
| t | the time at which to insert the keepalive packet |
| op | the ogg_packet to encode the packet to |
References kate_encode_keepalive().
| int kate_ogg_encode_keepalive_raw_times | ( | kate_state * | k, |
| kate_int64_t | t, | ||
| ogg_packet * | op | ||
| ) |
Encodes a keepalive data packet to an Ogg packet The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
| k | the kate_state structure to encode headers for |
| t | the time at which to insert the keepalive packet |
| op | the ogg_packet to encode the packet to |
References kate_encode_keepalive_raw_times().
| int kate_ogg_encode_repeat | ( | kate_state * | k, |
| kate_float | t, | ||
| kate_float | threshold, | ||
| ogg_packet * | op | ||
| ) |
Encodes a repeat data packet to an Ogg packet The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
| k | the kate_state structure to encode headers for |
| t | the time at which to insert the repeat packet |
| threshold | the minimum age an active event must be for a repeat packet to be encoded |
| op | the ogg_packet to encode the packet to |
References kate_encode_repeat().
| int kate_ogg_encode_repeat_raw_times | ( | kate_state * | k, |
| kate_int64_t | t, | ||
| kate_int64_t | threshold, | ||
| ogg_packet * | op | ||
| ) |
Encodes a repeat data packet to an Ogg packet The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
| k | the kate_state structure to encode headers for |
| t | the time at which to insert the repeat packet |
| threshold | the minimum age an active event must be for a repeat packet to be encoded |
| op | the ogg_packet to encode the packet to |
References kate_encode_repeat_raw_times().
| int kate_ogg_encode_text | ( | kate_state * | k, |
| kate_float | start_time, | ||
| kate_float | stop_time, | ||
| const char * | text, | ||
| size_t | sz, | ||
| ogg_packet * | op | ||
| ) |
Encodes a text data packet to an Ogg packet The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
| k | the kate_state structure to encode headers for |
| start_time | the start time, in seconds, of the event |
| stop_time | the stop time, in seconds, of the event |
| text | the text this event will hold (may be empty if none) |
| sz | the size, in bytes, of the text |
| op | the ogg_packet to encode the packet to |
References kate_encode_text().
| int kate_ogg_encode_text_raw_times | ( | kate_state * | k, |
| kate_int64_t | start_time, | ||
| kate_int64_t | stop_time, | ||
| const char * | text, | ||
| size_t | sz, | ||
| ogg_packet * | op | ||
| ) |
Encodes a text data packet to an Ogg packet The kate_state structure should have been initialized with kate_decode_init or kate_encode_init.
| k | the kate_state structure to encode headers for |
| start_time | the start time, in seconds, of the event |
| stop_time | the stop time, in seconds, of the event |
| text | the text this event will hold (may be empty if none) |
| sz | the size, in bytes, of the text |
| op | the ogg_packet to encode the packet to |
References kate_encode_text_raw_times().