Documentation of SFML 2.5.1

SoundFileWriter.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2018 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_SOUNDFILEWRITER_HPP
26 #define SFML_SOUNDFILEWRITER_HPP
27 
29 // Headers
31 #include <SFML/Audio/Export.hpp>
32 #include <string>
33 
34 
35 namespace sf
36 {
41 class SFML_AUDIO_API SoundFileWriter
42 {
43 public:
44 
49  virtual ~SoundFileWriter() {}
50 
61  virtual bool open(const std::string& filename, unsigned int sampleRate, unsigned int channelCount) = 0;
62 
70  virtual void write(const Int16* samples, Uint64 count) = 0;
71 };
72 
73 } // namespace sf
74 
75 
76 #endif // SFML_SOUNDFILEWRITER_HPP
77 
78 
Abstract base class for sound file encoding.
virtual ~SoundFileWriter()
Virtual destructor.