Documentation of SFML 1.6

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-2009 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/System/Thread.hpp>
32 #include <vector>
33 
34 
35 namespace sf
36 {
41 class SFML_API SoundRecorder : private Thread
42 {
43 public :
44 
49  virtual ~SoundRecorder();
50 
59  void Start(unsigned int SampleRate = 44100);
60 
65  void Stop();
66 
73  unsigned int GetSampleRate() const;
74 
82  static bool CanCapture();
83 
84 protected :
85 
90  SoundRecorder();
91 
92 private :
93 
100  virtual bool OnStart();
101 
111  virtual bool OnProcessSamples(const Int16* Samples, std::size_t SamplesCount) = 0;
112 
117  virtual void OnStop();
118 
123  virtual void Run();
124 
129  void ProcessCapturedSamples();
130 
135  void CleanUp();
136 
138  // Member data
140  std::vector<Int16> mySamples;
141  unsigned int mySampleRate;
142  bool myIsCapturing;
143 };
144 
145 } // namespace sf
146 
147 
148 #endif // SFML_SOUNDRECORDER_HPP