Update documentation for TH_ENCCTL_SET_BITRATE.
authorTim Terriberry <tterribe@xiph.org>
Tue, 3 May 2011 01:48:58 +0000 (01:48 +0000)
committerTim Terriberry <tterribe@xiph.org>
Tue, 3 May 2011 01:48:58 +0000 (01:48 +0000)
Make a note that passing 0 for the bitrate may not be guaranteed to
 return an error in future versions.

svn path=/trunk/theora/; revision=17949

include/theora/theoraenc.h

index 1d285ae..79b1c2b 100644 (file)
@@ -330,7 +330,11 @@ extern "C" {
  * \retval 0             Success.
  * \retval TH_EFAULT     \a _enc or \a _buf is <tt>NULL</tt>.
  * \retval TH_EINVAL     The target bitrate was not positive.
- * \retval TH_EIMPL       Not supported by this implementation.*/
+ *                       A future version of this library may allow passing 0
+ *                        to disabled rate-controlled mode and return to a
+ *                        quality-based mode, in which case this function will
+ *                        not return an error for that value.
+ * \retval TH_EIMPL      Not supported by this implementation.*/
 #define TH_ENCCTL_SET_BITRATE (30)
 /**Sets the configuration to be compatible with that from the given setup
  *  header.