summaryrefslogtreecommitdiff
path: root/include/opus.h
diff options
context:
space:
mode:
authorGregory Maxwell <greg@xiph.org>2012-05-16 20:00:32 -0400
committerJean-Marc Valin <jmvalin@jmvalin.ca>2012-05-17 19:45:28 -0400
commitfdd0c52b40e6042adb6316b92ef2efe1cc2ad18a (patch)
tree9af79069e84a2480c8f99129431fef35ee98f3e6 /include/opus.h
parent8858cac6bc904a5972b26678194b81c0eedee2fe (diff)
downloadopus-fdd0c52b40e6042adb6316b92ef2efe1cc2ad18a.tar.gz
Minor doc improvement wrt OPUS_APPLICATION_RESTRICTED_LOWDELAY.
Diffstat (limited to 'include/opus.h')
-rw-r--r--include/opus.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/include/opus.h b/include/opus.h
index 93f44588..539a172f 100644
--- a/include/opus.h
+++ b/include/opus.h
@@ -179,6 +179,8 @@ OPUS_EXPORT int opus_encoder_get_size(int channels);
*
* @ref OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that
* disables the speech-optimized mode in exchange for slightly reduced delay.
+ * This mode can only be set on an newly initialized or freshly reset encoder
+ * because it changes the codec delay.
*
* This is useful when the caller knows that the speech-optimized modes will not be needed (use with caution).
* @param [in] Fs <tt>opus_int32</tt>: Sampling rate of input signal (Hz)