stk::WvOut Class Reference

STK audio output abstract base class. More...

#include <WvOut.h>

Inheritance diagram for stk::WvOut:

Public Member Functions
	WvOut (void)
	Default constructor.
unsigned long	getFrameCount (void) const
	Return the number of sample frames output.
StkFloat	getTime (void) const
	Return the number of seconds of data output.
bool	clipStatus (void)
	Returns true if clipping has been detected during output since instantiation or the last reset.
void	resetClipStatus (void)
	Reset the clipping status to false.
virtual void	tick (const StkFloat sample)=0
	Output a single sample to all channels in a sample frame.
virtual void	tick (const StkFrames &frames)=0
	Output the StkFrames data.
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.

Additional Inherited Members
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.
static void	clear_alertList ()
	Static method that frees memory from alertList_.
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
static const StkFormat	STK_SINT16
static const StkFormat	STK_SINT24
static const StkFormat	STK_SINT32
static const StkFormat	STK_FLOAT32
static const StkFormat	STK_FLOAT64
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.

Detailed Description

STK audio output abstract base class.

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

Currently, WvOut is non-interpolating and the output rate is always Stk::sampleRate().

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

Member Function Documentation

tick()

virtual void stk::WvOut::tick ( const StkFloat  sample )

pure virtual

Output a single sample to all channels in a sample frame.

An StkError is thrown if an output error occurs.

Implemented in stk::FileWvOut, stk::InetWvOut, and stk::RtWvOut.

---

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

• WvOut.h