SFML - Simple and Fast Multimedia Library

SFML 3.1.0
Loading...
Searching...
No Matches
SoundFileWriter.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2026 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
34#include <filesystem>
35#include <vector>
36
37#include <cstdint>
38
39
40namespace sf
41{
46 class SFML_AUDIO_API SoundFileWriter
47{
48public:
53 virtual ~SoundFileWriter() = default;
54
66 [[nodiscard]] virtual bool open(const std::filesystem::path& filename,
67 unsigned int sampleRate,
68 unsigned int channelCount,
69 const std::vector<SoundChannel>& channelMap) = 0;
70
78 virtual void write(const std::int16_t* samples, std::uint64_t count) = 0;
79};
80
81} // namespace sf
82
83
Export.hpp
SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42
SoundChannel.hpp
sf::SoundFileWriter
Abstract base class for sound file encoding.
Definition SoundFileWriter.hpp:47
sf::SoundFileWriter::open
virtual bool open(const std::filesystem::path &filename, unsigned int sampleRate, unsigned int channelCount, const std::vector< SoundChannel > &channelMap)=0
Open a sound file for writing.
sf::SoundFileWriter::write
virtual void write(const std::int16_t *samples, std::uint64_t count)=0
Write audio samples to the open file.
sf::SoundFileWriter::~SoundFileWriter
virtual ~SoundFileWriter()=default
Virtual destructor.
sf
Definition AudioResource.hpp:36