stk::WvIn Class Reference

STK audio input abstract base class. More...

#include <WvIn.h>

Inheritance diagram for stk::WvIn:

Public Member Functions
unsigned int	channelsOut (void) const
	Return the number of audio channels in the data or stream.
const StkFrames &	lastFrame (void) const
	Return an StkFrames reference to the last computed sample frame. More...
virtual StkFloat	tick (unsigned int channel=0)=0
	Compute one sample frame and return the specified channel value.
virtual StkFrames &	tick (StkFrames &frames)=0
	Fill the StkFrames argument with computed frames and return the same reference.
Public Member Functions inherited from stk::Stk
void	ignoreSampleRateChange (bool ignore=true)
	A function to enable/disable the automatic updating of class data when the STK sample rate changes. More...

Protected Attributes
StkFrames	data_
StkFrames	lastFrame_
Protected Attributes inherited from stk::Stk
bool	ignoreSampleRateChange_

Additional Inherited Members
Public Types inherited from stk::Stk
typedef unsigned long	StkFormat
Static Public Member Functions inherited from stk::Stk
static StkFloat	sampleRate (void)
	Static method that returns the current STK sample rate.
static void	setSampleRate (StkFloat rate)
	Static method that sets the STK sample rate. More...
static std::string	rawwavePath (void)
	Static method that returns the current rawwave path.
static void	setRawwavePath (std::string path)
	Static method that sets the STK rawwave path.
static void	swap16 (unsigned char *ptr)
	Static method that byte-swaps a 16-bit data type.
static void	swap32 (unsigned char *ptr)
	Static method that byte-swaps a 32-bit data type.
static void	swap64 (unsigned char *ptr)
	Static method that byte-swaps a 64-bit data type.
static void	sleep (unsigned long milliseconds)
	Static cross-platform method to sleep for a number of milliseconds.
static bool	inRange (StkFloat value, StkFloat min, StkFloat max)
	Static method to check whether a value is within a specified range.
static void	handleError (const char *message, StkError::Type type)
	Static function for error reporting and handling using c-strings.
static void	handleError (std::string message, StkError::Type type)
	Static function for error reporting and handling using c++ strings.
static void	showWarnings (bool status)
	Toggle display of WARNING and STATUS messages.
static void	printErrors (bool status)
	Toggle display of error messages before throwing exceptions.
Static Public Attributes inherited from stk::Stk
static const StkFormat	STK_SINT8 = 0x1
static const StkFormat	STK_SINT16 = 0x2
static const StkFormat	STK_SINT24 = 0x4
static const StkFormat	STK_SINT32 = 0x8
static const StkFormat	STK_FLOAT32 = 0x10
static const StkFormat	STK_FLOAT64 = 0x20
Protected Member Functions inherited from stk::Stk
	Stk (void)
	Default constructor.
virtual	~Stk (void)
	Class destructor.
virtual void	sampleRateChanged (StkFloat newRate, StkFloat oldRate)
	This function should be implemented in subclasses that depend on the sample rate.
void	addSampleRateAlert (Stk *ptr)
	Add class pointer to list for sample rate change notification.
void	removeSampleRateAlert (Stk *ptr)
	Remove class pointer from list for sample rate change notification.
void	handleError (StkError::Type type) const
	Internal function for error reporting that assumes message in oStream_ variable.
Static Protected Attributes inherited from stk::Stk
static std::ostringstream	oStream_

Detailed Description

STK audio input abstract base class.

This class provides common functionality for a variety of audio data input subclasses.

by Perry R. Cook and Gary P. Scavone, 1995–2014.

Member Function Documentation

const StkFrames& stk::WvIn::lastFrame ( void  ) const

inline

Return an StkFrames reference to the last computed sample frame.

If no file data is loaded, an empty container is returned.

---

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

• Pd++Classes/STK-AudioFile/WvIn.h