SFML 2.5.1
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
include
SFML
Audio
Sound.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_SOUND_HPP
26
#define SFML_SOUND_HPP
27
29
// Headers
31
#include <SFML/Audio/Export.hpp>
32
#include <SFML/Audio/SoundSource.hpp>
33
#include <SFML/System/Time.hpp>
34
#include <cstdlib>
35
36
37
namespace
sf
38
{
39
class
SoundBuffer;
40
45
class
SFML_AUDIO_API
Sound
:
public
SoundSource
46
{
47
public
:
48
53
Sound
();
54
61
explicit
Sound
(
const
SoundBuffer
& buffer);
62
69
Sound
(
const
Sound
& copy);
70
75
~
Sound
();
76
89
void
play();
90
100
void
pause();
101
112
void
stop();
113
126
void
setBuffer(
const
SoundBuffer
& buffer);
127
141
void
setLoop(
bool
loop);
142
156
void
setPlayingOffset(
Time
timeOffset);
157
164
const
SoundBuffer
* getBuffer()
const
;
165
174
bool
getLoop()
const
;
175
184
Time
getPlayingOffset()
const
;
185
192
Status
getStatus()
const
;
193
202
Sound
& operator =(
const
Sound
& right);
203
213
void
resetBuffer();
214
215
private
:
216
218
// Member data
220
const
SoundBuffer
* m_buffer;
221
};
222
223
}
// namespace sf
224
225
226
#endif // SFML_SOUND_HPP
227
228
sf::Sound
Regular sound that can be played in the audio environment.
Definition:
Sound.hpp:45
sf::SoundBuffer
Storage for audio samples defining a sound.
Definition:
SoundBuffer.hpp:49
sf::SoundSource
Base class defining a sound's properties.
Definition:
SoundSource.hpp:42
sf::SoundSource::Status
Status
Enumeration of the sound source states.
Definition:
SoundSource.hpp:50
sf::Time
Represents a time value.
Definition:
Time.hpp:40