Emergency 2017 Dokumentation  v3.0.1
qsf::openal::OpenALStreamOgg Class Reference

OpenAL Ogg stream. More...

#include <OpenALStreamOgg.h>

Public Member Functions

 OpenALStreamOgg (ALuint openALSource, const OpenALAudioBuffer &openALAudioBuffer)
 Constructor. More...
 
virtual ~OpenALStreamOgg ()
 Destructor. More...
 
void processQueue ()
 
virtual bool init () override
 Initialize the stream for playback. More...
 
virtual bool isInitialized () const override
 Return whether or not the stream is currently initialized (and therefore running) More...
 
virtual void deInit () override
 De-initialize the stream (playback stopped) More...
 
virtual bool update () override
 Update the stream. More...
 
virtual Time getActiveBufferBaseTime () const override
 Returns the point-in-time where the currently playing buffer is beginning relatively to the overall start of the stream. More...
 
- Public Member Functions inherited from qsf::openal::OpenALStream
virtual ~OpenALStream ()
 Destructor. More...
 
ALuint getOpenALSource () const
 Return the OpenAL audio source using this stream. More...
 
const OpenALAudioBuffergetOpenALAudioBuffer () const
 Return the OpenAL audio buffer this stream is using. More...
 
bool isLooping () const
 Return whether the stream is looping or not. More...
 
void setLooping (bool looping)
 Set whether the stream is looping or not. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from qsf::FastPodAllocator< OpenALStreamOgg >
static void * operator new (size_t size)
 
static void operator delete (void *deletable, size_t size)
 
- Protected Member Functions inherited from qsf::openal::OpenALStream
 OpenALStream (ALuint openALSource, const OpenALAudioBuffer &openALAudioBuffer)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::FastPodAllocator< OpenALStreamOgg >
 ~FastPodAllocator ()
 

Detailed Description

OpenAL Ogg stream.

Remarks
Ogg Vorbis (or just OGG) is an open-source audio compression format similar to MP3. Actually, the file OGG-file format can contain other things, but let's just assume it is audio data in here. One of the biggest advantages it has over MP3 is that it is patent-free. This means you do not need to pay a license fee in order to encode or decode OGG files.
Todo:
  • TODO(co) Review background streaming, had to be hacked into for the first EMERGENCY 5 playable

Definition at line 45 of file OpenALStreamOgg.h.

Constructor & Destructor Documentation

qsf::openal::OpenALStreamOgg::OpenALStreamOgg ( ALuint  openALSource,
const OpenALAudioBuffer openALAudioBuffer 
)

Constructor.

Parameters
[in]openALSourceOpenAL audio source using this stream
[in]openALAudioBufferOpenAL audio buffer this stream is using
virtual qsf::openal::OpenALStreamOgg::~OpenALStreamOgg ( )
virtual

Destructor.

Member Function Documentation

virtual void qsf::openal::OpenALStreamOgg::deInit ( )
overridevirtual

De-initialize the stream (playback stopped)

Implements qsf::openal::OpenALStream.

virtual Time qsf::openal::OpenALStreamOgg::getActiveBufferBaseTime ( ) const
overridevirtual

Returns the point-in-time where the currently playing buffer is beginning relatively to the overall start of the stream.

Implements qsf::openal::OpenALStream.

virtual bool qsf::openal::OpenALStreamOgg::init ( )
overridevirtual

Initialize the stream for playback.

Returns
"true" if all went fine, else "false"

Implements qsf::openal::OpenALStream.

virtual bool qsf::openal::OpenALStreamOgg::isInitialized ( ) const
overridevirtual

Return whether or not the stream is currently initialized (and therefore running)

Returns
"true" if the stream is currently initialized, else "false"

Implements qsf::openal::OpenALStream.

void qsf::openal::OpenALStreamOgg::processQueue ( )
virtual bool qsf::openal::OpenALStreamOgg::update ( )
overridevirtual

Update the stream.

Returns
"true" if the stream is still active, else "false" (maybe finished)

Implements qsf::openal::OpenALStream.


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