sfSoundStream Class Reference

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

#include <SoundStream.hpp>

Inheritance diagram for sfSoundStream:

sfThread sfSound sfMusic List of all members.

Public Member Functions

virtual ~sfSoundStream ()
 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).

Protected Member Functions

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

Classes

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

Detailed Description

sfSoundStream 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 sfMusic), or for streaming sound from the network

Definition at line 42 of file SoundStream.hpp.


Constructor & Destructor Documentation

sfSoundStream::~sfSoundStream (  )  [virtual]

Virtual destructor.

Definition at line 51 of file SoundStream.cpp.

sfSoundStream::sfSoundStream (  )  [protected]

Default constructor.

Definition at line 38 of file SoundStream.cpp.


Member Function Documentation

void sfSoundStream::Play (  ) 

Start playing the audio stream.

Reimplemented from sfSound.

Definition at line 82 of file SoundStream.cpp.

void sfSoundStream::Stop (  ) 

Stop playing the audio stream.

Reimplemented from sfSound.

Definition at line 111 of file SoundStream.cpp.

unsigned int sfSoundStream::GetChannelsCount (  )  const

Return the number of channels (1 = mono, 2 = stereo, .

..)

Returns:
Number of channels

Definition at line 122 of file SoundStream.cpp.

unsigned int sfSoundStream::GetSampleRate (  )  const

Get the stream sample rate.

Returns:
Stream frequency (number of samples per second)

Definition at line 131 of file SoundStream.cpp.

sfSound::Status sfSoundStream::GetStatus (  )  const

Get the status of the stream (stopped, paused, playing).

Returns:
Current status of the sound

Reimplemented from sfSound.

Definition at line 140 of file SoundStream.cpp.

void sfSoundStream::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 61 of file SoundStream.cpp.


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