Manages and instantiates sound file readers and writers.
More...
#include <SFML/Audio/SoundFileFactory.hpp>
Manages and instantiates sound file readers and writers.
This class is where all the sound file readers and writers are registered.
You should normally only need to use its registration and unregistration functions; readers/writers creation and manipulation are wrapped into the higher-level classes sf::InputSoundFile and sf::OutputSoundFile.
To register a new reader (writer) use the sf::SoundFileFactory::registerReader (registerWriter) static function. You don't have to call the unregisterReader (unregisterWriter) function, unless you want to unregister a format before your application ends (typically, when a plugin is unloaded).
Usage example:
static void registerWriter()
Register a new writer.
static void registerReader()
Register a new reader.
- See also
- sf::InputSoundFile, sf::OutputSoundFile, sf::SoundFileReader, sf::SoundFileWriter
Definition at line 46 of file SoundFileFactory.hpp.
◆ createReaderFromFilename()
static SoundFileReader * sf::SoundFileFactory::createReaderFromFilename |
( |
const std::string & | filename | ) |
|
|
static |
Instantiate the right reader for the given file on disk.
It's up to the caller to release the returned reader
- Parameters
-
filename | Path of the sound file |
- Returns
- A new sound file reader that can read the given file, or null if no reader can handle it
- See also
- createReaderFromMemory, createReaderFromStream
◆ createReaderFromMemory()
static SoundFileReader * sf::SoundFileFactory::createReaderFromMemory |
( |
const void * | data, |
|
|
std::size_t | sizeInBytes ) |
|
static |
Instantiate the right codec for the given file in memory.
It's up to the caller to release the returned reader
- Parameters
-
data | Pointer to the file data in memory |
sizeInBytes | Total size of the file data, in bytes |
- Returns
- A new sound file codec that can read the given file, or null if no codec can handle it
- See also
- createReaderFromFilename, createReaderFromStream
◆ createReaderFromStream()
Instantiate the right codec for the given file in stream.
It's up to the caller to release the returned reader
- Parameters
-
stream | Source stream to read from |
- Returns
- A new sound file codec that can read the given file, or null if no codec can handle it
- See also
- createReaderFromFilename, createReaderFromMemory
◆ createWriterFromFilename()
static SoundFileWriter * sf::SoundFileFactory::createWriterFromFilename |
( |
const std::string & | filename | ) |
|
|
static |
Instantiate the right writer for the given file on disk.
It's up to the caller to release the returned writer
- Parameters
-
filename | Path of the sound file |
- Returns
- A new sound file writer that can write given file, or null if no writer can handle it
◆ registerReader()
template<typename T >
static void sf::SoundFileFactory::registerReader |
( |
| ) |
|
|
static |
◆ registerWriter()
template<typename T >
static void sf::SoundFileFactory::registerWriter |
( |
| ) |
|
|
static |
◆ unregisterReader()
template<typename T >
static void sf::SoundFileFactory::unregisterReader |
( |
| ) |
|
|
static |
◆ unregisterWriter()
template<typename T >
static void sf::SoundFileFactory::unregisterWriter |
( |
| ) |
|
|
static |
The documentation for this class was generated from the following file: