Manages and instantiates sound file readers and writers. More...
#include <SFML/Audio/SoundFileFactory.hpp>
Static Public Member Functions | |
template<typename T > | |
static void | registerReader () |
Register a new reader. | |
template<typename T > | |
static void | unregisterReader () |
Unregister a reader. | |
template<typename T > | |
static bool | isReaderRegistered () |
Check if a reader is registered. | |
template<typename T > | |
static void | registerWriter () |
Register a new writer. | |
template<typename T > | |
static void | unregisterWriter () |
Unregister a writer. | |
template<typename T > | |
static bool | isWriterRegistered () |
Check if a writer is registered. | |
static std::unique_ptr< SoundFileReader > | createReaderFromFilename (const std::filesystem::path &filename) |
Instantiate the right reader for the given file on disk. | |
static std::unique_ptr< SoundFileReader > | createReaderFromMemory (const void *data, std::size_t sizeInBytes) |
Instantiate the right codec for the given file in memory. | |
static std::unique_ptr< SoundFileReader > | createReaderFromStream (InputStream &stream) |
Instantiate the right codec for the given file in stream. | |
static std::unique_ptr< SoundFileWriter > | createWriterFromFilename (const std::filesystem::path &filename) |
Instantiate the right writer for the given file on disk. | |
Detailed Description
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:
Definition at line 49 of file SoundFileFactory.hpp.
Member Function Documentation
◆ createReaderFromFilename()
|
static |
Instantiate the right reader for the given file on disk.
- 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
◆ createReaderFromMemory()
|
static |
Instantiate the right codec for the given file in memory.
- 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
◆ createReaderFromStream()
|
static |
Instantiate the right codec for the given file in stream.
- 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
◆ createWriterFromFilename()
|
static |
Instantiate the right writer for the given file on disk.
- 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
◆ isReaderRegistered()
|
static |
Check if a reader is registered.
◆ isWriterRegistered()
|
static |
Check if a writer is registered.
◆ registerReader()
|
static |
Register a new reader.
- See also
unregisterReader
◆ registerWriter()
|
static |
Register a new writer.
- See also
unregisterWriter
◆ unregisterReader()
|
static |
Unregister a reader.
- See also
registerReader
◆ unregisterWriter()
|
static |
Unregister a writer.
- See also
registerWriter
The documentation for this class was generated from the following file: