oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

decoder: updated API documentation

Browse Source 
Updated documentation on the stream_decode() and file_decode() return
values.
This commit is contained in:
Max Kellermann
2008-11-09 22:10:48 +01:00
parent ab24e203cd
commit c9c7dc6e00
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/decoder_api.h
View File

@@ -70,7 +70,9 @@ struct decoder_plugin {
* this will be used to decode InputStreams, and is * this will be used to decode InputStreams, and is
* recommended for files and networked (HTTP) connections. * recommended for files and networked (HTTP) connections.
* *
* returns false on error, true on success * @return false if the plugin cannot decode the stream, and
* true if it was able to do so (even if an error occured
* during playback)
*/ */
bool (*stream_decode)(struct decoder *, struct input_stream *); bool (*stream_decode)(struct decoder *, struct input_stream *);
@@ -79,7 +81,9 @@ struct decoder_plugin {
* a filename or handle as input, and will not allow callbacks * a filename or handle as input, and will not allow callbacks
* to be set (like Ogg-Vorbis and FLAC libraries allow) * to be set (like Ogg-Vorbis and FLAC libraries allow)
* *
* returns -1 on error, 0 on success * @return false if the plugin cannot decode the file, and
* true if it was able to do so (even if an error occured
* during playback)
*/ */
bool (*file_decode)(struct decoder *, const char *path); bool (*file_decode)(struct decoder *, const char *path);