This class represents a sound sink where audio data can be written to. More...
#include <IWriter.h>
Inheritance diagram for IWriter:
Public Member Functions | |
| virtual | ~IWriter () |
| Destroys the writer. | |
| virtual int | getPosition () const =0 |
| Returns how many samples have been written so far. | |
| virtual DeviceSpecs | getSpecs () const =0 |
| Returns the specification of the audio data being written into the sink. | |
| virtual void | write (unsigned int length, sample_t *buffer)=0 |
| Request to write the next length samples out into the sink. | |
Detailed Description
This class represents a sound sink where audio data can be written to.
Member Function Documentation
◆ getPosition()
|
pure virtual |
Returns how many samples have been written so far.
- Returns
- The writing position as sample count. May be negative if unknown.
Implemented in FFMPEGWriter, and SndFileWriter.
◆ getSpecs()
|
pure virtual |
Returns the specification of the audio data being written into the sink.
- Returns
- The DeviceSpecs structure.
- Note
- Regardless of the format the input still has to be float!
Implemented in FFMPEGWriter, and SndFileWriter.
◆ write()
|
pure virtual |
Request to write the next length samples out into the sink.
- Parameters
-
length The count of samples to write. buffer The pointer to the buffer containing the data.
Implemented in FFMPEGWriter, and SndFileWriter.
The documentation for this interface was generated from the following file:
- file/IWriter.h
