SFML 2.3.1

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List

SoundRecorder.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 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 #ifndef SFML_SOUNDRECORDER_HPP
26 #define SFML_SOUNDRECORDER_HPP
27
29 // Headers
31 #include <SFML/Audio/Export.hpp>
32 #include <SFML/Audio/AlResource.hpp>
33 #include <SFML/System/Thread.hpp>
34 #include <SFML/System/Time.hpp>
35 #include <vector>
36 #include <string>
37
38
39 namespace sf
40 {
45 class SFML_AUDIO_API SoundRecorder : AlResource
46 {
47 public:
48
53 virtual ~SoundRecorder();
54
77 bool start(unsigned int sampleRate = 44100);
78
85 void stop();
86
97 unsigned int getSampleRate() const;
98
108 static std::vector<std::string> getAvailableDevices();
109
120 static std::string getDefaultDevice();
121
137 bool setDevice(const std::string& name);
138
145 const std::string& getDevice() const;
146
158 static bool isAvailable();
159
160 protected:
161
168 SoundRecorder();
169
186 void setProcessingInterval(Time interval);
187
199 virtual bool onStart();
200
215 virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount) = 0;
216
226 virtual void onStop();
227
228 private:
229
237 void record();
238
247 void processCapturedSamples();
248
255 void cleanup();
256
258 // Member data
260 Thread m_thread;
261 std::vector<Int16> m_samples;
262 unsigned int m_sampleRate;
263 Time m_processingInterval;
264 bool m_isCapturing;
265 std::string m_deviceName;
266 };
267
268 } // namespace sf
269
270
271 #endif // SFML_SOUNDRECORDER_HPP
272
273
sf::AlResource
Base class for classes that require an OpenAL context.
Definition: AlResource.hpp:40
sf::Time
Represents a time value.
Definition: Time.hpp:40
sf::SoundRecorder
Abstract base class for capturing sound data.
Definition: SoundRecorder.hpp:45
sf
Definition: AlResource.hpp:34
sf::Thread
Utility class to manipulate threads.
Definition: Thread.hpp:48