Documentation of SFML 2.1

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
SoundRecorder.hpp
1 
2 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
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/System/Thread.hpp>
33 #include <vector>
34 
35 
36 namespace sf
37 {
42 class SFML_AUDIO_API SoundRecorder
43 {
44 public :
45 
50  virtual ~SoundRecorder();
51 
67  void start(unsigned int sampleRate = 44100);
68 
75  void stop();
76 
87  unsigned int getSampleRate() const;
88 
100  static bool isAvailable();
101 
102 protected :
103 
110  SoundRecorder();
111 
123  virtual bool onStart();
124 
139  virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount) = 0;
140 
150  virtual void onStop();
151 
152 private :
153 
161  void record();
162 
171  void processCapturedSamples();
172 
179  void cleanup();
180 
182  // Member data
184  Thread m_thread;
185  std::vector<Int16> m_samples;
186  unsigned int m_sampleRate;
187  bool m_isCapturing;
188 };
189 
190 } // namespace sf
191 
192 
193 #endif // SFML_SOUNDRECORDER_HPP
194 
195