sgui::SoundPlayer Class Reference

Allow to play spatialized sounds. More...

#include <SoundPlayer.h>

Public Member Functions
	SoundPlayer ()=default
	SoundPlayer (const SoundPlayer &)=delete
SoundPlayer &	operator= (const SoundPlayer &)=delete
void	setResource (SoundHolder &holder)
	set sounds files
void	play (const std::string &sound, const sf::Vector2f &position={})
	play a sound at a given position
void	removeStoppedSounds ()
	remove all stopped sounds
sf::Vector3f	listenerPosition () const
	get listener position
void	setListenerPosition (const sf::Vector2f &position)
	set listener position
float	volume () const
	get sound volume
void	setVolume (const float volume)
	set sound volume

Public Attributes
float	attenuation = 0.f
float	minDistance = 100.f

Detailed Description

Allow to play spatialized sounds.

Constructor & Destructor Documentation

SoundPlayer() [1/2]

sgui::SoundPlayer::SoundPlayer ( )

default

SoundPlayer is not copyable

SoundPlayer() [2/2]

sgui::SoundPlayer::SoundPlayer ( const SoundPlayer & )

delete

Member Function Documentation

listenerPosition()

sf::Vector3f sgui::SoundPlayer::listenerPosition

(

)

const

get listener position

operator=()

SoundPlayer & sgui::SoundPlayer::operator= ( const SoundPlayer & )

delete

play()

void sgui::SoundPlayer::play	(	const std::string &	sound,
		const sf::Vector2f &	position = {} )

play a sound at a given position

removeStoppedSounds()

void sgui::SoundPlayer::removeStoppedSounds

(

)

remove all stopped sounds

setListenerPosition()

void sgui::SoundPlayer::setListenerPosition

(

const sf::Vector2f &

position

)

set listener position

setResource()

void sgui::SoundPlayer::setResource

(

SoundHolder &

holder

)

set sounds files

setVolume()

void sgui::SoundPlayer::setVolume

(

const float

volume

)

set sound volume

volume()

float sgui::SoundPlayer::volume

(

)

const

get sound volume

Member Data Documentation

attenuation

float sgui::SoundPlayer::attenuation = 0.f

minDistance

float sgui::SoundPlayer::minDistance = 100.f

---

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

• /github/workspace/src/sgui/Resources/SoundPlayer.h
• /github/workspace/src/sgui/Resources/SoundPlayer.cpp