openalpp::FileStream Class Reference

#include <filestream.h>

Inheritance diagram for openalpp::FileStream:

openalpp::Stream openalpp::SoundData openalpp::AudioBase openalpp::Referenced List of all members.

Public Member Functions

 FileStream (const std::string &filename, const int buffersize=4096) throw (NameError,InitError,FileError)
 FileStream (const FileStream &stream)
FileStreamoperator= (const FileStream &stream)
void setLooping (bool loop=true)

Protected Member Functions

virtual ~FileStream ()

Protected Attributes

OggVorbis_File * oggfile

Detailed Description

Class for streaming audio data from a file. Presently it supports Ogg Vorbis files (http://www.vorbis.com/).


Constructor & Destructor Documentation

openalpp::FileStream::FileStream const std::string &  filename,
const int  buffersize = 4096
throw (NameError,InitError,FileError)
 

Constructor. A FileError will be thrown if the file can't be opened or isn't recognized.

Parameters:
filename is the name of the file to try to open.
buffersize is an optional parameter specifying how large the buffer should be (in samples per second).

openalpp::FileStream::FileStream const FileStream stream  ) 
 

Copy constructor.

virtual openalpp::FileStream::~FileStream  )  [protected, virtual]
 

Destructor.


Member Function Documentation

FileStream& openalpp::FileStream::operator= const FileStream stream  ) 
 

void openalpp::FileStream::setLooping bool  loop = true  ) 
 

Turn on/off looping.

Parameters:
loop is true if the stream should loop, false otherwise.


Member Data Documentation

OggVorbis_File* openalpp::FileStream::oggfile [protected]
 


The documentation for this class was generated from the following file:
Generated on Thu May 18 00:49:38 2006 for openalpp by  doxygen 1.4.6