Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial
#include <WvIn.h>
Inheritance diagram for WvIn:
This class provides common functionality for a variety of audio data input subclasses.
WvIn supports multi-channel data. It is important to distinguish the tick() methods, which return samples produced by averaging across sample frames, from the tickFrame() methods, which return references or pointers to multi-channel sample frames.
Both interleaved and non-interleaved data is supported via the use of StkFrames objects.
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
Public Member Functions | |
WvIn () | |
Default constructor. | |
virtual | ~WvIn () |
Class destructor. | |
unsigned int | getChannels (void) const |
Return the number of audio channels in the data. | |
StkFloat | lastOut (void) const |
Return the average across the last output sample frame. | |
const StkFrames & | lastFrame (void) const |
Return an StkFrames reference to the last output sample frame. | |
StkFloat | tick (void) |
Read out the average across one sample frame of data. | |
StkFrames & | tick (StkFrames &frames, unsigned int channel=0) |
Fill a channel of the StkFrames object with averaged sample frames. | |
StkFrames & | tickFrame (StkFrames &frames) |
Fill the StkFrames argument with data and return the same reference. |
|
Return the average across the last output sample frame. If no file data is loaded, the returned value is 0.0. |
|
Return an StkFrames reference to the last output sample frame. If no file data is loaded, an empty container is returned. |
|
Read out the average across one sample frame of data. If no file data is loaded, the returned value is 0.0. |
|
Fill a channel of the StkFrames object with averaged sample frames.
The |
|
Fill the StkFrames argument with data and return the same reference. An StkError will be thrown if there is an incompatability between the number of channels in the loaded data and that in the StkFrames argument. If no file data is loaded, the container is filled with zeroes. |
The Synthesis ToolKit in C++ (STK) |
©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved. |