Documentation de SFML 2.6.0

Attention: cette page se réfère à une ancienne version de SFML. Cliquez ici pour passer à la dernière version.
Loading...
Searching...
No Matches
Sound.hpp
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_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
37namespace sf
38{
39class SoundBuffer;
40
45class SFML_AUDIO_API Sound : public SoundSource
46{
47public:
48
54
61 explicit Sound(const SoundBuffer& buffer);
62
69 Sound(const Sound& copy);
70
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
185
193
202 Sound& operator =(const Sound& right);
203
214
215private:
216
218 // Member data
220 const SoundBuffer* m_buffer;
221};
222
223} // namespace sf
224
225
226#endif // SFML_SOUND_HPP
227
228
Storage for audio samples defining a sound.
Definition: SoundBuffer.hpp:50
Base class defining a sound's properties.
Definition: SoundSource.hpp:43
Status
Enumeration of the sound source states.
Definition: SoundSource.hpp:51
Regular sound that can be played in the audio environment.
Definition: Sound.hpp:46
bool getLoop() const
Tell whether or not the sound is in loop mode.
void play()
Start or resume playing the sound.
Sound()
Default constructor.
Sound(const SoundBuffer &buffer)
Construct the sound with a buffer.
Status getStatus() const
Get the current status of the sound (stopped, paused, playing)
Time getPlayingOffset() const
Get the current playing position of the sound.
void pause()
Pause the sound.
const SoundBuffer * getBuffer() const
Get the audio buffer attached to the sound.
void setBuffer(const SoundBuffer &buffer)
Set the source buffer containing the audio data to play.
void stop()
stop playing the sound
void setPlayingOffset(Time timeOffset)
Change the current playing position of the sound.
void resetBuffer()
Reset the internal buffer of the sound.
~Sound()
Destructor.
Sound(const Sound &copy)
Copy constructor.
void setLoop(bool loop)
Set whether or not the sound should loop after reaching the end.
Represents a time value.
Definition: Time.hpp:41