Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


WvOut Class Reference

#include <WvOut.h>

Inheritance diagram for WvOut:

Stk FileWvOut InetWvOut RtWvOut List of all members.

Detailed Description

STK audio output abstract base class.

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

WvOut supports multi-channel data. It is important to distinguish the tick() methods, which output single samples to all channels in a sample frame, from the tickFrame() methods, which take a pointer or reference to multi-channel sample frame data.

Both interleaved and non-interleaved data is supported via the use of StkFrames objects.

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

by Perry R. Cook and Gary P. Scavone, 1995 - 2007.


Public Member Functions

 WvOut ()
 Default constructor.
virtual ~WvOut ()
 Class destructor.
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.
void tick (const StkFloat sample)
 Output a single sample to all channels in a sample frame.
void tick (const StkFrames &frames, unsigned int channel=0)
 Output a channel of the StkFrames object to all channels of the WvOut object.
void tickFrame (const StkFrames &frames)
 Output the StkFrames data.


Member Function Documentation

void WvOut::tick const StkFloat  sample  ) 
 

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

An StkError is thrown if an output error occurs.

void WvOut::tick const StkFrames frames,
unsigned int  channel = 0
 

Output a channel of the StkFrames object to all channels of the WvOut object.

The channel argument should be 0 or greater (the first channel is specified by 0). An StkError will be thrown if an output error occurs or if the channel argument is equal to or greater than the number of channels in the StkFrames object.

void WvOut::tickFrame const StkFrames frames  ) 
 

Output the StkFrames data.

An StkError will be thrown if an output error occurs or if there is an incompatability between the number of channels in the WvOut object and that in the StkFrames object.


The documentation for this class was generated from the following file:
The Synthesis ToolKit in C++ (STK)
©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.