SDLPP::SoundStream Class Reference

#include <sdlpp_sound.h>

Inheritance diagram for SDLPP::SoundStream:
SDLPP::RefCount PitchChangeStream

List of all members.


struct  Data

Public Member Functions

 SoundStream (const xstring &filename="")
 SoundStream (std::istream *is)
 SoundStream (ResourceFile &rf, const xstring &name)
 SoundStream (const SoundStream &rhs)
SoundStreamoperator= (const SoundStream &rhs)
void play ()
void stop ()

Protected Member Functions

void destroy ()
virtual Uint8 * get_frame (int bytes)


class SoundManager
struct SoundStream_Thread

Detailed Description

SoundStream is usually used for music or other long (potential infinite) audio. It can either be decoded from some compressed audio source, or retrieved from a network location. The stream can only have a single instance playing at any given moment, though it is possible to create multiple streams from the same source of data. SoundStream objects in their nature allocate memory and resources. In order to make their usage simple and still not waste resources by duplicating memory, SoundStream objects include built in reference counting, so they can be passed by value on the stack without too much overhead.

Constructor & Destructor Documentation

SDLPP::SoundStream::SoundStream ( const xstring filename = ""  ) 

Construct a sound stream and optionally load it from a file.

SDLPP::SoundStream::SoundStream ( std::istream *  is  ) 

Construct a sound Stream by decoding audio from an input stream.

SDLPP::SoundStream::SoundStream ( ResourceFile rf,
const xstring name 

Construct a sound Stream by decoding audio from resource file.

Member Function Documentation

void SDLPP::SoundStream::play (  ) 

Start playback of this sound stream.

void SDLPP::SoundStream::stop (  ) 

Stop playback of this stream

The documentation for this class was generated from the following files:
Generated on Wed May 26 17:41:01 2010 for SDLPP by  doxygen 1.6.3