claunia/flac
1
0
Fork 0
mirror of https://github.com/claunia/flac.git synced 2025-12-16 18:54:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

document some new functions

Browse Source
This commit is contained in:
Josh Coalson
2002-11-19 06:21:36 +00:00
parent 5d86e18cd2
commit dc386e1bd7
5 changed files with 82 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/FLAC/stream_encoder.h
View File

@@ -745,7 +745,17 @@ FLAC_API FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__Str
*/
FLAC_API FLAC__StreamDecoderState FLAC__stream_encoder_get_verify_decoder_state(const FLAC__StreamEncoder *encoder);
/*@@@@ document */
/** Get the current encoder state as a C string.
* This version automatically resolves
* \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR by getting the
* verify decoder's state.
*
* \param encoder A encoder instance to query.
* \assert
* \code encoder != NULL \endcode
* \retval const char *
* The encoder state as a C string. Do not modify the contents.
*/
FLAC_API const char *FLAC__stream_encoder_get_resolved_state_string(const FLAC__StreamEncoder *encoder);
/** Get relevant values about the nature of a verify decoder error.