SFML - Simple and Fast Multimedia Library

SFML 3.0.1

- Main Page
- Topics
- Namespaces
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
OutputSoundFile.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <SFML/Audio/Export.hpp>
31
32#include <SFML/Audio/SoundChannel.hpp>
33#include <SFML/Audio/SoundFileWriter.hpp>
34
35#include <filesystem>
36#include <memory>
37#include <vector>
38
39#include <cstdint>
40
41
42namespace sf
43{
48 class SFML_AUDIO_API OutputSoundFile
49{
50public:
58 OutputSoundFile() = default;
59
73 OutputSoundFile(const std::filesystem::path& filename,
74 unsigned int sampleRate,
75 unsigned int channelCount,
76 const std::vector<SoundChannel>& channelMap);
77
91 [[nodiscard]] bool openFromFile(const std::filesystem::path& filename,
92 unsigned int sampleRate,
93 unsigned int channelCount,
94 const std::vector<SoundChannel>& channelMap);
95
103 void write(const std::int16_t* samples, std::uint64_t count);
104
109 void close();
110
111private:
113 // Member data
115 std::unique_ptr<SoundFileWriter> m_writer;
116};
117
118} // namespace sf
119
120
Export.hpp
SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42
SoundChannel.hpp
SoundFileWriter.hpp
sf::OutputSoundFile::write
void write(const std::int16_t *samples, std::uint64_t count)
Write audio samples to the file.
sf::OutputSoundFile::OutputSoundFile
OutputSoundFile(const std::filesystem::path &filename, unsigned int sampleRate, unsigned int channelCount, const std::vector< SoundChannel > &channelMap)
Construct the sound file from the disk for writing.
sf::OutputSoundFile::openFromFile
bool openFromFile(const std::filesystem::path &filename, unsigned int sampleRate, unsigned int channelCount, const std::vector< SoundChannel > &channelMap)
Open the sound file from the disk for writing.
sf::OutputSoundFile::OutputSoundFile
OutputSoundFile()=default
Default constructor.
sf::OutputSoundFile::close
void close()
Close the current file.
sf
Definition AudioResource.hpp:36