SoundStream is a streamed sound, ie samples are acquired while the sound is playing. More...

#include <SoundStream.hpp>

Inheritance diagram for sf::SoundStream:

Classes
struct	Chunk
	Structure defining a chunk of audio data to stream. More...

Public Types
enum	Status
	Enumeration of the sound states. More...

Public Member Functions
virtual	~SoundStream ()
	Virtual destructor.
void	Play ()
	Start playing the audio stream.
void	Stop ()
	Stop playing the audio stream.
unsigned int	GetChannelsCount () const
	Return the number of channels (1 = mono, 2 = stereo).
unsigned int	GetSampleRate () const
	Get the stream sample rate.
Status	GetStatus () const
	Get the status of the stream (stopped, paused, playing).
float	GetPlayingOffset () const
	Get the current playing position of the stream.
void	SetLoop (bool Loop)
	Set the stream loop state.
bool	GetLoop () const
	Tell whether or not the stream is looping.
void	Pause ()
	Pause the sound.
void	SetPitch (float Pitch)
	Set the sound pitch.
void	SetVolume (float Volume)
	Set the sound volume.
void	SetPosition (float X, float Y, float Z)
	Set the sound position (take 3 values).
void	SetPosition (const Vector3f &Position)
	Set the sound position (take a 3D vector).
void	SetRelativeToListener (bool Relative)
	Make the sound's position relative to the listener's position, or absolute.
void	SetMinDistance (float MinDistance)
	Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume.
void	SetAttenuation (float Attenuation)
	Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener.
float	GetPitch () const
	Get the pitch.
float	GetVolume () const
	Get the volume.
Vector3f	GetPosition () const
	Get the sound position.
bool	IsRelativeToListener () const
	Tell if the sound's position is relative to the listener's position, or if it's absolute.
float	GetMinDistance () const
	Get the minimum distance.
float	GetAttenuation () const
	Get the attenuation factor.

Protected Member Functions
	SoundStream ()
	Default constructor.
void	Initialize (unsigned int ChannelsCount, unsigned int SampleRate)
	Set the audio stream parameters, you must call it before Play().

Detailed Description

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.

Member Enumeration Documentation

◆ Status

enum sf::Sound::Status

Enumeration of the sound states.

Definition at line 52 of file Sound.hpp.

Constructor & Destructor Documentation

◆ ~SoundStream()

sf::SoundStream::~SoundStream ( )

virtual

Virtual destructor.

Definition at line 54 of file SoundStream.cpp.

◆ SoundStream()

sf::SoundStream::SoundStream ( )

protected

Default constructor.

Definition at line 39 of file SoundStream.cpp.

Member Function Documentation

◆ GetAttenuation()

float sf::Sound::GetAttenuation ( ) const

Get the attenuation factor.

Returns: Attenuation factor of the sound

Definition at line 263 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 ( ) const

Get the minimum distance.

Returns: Minimum distance for the sound

Definition at line 255 of file Sound.cpp.

◆ GetPitch()

float sf::Sound::GetPitch ( ) const

Get the pitch.

Returns: Pitch value

Definition at line 222 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()

Vector3f sf::Sound::GetPosition ( ) const

Get the sound position.

Returns: Position of the sound in the world

Definition at line 238 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()

Sound::Status sf::SoundStream::GetStatus ( ) const

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 ( ) const

Get the volume.

Returns: Volume value (in range [1, 100])

Definition at line 230 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 ( ) const

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 247 of file Sound.cpp.

◆ Pause()

void sf::Sound::Pause ( )

Pause the sound.

Definition at line 101 of file Sound.cpp.

◆ Play()

void sf::SoundStream::Play ( )

Start playing the audio stream.

Definition at line 85 of file SoundStream.cpp.

◆ SetAttenuation()

void sf::Sound::SetAttenuation ( float Attenuation )

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 190 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 ( float MinDistance )

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 180 of file Sound.cpp.

◆ SetPitch()

void sf::Sound::SetPitch ( float Pitch )

Set the sound pitch.

The default pitch is 1

Parameters

Pitch : New pitch

Definition at line 133 of file Sound.cpp.

◆ SetPosition() [1/2]

void sf::Sound::SetPosition ( const Vector3f & Position )

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 160 of file Sound.cpp.

◆ SetPosition() [2/2]

void sf::Sound::SetPosition	(	float	X,
		float	Y,
		float	Z )

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 151 of file Sound.cpp.

◆ SetRelativeToListener()

void sf::Sound::SetRelativeToListener ( bool Relative )

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 170 of file Sound.cpp.

◆ SetVolume()

void sf::Sound::SetVolume ( float Volume )

Set the sound volume.

The default volume is 100

Parameters

Volume : Volume (in range [0, 100])

Definition at line 142 of file Sound.cpp.

◆ Stop()

void sf::SoundStream::Stop ( )

Stop playing the audio stream.

Definition at line 115 of file SoundStream.cpp.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ ~SoundStream()

◆ SoundStream()

Member Function Documentation

◆ GetAttenuation()

◆ GetChannelsCount()

◆ GetLoop()

◆ GetMinDistance()

◆ GetPitch()

◆ GetPlayingOffset()

◆ GetPosition()

◆ GetSampleRate()

◆ GetStatus()

◆ GetVolume()

◆ Initialize()

◆ IsRelativeToListener()

◆ Pause()

◆ Play()

◆ SetAttenuation()

◆ SetLoop()

◆ SetMinDistance()

◆ SetPitch()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ SetRelativeToListener()

◆ SetVolume()

◆ Stop()