Skip to content
Snippets Groups Projects
Commit b86b5376 authored by Timothy B. Terriberry's avatar Timothy B. Terriberry
Browse files

Update documentation for TH_ENCCTL_SET_BITRATE.

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
parent 486d4bdb
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment