SoundStream is a streamed sound, ie samples are acquired while the sound is playing.
More...
#include <SoundStream.hpp>
|
struct | Chunk |
| Structure defining a chunk of audio data to stream. More...
|
|
|
typedef void(* | FuncType) (void *) |
|
SoundStream is a streamed sound, ie samples are acquired while the sound is playing.
Use it for big sounds that would require hundreds of MB in memory (see Music), or for streaming sound from the network
Definition at line 44 of file SoundStream.hpp.
◆ Status
Enumeration of the sound states.
Definition at line 52 of file Sound.hpp.
◆ ~SoundStream()
sf::SoundStream::~SoundStream |
( |
| ) |
|
|
virtual |
◆ SoundStream()
sf::SoundStream::SoundStream |
( |
| ) |
|
|
protected |
◆ GetAttenuation()
float sf::Sound::GetAttenuation |
Get the attenuation factor.
- Returns
- Attenuation factor of the sound
Definition at line 319 of file Sound.cpp.
◆ GetChannelsCount()
unsigned int sf::SoundStream::GetChannelsCount |
( |
| ) |
const |
Return the number of channels (1 = mono, 2 = stereo)
Return the number of channels (1 = mono, 2 = stereo, ...)
- Returns
- Number of channels
Definition at line 126 of file SoundStream.cpp.
◆ GetLoop()
bool sf::SoundStream::GetLoop |
( |
| ) |
const |
Tell whether or not the stream is looping.
Tell whether or not the music is looping.
- Returns
- True if the music is looping, false otherwise
Definition at line 180 of file SoundStream.cpp.
◆ GetMinDistance()
float sf::Sound::GetMinDistance |
Get the minimum distance.
- Returns
- Minimum distance for the sound
Definition at line 307 of file Sound.cpp.
◆ GetPitch()
float sf::Sound::GetPitch |
Get the pitch.
- Returns
- Pitch value
Definition at line 258 of file Sound.cpp.
◆ GetPlayingOffset()
float sf::SoundStream::GetPlayingOffset |
( |
| ) |
const |
Get the current playing position of the stream.
- Returns
- Current playing position, expressed in seconds
Definition at line 162 of file SoundStream.cpp.
◆ GetPosition()
Get the sound position.
- Returns
- Position of the sound in the world
Definition at line 282 of file Sound.cpp.
◆ GetSampleRate()
unsigned int sf::SoundStream::GetSampleRate |
( |
| ) |
const |
Get the stream sample rate.
Get the sound frequency (sample rate)
- Returns
- Stream frequency (number of samples per second)
Definition at line 135 of file SoundStream.cpp.
◆ GetStatus()
Get the status of the stream (stopped, paused, playing)
Get the status of the sound (stopped, paused, playing)
- Returns
- Current status of the sound
Definition at line 144 of file SoundStream.cpp.
◆ GetVolume()
float sf::Sound::GetVolume |
Get the volume.
- Returns
- Volume value (in range [1, 100])
Definition at line 270 of file Sound.cpp.
◆ Initialize()
void sf::SoundStream::Initialize |
( |
unsigned int |
ChannelsCount, |
|
|
unsigned int |
SampleRate |
|
) |
| |
|
protected |
Set the audio stream parameters, you must call it before Play()
- Parameters
-
ChannelsCount | : Number of channels |
SampleRate | : Sample rate |
Definition at line 64 of file SoundStream.cpp.
◆ IsRelativeToListener()
bool sf::Sound::IsRelativeToListener |
Tell if the sound's position is relative to the listener's position, or if it's absolute.
- Returns
- True if the position is relative, false if it's absolute
Definition at line 295 of file Sound.cpp.
◆ Pause()
◆ Play()
void sf::SoundStream::Play |
( |
| ) |
|
◆ SetAttenuation()
void sf::Sound::SetAttenuation |
Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener.
The default attenuation factor 1.0
- Parameters
-
Attenuation | : New attenuation factor for the sound |
The default attenuation factor 1.0
Definition at line 219 of file Sound.cpp.
◆ SetLoop()
void sf::SoundStream::SetLoop |
( |
bool |
Loop | ) |
|
Set the stream loop state.
Set the music loop state.
This parameter is disabled by default
- Parameters
-
Loop | : True to play in loop, false to play once |
Definition at line 171 of file SoundStream.cpp.
◆ SetMinDistance()
void sf::Sound::SetMinDistance |
Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume.
The default minimum distance is 1.0
- Parameters
-
MinDistance | : New minimum distance for the sound |
The default minimum distance is 1.0
Definition at line 208 of file Sound.cpp.
◆ SetPitch()
Set the sound pitch.
The default pitch is 1
- Parameters
-
Definition at line 158 of file Sound.cpp.
◆ SetPosition() [1/2]
void sf::Sound::SetPosition |
Set the sound position (take a 3D vector).
The default position is (0, 0, 0)
- Parameters
-
Position | : Position of the sound in the world |
The default position is (0, 0, 0)
Definition at line 186 of file Sound.cpp.
◆ SetPosition() [2/2]
void sf::Sound::SetPosition |
Set the sound position (take 3 values).
The default position is (0, 0, 0)
- Parameters
-
X,Y,Z | : Position of the sound in the world |
The default position is (0, 0, 0)
Definition at line 176 of file Sound.cpp.
◆ SetRelativeToListener()
void sf::Sound::SetRelativeToListener |
Make the sound's position relative to the listener's position, or absolute.
The default value is false (absolute)
- Parameters
-
Relative | : True to set the position relative, false to set it absolute |
The default value is false (absolute)
Definition at line 197 of file Sound.cpp.
◆ SetVolume()
void sf::Sound::SetVolume |
Set the sound volume.
The default volume is 100
- Parameters
-
Volume | : Volume (in range [0, 100]) |
Definition at line 167 of file Sound.cpp.
◆ Stop()
void sf::SoundStream::Stop |
( |
| ) |
|
The documentation for this class was generated from the following files: