Documentation of SFML 2.6.1

No Matches
sf::SoundFileWriter Class Referenceabstract

Abstract base class for sound file encoding. More...

#include <SFML/Audio/SoundFileWriter.hpp>

Public Member Functions

virtual ~SoundFileWriter ()
 Virtual destructor.
virtual bool open (const std::string &filename, unsigned int sampleRate, unsigned int channelCount)=0
 Open a sound file for writing.
virtual void write (const Int16 *samples, Uint64 count)=0
 Write audio samples to the open file.

Detailed Description

Abstract base class for sound file encoding.

This class allows users to write audio file formats not natively supported by SFML, and thus extend the set of supported writable audio formats.

A valid sound file writer must override the open 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 filename.

To register a new writer, use the sf::SoundFileFactory::registerWriter template function.

Usage example:

class MySoundFileWriter : public sf::SoundFileWriter
static bool check(const std::string& filename)
// typically, check the extension
// return true if the writer can handle the format
virtual bool open(const std::string& filename, unsigned int sampleRate, unsigned int channelCount)
// open the file 'filename' for writing,
// write the given sample rate and channel count to the file header
// return true on success
virtual void write(const sf::Int16* samples, sf::Uint64 count)
// write 'count' samples stored at address 'samples',
// convert them (for example to normalized float) if the format requires it
Abstract base class for sound file encoding.
See also
sf::OutputSoundFile, sf::SoundFileFactory, sf::SoundFileReader

Definition at line 41 of file SoundFileWriter.hpp.

Constructor & Destructor Documentation

◆ ~SoundFileWriter()

virtual sf::SoundFileWriter::~SoundFileWriter ( )

Virtual destructor.

Definition at line 49 of file SoundFileWriter.hpp.

Member Function Documentation

◆ open()

virtual bool sf::SoundFileWriter::open ( const std::string &  filename,
unsigned int  sampleRate,
unsigned int  channelCount 
pure virtual

Open a sound file for writing.

filenamePath of the file to open
sampleRateSample rate of the sound
channelCountNumber of channels of the sound
True if the file was successfully opened

◆ write()

virtual void sf::SoundFileWriter::write ( const Int16 *  samples,
Uint64  count 
pure virtual

Write audio samples to the open file.

samplesPointer to the sample array to write
countNumber of samples to write

The documentation for this class was generated from the following file: