Documentation de SFML 2.5.1

sf::SoundSource Class Referenceabstract

Base class defining a sound's properties. More...

#include <SoundSource.hpp>

Inheritance diagram for sf::SoundSource:
sf::AlResource sf::Sound sf::SoundStream sf::Music

Public Types

enum  Status { Stopped, Paused, Playing }
 Enumeration of the sound source states. More...
 

Public Member Functions

 SoundSource (const SoundSource &copy)
 Copy constructor. More...
 
virtual ~SoundSource ()
 Destructor. More...
 
void setPitch (float pitch)
 Set the pitch of the sound. More...
 
void setVolume (float volume)
 Set the volume of the sound. More...
 
void setPosition (float x, float y, float z)
 Set the 3D position of the sound in the audio scene. More...
 
void setPosition (const Vector3f &position)
 Set the 3D position of the sound in the audio scene. More...
 
void setRelativeToListener (bool relative)
 Make the sound's position relative to the listener or absolute. More...
 
void setMinDistance (float distance)
 Set the minimum distance of the sound. More...
 
void setAttenuation (float attenuation)
 Set the attenuation factor of the sound. More...
 
float getPitch () const
 Get the pitch of the sound. More...
 
float getVolume () const
 Get the volume of the sound. More...
 
Vector3f getPosition () const
 Get the 3D position of the sound in the audio scene. More...
 
bool isRelativeToListener () const
 Tell whether the sound's position is relative to the listener or is absolute. More...
 
float getMinDistance () const
 Get the minimum distance of the sound. More...
 
float getAttenuation () const
 Get the attenuation factor of the sound. More...
 
SoundSourceoperator= (const SoundSource &right)
 Overload of assignment operator. More...
 
virtual void play ()=0
 Start or resume playing the sound source. More...
 
virtual void pause ()=0
 Pause the sound source. More...
 
virtual void stop ()=0
 Stop playing the sound source. More...
 
virtual Status getStatus () const
 Get the current status of the sound (stopped, paused, playing) More...
 

Protected Member Functions

 SoundSource ()
 Default constructor. More...
 

Protected Attributes

unsigned int m_source
 OpenAL source identifier. More...
 

Detailed Description

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.

See also
sf::Sound, sf::SoundStream

Definition at line 42 of file SoundSource.hpp.

Member Enumeration Documentation

◆ Status

Enumeration of the sound source states.

Enumerator
Stopped 

Sound is not playing.

Paused 

Sound is paused.

Playing 

Sound is playing.

Definition at line 50 of file SoundSource.hpp.

Constructor & Destructor Documentation

◆ SoundSource() [1/2]

sf::SoundSource::SoundSource ( const SoundSource copy)

Copy constructor.

Parameters
copyInstance to copy

◆ ~SoundSource()

virtual sf::SoundSource::~SoundSource ( )
virtual

Destructor.

◆ SoundSource() [2/2]

sf::SoundSource::SoundSource ( )
protected

Default constructor.

This constructor is meant to be called by derived classes only.

Member Function Documentation

◆ getAttenuation()

float sf::SoundSource::getAttenuation ( ) const

Get the attenuation factor of the sound.

Returns
Attenuation factor of the sound
See also
setAttenuation, getMinDistance

◆ getMinDistance()

float sf::SoundSource::getMinDistance ( ) const

Get the minimum distance of the sound.

Returns
Minimum distance of the sound
See also
setMinDistance, getAttenuation

◆ getPitch()

float sf::SoundSource::getPitch ( ) const

Get the pitch of the sound.

Returns
Pitch of the sound
See also
setPitch

◆ getPosition()

Vector3f sf::SoundSource::getPosition ( ) const

Get the 3D position of the sound in the audio scene.

Returns
Position of the sound
See also
setPosition

◆ getStatus()

virtual Status sf::SoundSource::getStatus ( ) const
virtual

Get the current status of the sound (stopped, paused, playing)

Returns
Current status of the sound

Reimplemented in sf::Sound, and sf::SoundStream.

◆ getVolume()

float sf::SoundSource::getVolume ( ) const

Get the volume of the sound.

Returns
Volume of the sound, in the range [0, 100]
See also
setVolume

◆ isRelativeToListener()

bool sf::SoundSource::isRelativeToListener ( ) const

Tell whether the sound's position is relative to the listener or is absolute.

Returns
True if the position is relative, false if it's absolute
See also
setRelativeToListener

◆ operator=()

SoundSource& sf::SoundSource::operator= ( const SoundSource right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to self

◆ pause()

virtual void sf::SoundSource::pause ( )
pure virtual

Pause the sound source.

This function pauses the source if it was playing, otherwise (source already paused or stopped) it has no effect.

See also
play, stop

Implemented in sf::Sound, and sf::SoundStream.

◆ play()

virtual void sf::SoundSource::play ( )
pure virtual

Start or resume playing the sound source.

This function starts the source if it was stopped, resumes it if it was paused, and restarts it from the beginning if it was already playing.

See also
pause, stop

Implemented in sf::Sound, and sf::SoundStream.

◆ setAttenuation()

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.

Parameters
attenuationNew attenuation factor of the sound
See also
getAttenuation, setMinDistance

◆ setMinDistance()

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.

Parameters
distanceNew minimum distance of the sound
See also
getMinDistance, setAttenuation

◆ setPitch()

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.

Parameters
pitchNew pitch to apply to the sound
See also
getPitch

◆ setPosition() [1/2]

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).

Parameters
xX coordinate of the position of the sound in the scene
yY coordinate of the position of the sound in the scene
zZ coordinate of the position of the sound in the scene
See also
getPosition

◆ setPosition() [2/2]

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).

Parameters
positionPosition of the sound in the scene
See also
getPosition

◆ setRelativeToListener()

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 of 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).

Parameters
relativeTrue to set the position relative, false to set it absolute
See also
isRelativeToListener

◆ setVolume()

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.

Parameters
volumeVolume of the sound
See also
getVolume

◆ stop()

virtual void sf::SoundSource::stop ( )
pure virtual

Stop playing the sound source.

This function stops the source if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause()).

See also
play, pause

Implemented in sf::Sound, and sf::SoundStream.

Member Data Documentation

◆ m_source

unsigned int sf::SoundSource::m_source
protected

OpenAL source identifier.

Definition at line 309 of file SoundSource.hpp.


The documentation for this class was generated from the following file: