Slippers Engine
 
Loading...
Searching...
No Matches
SoundSourceListener Class Reference

Responsible for Sound Sources that always play at the Listener's position. Go To Scene for creation and destruction. More...

#include <SoundSourceListener.h>

Public Member Functions

virtual float GetGain () override
 Returns sound's gain.
 
virtual void SetGain (float g) override
 Sets sound's gain.
 
virtual void SetSound (SoundManager::Sound s) override
 Sets sound to be played.
 
- Public Member Functions inherited from Reverbable
virtual void SubmitRegistration ()
 Called when wanting to make a sound have reverb in a ReverbSpace.
 
virtual void SubmitDeregistration ()
 Called when no longer wanting to make a sound have reverb in a ReverbSpace.
 
- Public Member Functions inherited from SoundSourceBase
virtual bool GetLooping ()
 Returns if sound is looping.
 
virtual void SetLooping (bool l)
 Sets if sound is looping.
 
virtual float GetPitch ()
 Returns sound's pitch.
 
virtual void SetPitch (float p)
 Sets sound's pitch.
 
virtual float GetOffset ()
 Returns sound's offset.
 
virtual void SetOffset (float o)
 Sets sound's offset.
 
virtual PlayState GetPlayState ()
 Returns sound's PlayState.
 
virtual void Play ()
 Plays a sound starting at it's offset.
 
virtual void PlayStart ()
 Plays a sound starting at the beginning.
 
virtual void Pause ()
 Pauses a sound.
 
virtual void Stop ()
 Fully Stops a sound.
 

Additional Inherited Members

- Public Types inherited from SoundSourceBase
enum class  PlayState { PLAYING , PAUSED , STOPPED }
 Potential States a source can be in. More...
 

Detailed Description

Responsible for Sound Sources that always play at the Listener's position. Go To Scene for creation and destruction.

Check SoundSourceBase for more functions.

Member Function Documentation

◆ GetGain()

float SoundSourceListener::GetGain ( )
overridevirtual

Returns sound's gain.

Returns
float

Implements SoundSourceBase.

◆ SetGain()

void SoundSourceListener::SetGain ( float g)
overridevirtual

Sets sound's gain.

Parameters
g

Implements SoundSourceBase.

◆ SetSound()

void SoundSourceListener::SetSound ( SoundManager::Sound s)
overridevirtual

Sets sound to be played.

SoundSourceListener can accept either mono or stereo.

Parameters
s

Implements SoundSourceBase.