Base class defining a sound's properties. More...
#include <SoundSource.hpp>
Public Types | |
| enum | Status { Stopped, Paused, Playing } |
Enumeration of the sound source states. More... | |
Public Member Functions | |
| SoundSource (const SoundSource ©) | |
| Copy constructor. | |
| virtual | ~SoundSource () |
| Destructor. | |
| void | SetPitch (float pitch) |
| Set the pitch of the sound. | |
| void | SetVolume (float volume) |
| Set the volume of the sound. | |
| void | SetPosition (float x, float y, float z) |
| Set the 3D position of the sound in the audio scene. | |
| void | SetPosition (const Vector3f &position) |
| Set the 3D position of the sound in the audio scene. | |
| void | SetRelativeToListener (bool relative) |
| Make the sound's position relative to the listener or absolute. | |
| void | SetMinDistance (float distance) |
| Set the minimum distance of the sound. | |
| void | SetAttenuation (float attenuation) |
| Set the attenuation factor of the sound. | |
| float | GetPitch () const |
| Get the pitch of the sound. | |
| float | GetVolume () const |
| Get the volume of the sound. | |
| Vector3f | GetPosition () const |
| Get the 3D position of the sound in the audio scene. | |
| bool | IsRelativeToListener () const |
| Tell whether the sound's position is relative to the listener or is absolute. | |
| float | GetMinDistance () const |
| Get the minimum distance of the sound. | |
| float | GetAttenuation () const |
| Get the attenuation factor of the sound. | |
Protected Member Functions | |
| SoundSource () | |
| Default constructor. | |
| Status | GetStatus () const |
| Get the current status of the sound (stopped, paused, playing). | |
Protected Attributes | |
| unsigned int | mySource |
| OpenAL source identifier. | |
Base class defining a sound's properties.
sf::SoundSource is not meant to be used directly, it only serves as a common base for all audio objects that can live in the audio environment.
It defines several properties for the sound: pitch, volume, position, attenuation, etc. All of them can be changed at any time with no impact on performances.
Definition at line 41 of file SoundSource.hpp.
Enumeration of the sound source states.
Definition at line 49 of file SoundSource.hpp.
| sf::SoundSource::SoundSource | ( | const SoundSource & | copy | ) |
| sf::SoundSource::~SoundSource | ( | ) | [virtual] |
Destructor.
Definition at line 62 of file SoundSource.cpp.
| sf::SoundSource::SoundSource | ( | ) | [protected] |
Default constructor.
This constructor is meant ot be called by derived classes only.
Definition at line 35 of file SoundSource.cpp.
| float sf::SoundSource::GetAttenuation | ( | ) | const |
Get the attenuation factor of the sound.
Definition at line 168 of file SoundSource.cpp.
| float sf::SoundSource::GetMinDistance | ( | ) | const |
Get the minimum distance of the sound.
Definition at line 158 of file SoundSource.cpp.
| float sf::SoundSource::GetPitch | ( | ) | const |
Get the pitch of the sound.
Definition at line 118 of file SoundSource.cpp.
| Vector3f sf::SoundSource::GetPosition | ( | ) | const |
Get the 3D position of the sound in the audio scene.
Definition at line 138 of file SoundSource.cpp.
| SoundSource::Status sf::SoundSource::GetStatus | ( | ) | const [protected] |
Get the current status of the sound (stopped, paused, playing).
Reimplemented in sf::Sound, and sf::SoundStream.
Definition at line 178 of file SoundSource.cpp.
| float sf::SoundSource::GetVolume | ( | ) | const |
Get the volume of the sound.
Definition at line 128 of file SoundSource.cpp.
| bool sf::SoundSource::IsRelativeToListener | ( | ) | const |
Tell whether the sound's position is relative to the listener or is absolute.
Definition at line 148 of file SoundSource.cpp.
| void sf::SoundSource::SetAttenuation | ( | float | attenuation | ) |
Set the attenuation factor of the sound.
The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.
| attenuation | New attenuation factor of the sound |
Definition at line 111 of file SoundSource.cpp.
| void sf::SoundSource::SetMinDistance | ( | float | distance | ) |
Set the minimum distance of the sound.
The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.
| distance | New minimum distance of the sound |
Definition at line 104 of file SoundSource.cpp.
| void sf::SoundSource::SetPitch | ( | float | pitch | ) |
Set the pitch of the sound.
The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.
| pitch | New pitch to apply to the sound |
Definition at line 70 of file SoundSource.cpp.
| void sf::SoundSource::SetPosition | ( | const Vector3f & | position | ) |
Set the 3D position of the sound in the audio scene.
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
| position | Position of the sound in the scene |
Definition at line 90 of file SoundSource.cpp.
| void sf::SoundSource::SetPosition | ( | float | x, | |
| float | y, | |||
| float | z | |||
| ) |
Set the 3D position of the sound in the audio scene.
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
| x | X coordinate of the position of the sound in the scene | |
| y | Y coordinate of the position of the sound in the scene | |
| z | Z coordinate of the position of the sound in the scene |
Definition at line 83 of file SoundSource.cpp.
| void sf::SoundSource::SetRelativeToListener | ( | bool | relative | ) |
Make the sound's position relative to the listener or absolute.
Making a sound relative to the listener will ensure that it will always be played the same way regardless the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).
| relative | True to set the position relative, false to set it absolute |
Definition at line 97 of file SoundSource.cpp.
| void sf::SoundSource::SetVolume | ( | float | volume | ) |
Set the volume of the sound.
The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.
| volume | Volume of the sound |
Definition at line 77 of file SoundSource.cpp.
unsigned int sf::SoundSource::mySource [protected] |
OpenAL source identifier.
Definition at line 263 of file SoundSource.hpp.