decoder/sndfile, ...: update API documentation
This commit is contained in:
parent
e2e66404d5
commit
eb1733609a
@ -53,7 +53,7 @@ struct DecoderPlugin {
|
|||||||
void (*finish)(void);
|
void (*finish)(void);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Decode a stream (data read from an #input_stream object).
|
* Decode a stream (data read from an #InputStream object).
|
||||||
*
|
*
|
||||||
* Either implement this method or file_decode(). If
|
* Either implement this method or file_decode(). If
|
||||||
* possible, it is recommended to implement this method,
|
* possible, it is recommended to implement this method,
|
||||||
|
@ -60,14 +60,14 @@ decoder_command_finished_locked(DecoderControl &dc)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Opens the input stream with input_stream::Open(), and waits until
|
* Opens the input stream with InputStream::Open(), and waits until
|
||||||
* the stream gets ready. If a decoder STOP command is received
|
* the stream gets ready. If a decoder STOP command is received
|
||||||
* during that, it cancels the operation (but does not close the
|
* during that, it cancels the operation (but does not close the
|
||||||
* stream).
|
* stream).
|
||||||
*
|
*
|
||||||
* Unlock the decoder before calling this function.
|
* Unlock the decoder before calling this function.
|
||||||
*
|
*
|
||||||
* @return an input_stream on success or if #DecoderCommand::STOP is
|
* @return an InputStream on success or if #DecoderCommand::STOP is
|
||||||
* received, nullptr on error
|
* received, nullptr on error
|
||||||
*/
|
*/
|
||||||
static InputStream *
|
static InputStream *
|
||||||
|
@ -48,7 +48,7 @@ DsdId::Equals(const char *s) const
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Skip the #input_stream to the specified offset.
|
* Skip the #InputStream to the specified offset.
|
||||||
*/
|
*/
|
||||||
bool
|
bool
|
||||||
dsdlib_skip_to(Decoder *decoder, InputStream &is,
|
dsdlib_skip_to(Decoder *decoder, InputStream &is,
|
||||||
@ -64,7 +64,7 @@ dsdlib_skip_to(Decoder *decoder, InputStream &is,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Skip some bytes from the #input_stream.
|
* Skip some bytes from the #InputStream.
|
||||||
*/
|
*/
|
||||||
bool
|
bool
|
||||||
dsdlib_skip(Decoder *decoder, InputStream &is,
|
dsdlib_skip(Decoder *decoder, InputStream &is,
|
||||||
|
@ -125,7 +125,7 @@ sndfile_vio_tell(void *user_data)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This SF_VIRTUAL_IO implementation wraps MPD's #input_stream to a
|
* This SF_VIRTUAL_IO implementation wraps MPD's #InputStream to a
|
||||||
* libsndfile stream.
|
* libsndfile stream.
|
||||||
*/
|
*/
|
||||||
static SF_VIRTUAL_IO vio = {
|
static SF_VIRTUAL_IO vio = {
|
||||||
|
@ -322,7 +322,7 @@ wavpack_scan_file(Path path_fs,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* mpd input_stream <=> WavpackStreamReader wrapper callbacks
|
* #InputStream <=> WavpackStreamReader wrapper callbacks
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* This struct is needed for per-stream last_byte storage. */
|
/* This struct is needed for per-stream last_byte storage. */
|
||||||
|
@ -23,13 +23,13 @@
|
|||||||
class Error;
|
class Error;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initializes this library and all input_stream implementations.
|
* Initializes this library and all #InputStream implementations.
|
||||||
*/
|
*/
|
||||||
bool
|
bool
|
||||||
input_stream_global_init(Error &error);
|
input_stream_global_init(Error &error);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Deinitializes this library and all input_stream implementations.
|
* Deinitializes this library and all #InputStream implementations.
|
||||||
*/
|
*/
|
||||||
void input_stream_global_finish(void);
|
void input_stream_global_finish(void);
|
||||||
|
|
||||||
|
@ -30,10 +30,10 @@ class TextInputStream {
|
|||||||
|
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
* Wraps an existing #input_stream object into a #TextInputStream,
|
* Wraps an existing #InputStream object into a #TextInputStream,
|
||||||
* to read its contents as text lines.
|
* to read its contents as text lines.
|
||||||
*
|
*
|
||||||
* @param _is an open #input_stream object
|
* @param _is an open #InputStream object
|
||||||
*/
|
*/
|
||||||
explicit TextInputStream(InputStream &_is)
|
explicit TextInputStream(InputStream &_is)
|
||||||
:is(_is) {}
|
:is(_is) {}
|
||||||
|
@ -57,7 +57,7 @@ playlist_list_open_stream_suffix(InputStream &is, const char *suffix);
|
|||||||
/**
|
/**
|
||||||
* Opens a playlist from an input stream.
|
* Opens a playlist from an input stream.
|
||||||
*
|
*
|
||||||
* @param is an #input_stream object which is open and ready
|
* @param is an #InputStream object which is open and ready
|
||||||
* @param uri optional URI which was used to open the stream; may be
|
* @param uri optional URI which was used to open the stream; may be
|
||||||
* used to select the appropriate playlist plugin
|
* used to select the appropriate playlist plugin
|
||||||
*/
|
*/
|
||||||
|
@ -31,7 +31,7 @@ class Path;
|
|||||||
* Opens a playlist from a local file.
|
* Opens a playlist from a local file.
|
||||||
*
|
*
|
||||||
* @param path the path of the playlist file
|
* @param path the path of the playlist file
|
||||||
* @param is_r on success, an input_stream object is returned here,
|
* @param is_r on success, an #InputStream object is returned here,
|
||||||
* which must be closed after the playlist_provider object is freed
|
* which must be closed after the playlist_provider object is freed
|
||||||
* @return a playlist, or nullptr on error
|
* @return a playlist, or nullptr on error
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user