Base module
basic::Encoder
Abstract interface for stream encoders.
Encoder
#include <icy/interface.h>
class EncoderDefined in src/base/include/icy/interface.h:54
Public Methods
| Return | Name | Description |
|---|---|---|
Encoder | Defaulted constructor. | |
~Encoder virtual | Defaulted destructor. | |
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.
~Encoder
virtual
virtual ~Encoder() = defaultDefined in src/base/include/icy/interface.h:58
Defaulted destructor.
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.
Returns
Number of bytes written to outbuf, or -1 on error.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
inbuf | const char * | Raw input buffer to encode. |
nread | size_t | Number of bytes to encode from inbuf. |
outbuf | char * | Destination buffer for encoded output. |
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.
Returns
Number of bytes written, or 0 if nothing to flush.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
outbuf | char * | Destination buffer for any remaining output. |
