diff options
author | Alexander Chemeris <alexander.chemeris@gmail.com> | 2009-07-08 08:29:03 +0400 |
---|---|---|
committer | Jean-Marc Valin <jean-marc.valin@usherbrooke.ca> | 2009-07-08 08:29:03 +0400 |
commit | a6d05eb5ff9d5062852cdf7df574bec728921ef9 (patch) | |
tree | 37a7da368b32b3bae6b44cd114e05fddd2b02c3e | |
parent | 74fd97fd08a498f01ba8f30d0d5b4c8aa4c3a587 (diff) |
Better Doxygen comments on latency
-rw-r--r-- | include/speex/speex.h | 3 | ||||
-rw-r--r-- | include/speex/speex_resampler.h | 4 |
2 files changed, 4 insertions, 3 deletions
diff --git a/include/speex/speex.h b/include/speex/speex.h index 5fc38c7..157e7aa 100644 --- a/include/speex/speex.h +++ b/include/speex/speex.h @@ -142,7 +142,8 @@ extern "C" { #define SPEEX_GET_SUBMODE_ENCODING 37 /*#define SPEEX_SET_LOOKAHEAD 38*/ -/** Returns the lookahead used by Speex */ +/** Returns the lookahead used by Speex separately for an encoder and a decoder. + * Sum encoder and decoder lookahead values to get the total codec lookahead. */ #define SPEEX_GET_LOOKAHEAD 39 /** Sets tuning for packet-loss concealment (expected loss rate) */ diff --git a/include/speex/speex_resampler.h b/include/speex/speex_resampler.h index eb51d42..4d5913f 100644 --- a/include/speex/speex_resampler.h +++ b/include/speex/speex_resampler.h @@ -306,12 +306,12 @@ void speex_resampler_set_output_stride(SpeexResamplerState *st, void speex_resampler_get_output_stride(SpeexResamplerState *st, spx_uint32_t *stride); -/** Get the latency in input samples introduced by the resampler. +/** Get the latency introduced by the resampler measured in input samples. * @param st Resampler state */ int speex_resampler_get_input_latency(SpeexResamplerState *st); -/** Get the latency in output samples introduced by the resampler. +/** Get the latency introduced by the resampler measured in output samples. * @param st Resampler state */ int speex_resampler_get_output_latency(SpeexResamplerState *st); |