Base module
basic::Encoder
Abstract interface for stream encoders.
Encoder
#include <icy/interface.h>class EncoderDefined in src/base/include/icy/interface.h:54
Abstract interface for stream encoders.
List of all members
| Name | Kind | Owner |
|---|---|---|
Encoder | function | Declared here |
~Encoder | function | Declared here |
encode | function | Declared here |
finalize | function | Declared here |
Public Methods
| Return | Name | Description |
|---|---|---|
Encoder | Defaulted constructor. | |
ssize_t | encode virtual | Encodes nread bytes from inbuf and writes encoded output to outbuf. |
ssize_t | finalize virtual inline | Flushes any buffered state and writes final output to outbuf. |
Encoder
Encoder() = defaultDefined in src/base/include/icy/interface.h:57
Defaulted constructor.
encode
virtual
virtual ssize_t encode(const char * inbuf, size_t nread, char * outbuf)Defined in src/base/include/icy/interface.h:65
Encodes nread bytes from inbuf and writes encoded output to outbuf.
Parameters
inbufRaw input buffer to encode.nreadNumber of bytes to encode from inbuf.outbufDestination buffer for encoded output.
Returns
Number of bytes written to outbuf, or -1 on error.
Reimplemented by
finalize
virtual inline
virtual inline ssize_t finalize(char * outbuf)Defined in src/base/include/icy/interface.h:70
Flushes any buffered state and writes final output to outbuf.
Parameters
outbufDestination buffer for any remaining output.
Returns
Number of bytes written, or 0 if nothing to flush.
