SFML - Simple and Fast Multimedia Library

SFML 3.0.2
Loading...
Searching...
No Matches
SoundBufferRecorder.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/SoundBuffer.hpp>
33#include <SFML/Audio/SoundRecorder.hpp>
34
35#include <vector>
36
37#include <cstddef>
38#include <cstdint>
39
40
41namespace sf
42{
48 class SFML_AUDIO_API SoundBufferRecorder : public SoundRecorder
49{
50public:
55 ~SoundBufferRecorder() override;
56
68 [[nodiscard]] const SoundBuffer& getBuffer() const;
69
70protected:
77 [[nodiscard]] bool onStart() override;
78
88 [[nodiscard]] bool onProcessSamples(const std::int16_t* samples, std::size_t sampleCount) override;
89
94 void onStop() override;
95
96private:
98 // Member data
100 std::vector<std::int16_t> m_samples;
101 SoundBuffer m_buffer;
102};
103
104} // namespace sf
105
106
Export.hpp
SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42
SoundBuffer.hpp
SoundRecorder.hpp
sf::SoundBufferRecorder
Specialized SoundRecorder which stores the captured audio data into a sound buffer.
Definition SoundBufferRecorder.hpp:49
sf::SoundBufferRecorder::getBuffer
const SoundBuffer & getBuffer() const
Get the sound buffer containing the captured audio data.
sf::SoundBufferRecorder::onStart
bool onStart() override
Start capturing audio data.
sf::SoundBufferRecorder::onProcessSamples
bool onProcessSamples(const std::int16_t *samples, std::size_t sampleCount) override
Process a new chunk of recorded samples.
sf::SoundBufferRecorder::onStop
void onStop() override
Stop capturing audio data.
sf::SoundBufferRecorder::~SoundBufferRecorder
~SoundBufferRecorder() override
destructor
sf::SoundBuffer
Storage for audio samples defining a sound.
Definition SoundBuffer.hpp:55
sf::SoundRecorder::SoundRecorder
SoundRecorder()
Default constructor.
sf
Definition AudioResource.hpp:36