ref: dafeccd380113e60476156b40635acf1b1f21c25
parent: eedbee8d8241e35867f7e88c53b7b6bd6d5f493a
author: Nikita Kogut <glinka1202@gmail.com>
date: Tue Jan 14 16:38:02 EST 2025
Clarify return value for decode() functions Signed-off-by: Jean-Marc Valin <jeanmarcv@google.com>
--- a/include/opus.h
+++ b/include/opus.h
@@ -508,7 +508,7 @@
* FEC cases, frame_size <b>must</b> be a multiple of 2.5 ms.
* @param [in] decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band forward error correction data be
* decoded. If no such data is available, the frame is decoded as if it were lost.
- * @returns Number of decoded samples or @ref opus_errorcodes
+ * @returns Number of decoded samples per channel or @ref opus_errorcodes
*/
OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode(
OpusDecoder *st,
@@ -558,7 +558,7 @@
* FEC cases, frame_size <b>must</b> be a multiple of 2.5 ms.
* @param [in] decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band forward error correction data be
* decoded. If no such data is available the frame is decoded as if it were lost.
- * @returns Number of decoded samples or @ref opus_errorcodes
+ * @returns Number of decoded samples per channel or @ref opus_errorcodes
*/
OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode_float(
OpusDecoder *st,
--
⑨