SFML - Simple and Fast Multimedia Library

SFML 2.6.2

- Main Page
- Related Pages
- Topics
- Namespaces
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
OutputSoundFile.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 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_OUTPUTSOUNDFILE_HPP
26#define SFML_OUTPUTSOUNDFILE_HPP
27
29// Headers
31#include <SFML/Audio/Export.hpp>
32#include <SFML/System/NonCopyable.hpp>
33#include <string>
34
35
36namespace sf
37{
38class SoundFileWriter;
39
44 class SFML_AUDIO_API OutputSoundFile : NonCopyable
45{
46public:
47
52 OutputSoundFile();
53
60 ~OutputSoundFile();
61
74 bool openFromFile(const std::string& filename, unsigned int sampleRate, unsigned int channelCount);
75
83 void write(const Int16* samples, Uint64 count);
84
89 void close();
90
91private:
92
94 // Member data
96 SoundFileWriter* m_writer;
97};
98
99} // namespace sf
100
101
102#endif // SFML_OUTPUTSOUNDFILE_HPP
103
104
Export.hpp
SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:43
NonCopyable.hpp
sf::NonCopyable
Utility class that makes any derived class non-copyable.
Definition NonCopyable.hpp:42
sf::OutputSoundFile
Provide write access to sound files.
Definition OutputSoundFile.hpp:45
sf::OutputSoundFile::~OutputSoundFile
~OutputSoundFile()
Destructor.
sf::OutputSoundFile::OutputSoundFile
OutputSoundFile()
Default constructor.
sf::OutputSoundFile::close
void close()
Close the current file.
sf::OutputSoundFile::write
void write(const Int16 *samples, Uint64 count)
Write audio samples to the file.
sf::OutputSoundFile::openFromFile
bool openFromFile(const std::string &filename, unsigned int sampleRate, unsigned int channelCount)
Open the sound file from the disk for writing.
sf::SoundFileWriter
Abstract base class for sound file encoding.
Definition SoundFileWriter.hpp:42
sf
Definition AlResource.hpp:35
sf::Int16
signed short Int16
Definition Config.hpp:222
sf::Uint64
unsigned long long Uint64
Definition Config.hpp:239