Abstract base class for sound file decoding. More...
|Structure holding the audio properties of a sound file. More...|
|Virtual destructor. More...|
|virtual bool||open (InputStream &stream, Info &info)=0|
|Open a sound file for reading. More...|
|virtual void||seek (Uint64 sampleOffset)=0|
|Change the current read position to the given sample offset. More...|
|virtual Uint64||read (Int16 *samples, Uint64 maxCount)=0|
|Read audio samples from the open file. More...|
Abstract base class for sound file decoding.
This class allows users to read audio file formats not natively supported by SFML, and thus extend the set of supported readable audio formats.
A valid sound file reader must override the open, seek and write functions, as well as providing a static check function; the latter is used by SFML to find a suitable writer for a given input file.
To register a new reader, use the sf::SoundFileFactory::registerReader template function.
Constructor & Destructor Documentation
Member Function Documentation
Open a sound file for reading.
The provided stream reference is valid as long as the SoundFileReader is alive, so it is safe to use/store it during the whole lifetime of the reader.
stream Source stream to read from info Structure to fill with the properties of the loaded sound
- True if the file was successfully opened
Read audio samples from the open file.
samples Pointer to the sample array to fill maxCount Maximum number of samples to read
- Number of samples actually read (may be less than maxCount)
Change the current read position to the given sample offset.
The sample offset takes the channels into account. Offsets can be calculated like this:
sampleNumber * sampleRate * channelCount If the given offset exceeds to total number of samples, this function must jump to the end of the file.
sampleOffset Index of the sample to jump to, relative to the beginning
The documentation for this class was generated from the following file: