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

#include <SFML/Audio/SoundSource.hpp>

Inheritance diagram for sf::SoundSource:

Classes
struct	Cone
	Structure defining the properties of a directional cone. More...

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

using	EffectProcessor
	Callable that is provided with sound data for processing.

Public Member Functions
	SoundSource (const SoundSource &)=default
	Copy constructor.

	SoundSource (SoundSource &&) noexcept=default
	Move constructor.

SoundSource &	operator= (SoundSource &&) noexcept=default
	Move assignment.

virtual	~SoundSource ()=default
	Destructor.

void	setPitch (float pitch)
	Set the pitch of the sound.

void	setPan (float pan)
	Set the pan of the sound.

void	setVolume (float volume)
	Set the volume of the sound.

void	setSpatializationEnabled (bool enabled)
	Set whether spatialization of the sound is enabled.

void	setPosition (const Vector3f &position)
	Set the 3D position of the sound in the audio scene.

void	setDirection (const Vector3f &direction)
	Set the 3D direction of the sound in the audio scene.

void	setCone (const Cone &cone)
	Set the cone properties of the sound in the audio scene.

void	setVelocity (const Vector3f &velocity)
	Set the 3D velocity of the sound in the audio scene.

void	setDopplerFactor (float factor)
	Set the doppler factor of the sound.

void	setDirectionalAttenuationFactor (float factor)
	Set the directional attenuation factor of the sound.

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	setMaxDistance (float distance)
	Set the maximum distance of the sound.

void	setMinGain (float gain)
	Set the minimum gain of the sound.

void	setMaxGain (float gain)
	Set the maximum gain of the sound.

void	setAttenuation (float attenuation)
	Set the attenuation factor of the sound.

virtual void	setEffectProcessor (EffectProcessor effectProcessor)
	Set the effect processor to be applied to the sound.

float	getPitch () const
	Get the pitch of the sound.

float	getPan () const
	Get the pan of the sound.

float	getVolume () const
	Get the volume of the sound.

bool	isSpatializationEnabled () const
	Tell whether spatialization of the sound is enabled.

Vector3f	getPosition () const
	Get the 3D position of the sound in the audio scene.

Vector3f	getDirection () const
	Get the 3D direction of the sound in the audio scene.

Cone	getCone () const
	Get the cone properties of the sound in the audio scene.

Vector3f	getVelocity () const
	Get the 3D velocity of the sound in the audio scene.

float	getDopplerFactor () const
	Get the doppler factor of the sound.

float	getDirectionalAttenuationFactor () const
	Get the directional attenuation factor of the sound.

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	getMaxDistance () const
	Get the maximum distance of the sound.

float	getMinGain () const
	Get the minimum gain of the sound.

float	getMaxGain () const
	Get the maximum gain of the sound.

float	getAttenuation () const
	Get the attenuation factor of the sound.

SoundSource &	operator= (const SoundSource &right)
	Overload of assignment operator.

virtual void	play ()=0
	Start or resume playing the sound source.

virtual void	pause ()=0
	Pause the sound source.

virtual void	stop ()=0
	Stop playing the sound source.

virtual Status	getStatus () const =0
	Get the current status of the sound (stopped, paused, playing)

Protected Member Functions
	SoundSource ()=default
	Default constructor.

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 47 of file SoundSource.hpp.

Member Typedef Documentation

◆ EffectProcessor

using sf::SoundSource::EffectProcessor

Initial value:

std::function<

void(const float* inputFrames, unsigned int& inputFrameCount, float* outputFrames, unsigned int& outputFrameCount, unsigned int frameChannelCount)>

Callable that is provided with sound data for processing.

When the audio engine sources sound data from sound sources it will pass the data through an effects processor if one is set. The sound data will already be converted to the internal floating point format.

Sound data that is processed this way is provided in frames. Each frame contains 1 floating point sample per channel. If e.g. the data source provides stereo data, each frame will contain 2 floats.

The effects processor function takes 4 parameters:

The input data frames, channels interleaved
The number of input data frames available
The buffer to write output data frames to, channels interleaved
The number of output data frames that the output buffer can hold
The channel count

The input and output frame counts are in/out parameters.

When this function is called, the input count will contain the number of frames available in the input buffer. The output count will contain the size of the output buffer i.e. the maximum number of frames that can be written to the output buffer.

Attempting to read more frames than the input frame count or write more frames than the output frame count will result in undefined behaviour.

It is important to note that the channel count of the audio engine currently sourcing data from this sound will always be provided in frameChannelCount. This can be different from the channel count of the sound source so make sure to size necessary processing buffers according to the engine channel count and not the sound source channel count.

When done processing the frames, the input and output frame counts must be updated to reflect the actual number of frames that were read from the input and written to the output.

The processing function should always try to process as much sound data as possible i.e. always try to fill the output buffer to the maximum. In certain situations for specific effects it can be possible that the input frame count and output frame count aren't equal. As long as the frame counts are updated accordingly this is perfectly valid.

If the audio engine determines that no audio data is available from the data source, the input data frames pointer is set to nullptr and the input frame count is set to 0. In this case it is up to the function to decide how to handle the situation. For specific effects e.g. Echo/Delay buffered data might still be able to be written to the output buffer even if there is no longer any input data.

An important thing to remember is that this function is directly called by the audio engine. Because the audio engine runs on an internal thread of its own, make sure access to shared data is synchronized appropriately.

Because this function is stored by the SoundSource object it will be able to be called as long as the SoundSource object hasn't yet been destroyed. Make sure that any data this function references outlives the SoundSource object otherwise use-after-free errors will occur.

Definition at line 154 of file SoundSource.hpp.

Member Enumeration Documentation

◆ Status

enum class sf::SoundSource::Status

strong

Enumeration of the sound source states.

Enumerator
Stopped	Sound is not playing.
Paused	Sound is paused.
Playing	Sound is playing.

Definition at line 54 of file SoundSource.hpp.

Constructor & Destructor Documentation

◆ SoundSource() [1/3]

sf::SoundSource::SoundSource ( const SoundSource & )

default

Copy constructor.

◆ SoundSource() [2/3]

sf::SoundSource::SoundSource ( SoundSource && )

defaultnoexcept

Move constructor.

◆ ~SoundSource()

virtual sf::SoundSource::~SoundSource ( )

virtualdefault

Destructor.

◆ SoundSource() [3/3]

sf::SoundSource::SoundSource ( )

protecteddefault

Default constructor.

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

Member Function Documentation

◆ getAttenuation()

float sf::SoundSource::getAttenuation ( ) const

nodiscard

Get the attenuation factor of the sound.

Returns: Attenuation factor of the sound

See also: setAttenuation, getMinDistance

◆ getCone()

Cone sf::SoundSource::getCone ( ) const

nodiscard

Get the cone properties of the sound in the audio scene.

Returns: Cone properties of the sound

See also: setCone

◆ getDirection()

Vector3f sf::SoundSource::getDirection ( ) const

nodiscard

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

Returns: Direction of the sound

See also: setDirection

◆ getDirectionalAttenuationFactor()

float sf::SoundSource::getDirectionalAttenuationFactor ( ) const

nodiscard

Get the directional attenuation factor of the sound.

Returns: Directional attenuation factor of the sound

See also: setDirectionalAttenuationFactor

◆ getDopplerFactor()

float sf::SoundSource::getDopplerFactor ( ) const

nodiscard

Get the doppler factor of the sound.

Returns: Doppler factor of the sound

See also: setDopplerFactor

◆ getMaxDistance()

float sf::SoundSource::getMaxDistance ( ) const

nodiscard

Get the maximum distance of the sound.

Returns: Maximum distance of the sound

See also: setMaxDistance, getAttenuation

◆ getMaxGain()

float sf::SoundSource::getMaxGain ( ) const

nodiscard

Get the maximum gain of the sound.

Returns: Maximum gain of the sound

See also: setMaxGain, getAttenuation

◆ getMinDistance()

float sf::SoundSource::getMinDistance ( ) const

nodiscard

Get the minimum distance of the sound.

Returns: Minimum distance of the sound

See also: setMinDistance, getAttenuation

◆ getMinGain()

float sf::SoundSource::getMinGain ( ) const

nodiscard

Get the minimum gain of the sound.

Returns: Minimum gain of the sound

See also: setMinGain, getAttenuation

◆ getPan()

float sf::SoundSource::getPan ( ) const

nodiscard

Get the pan of the sound.

Returns: Pan of the sound

See also: setPan

◆ getPitch()

float sf::SoundSource::getPitch ( ) const

nodiscard

Get the pitch of the sound.

Returns: Pitch of the sound

See also: setPitch

◆ getPosition()

Vector3f sf::SoundSource::getPosition ( ) const

nodiscard

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

nodiscardpure virtual

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

Returns: Current status of the sound

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

◆ getVelocity()

Vector3f sf::SoundSource::getVelocity ( ) const

nodiscard

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

Returns: Velocity of the sound

See also: setVelocity

◆ getVolume()

float sf::SoundSource::getVolume ( ) const

nodiscard

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

nodiscard

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

◆ isSpatializationEnabled()

bool sf::SoundSource::isSpatializationEnabled ( ) const

nodiscard

Tell whether spatialization of the sound is enabled.

Returns: true if spatialization is enabled, false if it's disabled

See also: setSpatializationEnabled

◆ operator=() [1/2]

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

Overload of assignment operator.

Parameters

right Instance to assign

Returns: Reference to self

◆ operator=() [2/2]

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

defaultnoexcept

Move assignment.

◆ 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

attenuation New attenuation factor of the sound

See also: getAttenuation, setMinDistance

◆ setCone()

void sf::SoundSource::setCone ( const Cone & cone )

Set the cone properties of the sound in the audio scene.

The cone defines how directional attenuation is applied. The default cone of a sound is (2 * PI, 2 * PI, 1).

Parameters

cone	Cone properties of the sound in the scene

See also: getCone

◆ setDirection()

void sf::SoundSource::setDirection ( const Vector3f & direction )

Set the 3D direction of the sound in the audio scene.

The direction defines where the sound source is facing in 3D space. It will affect how the sound is attenuated if facing away from the listener. The default direction of a sound is (0, 0, -1).

Parameters

direction Direction of the sound in the scene

See also: getDirection

◆ setDirectionalAttenuationFactor()

void sf::SoundSource::setDirectionalAttenuationFactor ( float factor )

Set the directional attenuation factor of the sound.

Depending on the virtual position of an output channel relative to the listener (such as in surround sound setups), sounds will be attenuated when emitting them from certain channels. This factor determines how strong the attenuation based on output channel position relative to the listener is.

Parameters

factor New directional attenuation factor to apply to the sound

See also: getDirectionalAttenuationFactor

◆ setDopplerFactor()

void sf::SoundSource::setDopplerFactor ( float factor )

Set the doppler factor of the sound.

The doppler factor determines how strong the doppler shift will be.

Parameters

factor New doppler factor to apply to the sound

See also: getDopplerFactor

◆ setEffectProcessor()

virtual void sf::SoundSource::setEffectProcessor ( EffectProcessor effectProcessor )

virtual

Set the effect processor to be applied to the sound.

The effect processor is a callable that will be called with sound data to be processed.

Parameters

effectProcessor The effect processor to attach to this sound, attach an empty processor to disable processing

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

◆ setMaxDistance()

void sf::SoundSource::setMaxDistance ( float distance )

Set the maximum distance of the sound.

The "maximum distance" of a sound is the minimum distance at which it is heard at its minimum volume. Closer than the maximum distance, it will start to fade in according to its attenuation factor. The default value of the maximum distance is the maximum value a float can represent.

Parameters

distance New maximum distance of the sound

See also: getMaxDistance, setAttenuation

◆ setMaxGain()

void sf::SoundSource::setMaxGain ( float gain )

Set the maximum gain of the sound.

When the sound is closer from the listener than the "minimum distance" the attenuated gain is clamped so it cannot go above the maximum gain value.

Parameters

gain	New maximum gain of the sound

See also: getMaxGain, setAttenuation

◆ 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

distance New minimum distance of the sound

See also: getMinDistance, setAttenuation

◆ setMinGain()

void sf::SoundSource::setMinGain ( float gain )

Set the minimum gain of the sound.

When the sound is further away from the listener than the "maximum distance" the attenuated gain is clamped so it cannot go below the minimum gain value.

Parameters

gain	New minimum gain of the sound

See also: getMinGain, setAttenuation

◆ setPan()

void sf::SoundSource::setPan ( float pan )

Set the pan of the sound.

Using panning, a mono sound can be panned between stereo channels. When the pan is set to -1, the sound is played only on the left channel, when the pan is set to +1, the sound is played only on the right channel.

Parameters

pan	New pan to apply to the sound [-1, +1]

See also: getPan

◆ 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

pitch New pitch to apply to the sound

See also: getPitch

◆ setPosition()

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

position Position 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

relative true to set the position relative, false to set it absolute

See also: isRelativeToListener

◆ setSpatializationEnabled()

void sf::SoundSource::setSpatializationEnabled ( bool enabled )

Set whether spatialization of the sound is enabled.

Spatialization is the application of various effects to simulate a sound being emitted at a virtual position in 3D space and exhibiting various physical phenomena such as directional attenuation and doppler shift.

Parameters

enabled true to enable spatialization, false to disable

See also: isSpatializationEnabled

◆ setVelocity()

void sf::SoundSource::setVelocity ( const Vector3f & velocity )

Set the 3D velocity of the sound in the audio scene.

The velocity is used to determine how to doppler shift the sound. Sounds moving towards the listener will be perceived to have a higher pitch and sounds moving away from the listener will be perceived to have a lower pitch.

Parameters

velocity Velocity of the sound in the scene

See also: getVelocity

◆ 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

volume Volume 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.

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

SoundSource.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ EffectProcessor

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ SoundSource() [1/3]

◆ SoundSource() [2/3]

◆ ~SoundSource()

◆ SoundSource() [3/3]

Member Function Documentation

◆ getAttenuation()

◆ getCone()

◆ getDirection()

◆ getDirectionalAttenuationFactor()

◆ getDopplerFactor()

◆ getMaxDistance()

◆ getMaxGain()

◆ getMinDistance()

◆ getMinGain()

◆ getPan()

◆ getPitch()

◆ getPosition()

◆ getStatus()

◆ getVelocity()

◆ getVolume()

◆ isRelativeToListener()

◆ isSpatializationEnabled()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pause()

◆ play()

◆ setAttenuation()

◆ setCone()

◆ setDirection()

◆ setDirectionalAttenuationFactor()

◆ setDopplerFactor()

◆ setEffectProcessor()

◆ setMaxDistance()

◆ setMaxGain()

◆ setMinDistance()

◆ setMinGain()

◆ setPan()

◆ setPitch()

◆ setPosition()

◆ setRelativeToListener()

◆ setSpatializationEnabled()

◆ setVelocity()

◆ setVolume()

◆ stop()