Provide write access to sound files.
More...
#include <SFML/Audio/OutputSoundFile.hpp>
|
| OutputSoundFile () |
| Default constructor.
|
|
| ~OutputSoundFile () |
| Destructor.
|
|
bool | openFromFile (const std::string &filename, unsigned int sampleRate, unsigned int channelCount) |
| Open the sound file from the disk for writing.
|
|
void | write (const Int16 *samples, Uint64 count) |
| Write audio samples to the file.
|
|
void | close () |
| Close the current file.
|
|
Provide write access to sound files.
This class encodes audio samples to a sound file.
It is used internally by higher-level classes such as sf::SoundBuffer, but can also be useful if you want to create audio files from custom data sources, like generated audio samples.
Usage example:
;
while (...)
{
std::vector<sf::Int16> samples = ...;
file.
write(samples.data(), samples.size());
}
Provide write access to sound files.
void write(const Int16 *samples, Uint64 count)
Write audio samples to the file.
bool openFromFile(const std::string &filename, unsigned int sampleRate, unsigned int channelCount)
Open the sound file from the disk for writing.
- See also
- sf::SoundFileWriter, sf::InputSoundFile
Definition at line 44 of file OutputSoundFile.hpp.
◆ OutputSoundFile()
sf::OutputSoundFile::OutputSoundFile |
( |
| ) |
|
◆ ~OutputSoundFile()
sf::OutputSoundFile::~OutputSoundFile |
( |
| ) |
|
Destructor.
Closes the file if it was still open.
◆ close()
void sf::OutputSoundFile::close |
( |
| ) |
|
◆ openFromFile()
bool sf::OutputSoundFile::openFromFile |
( |
const std::string & |
filename, |
|
|
unsigned int |
sampleRate, |
|
|
unsigned int |
channelCount |
|
) |
| |
Open the sound file from the disk for writing.
The supported audio formats are: WAV, OGG/Vorbis, FLAC.
- Parameters
-
filename | Path of the sound file to write |
sampleRate | Sample rate of the sound |
channelCount | Number of channels in the sound |
- Returns
- True if the file was successfully opened
◆ write()
void sf::OutputSoundFile::write |
( |
const Int16 * |
samples, |
|
|
Uint64 |
count |
|
) |
| |
Write audio samples to the file.
- Parameters
-
samples | Pointer to the sample array to write |
count | Number of samples to write |
The documentation for this class was generated from the following file: