Home Information Classes Download Usage Mail List Requirements Links Tutorial

# RtDuplex Class Reference

STK realtime audio input/output class. More...

`#include <RtDuplex.h>`

Inheritance diagram for RtDuplex:

List of all members.

## Public Member Functions

| RtDuplex (int nChannels=1, MY_FLOAT sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=2)
| Default constructor.
| ~RtDuplex ()
| Class destructor.
void | start (void)
| Start the audio input/output stream.
void | stop (void)
| Stop the audio input/output stream.
MY_FLOAT | lastOut (void) const
| Return the average across the last output sample frame.
MY_FLOAT | tick (const MY_FLOAT sample)
| Output a single sample to all channels in a sample frame and return the average across one new input sample frame of data.
MY_FLOAT * | tick (MY_FLOAT *vector, unsigned int vectorSize)
| Output each sample in to all channels per frame and return averaged input sample frames of new data in vector.
const MY_FLOAT * | lastFrame (void) const
| Return a pointer to the last output sample frame.
MY_FLOAT * | tickFrame (MY_FLOAT *frameVector, unsigned int frames=1)
| Output sample frames from frameVector and return new input frames in frameVector.

## Detailed Description

STK realtime audio input/output class.

This class provides a simplified interface to RtAudio for realtime audio input/output. It is also possible to achieve duplex operation using separate RtWvIn and RtWvOut classes, but this class ensures better input/output syncronization.

RtDuplex supports multi-channel data in interleaved format. It is important to distinguish the tick() methods, which output single samples to all channels in a sample frame and return samples produced by averaging across sample frames, from the tickFrame() methods, which take/return pointers to multi-channel sample frames.

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

Definition at line 30 of file RtDuplex.h.

## Constructor & Destructor Documentation

RtDuplex::RtDuplex | ( | int | nChannels = 1,
|  | MY_FLOAT | sampleRate = Stk::sampleRate(),
|  | int | device = 0,
|  | int | bufferFrames = RT_BUFFER_SIZE,
|  | int | nBuffers = 2
| ) |

Default constructor.

The device argument is passed to RtAudio during instantiation. The default value (zero) will select the default device on your system or the first device found meeting the specified parameters. On systems with multiple soundcards/devices, values greater than zero can be specified in accordance with the order that the devices are enumerated by the underlying audio API. The default buffer size of RT_BUFFER_SIZE is defined in Stk.h. An StkError will be thrown if an error occurs duing instantiation.

## Member Function Documentation

void RtDuplex::start | ( | void |  | ) |

| Start the audio input/output stream. The stream is started automatically, if necessary, when a tick() or tickFrame method is called.

void RtDuplex::stop | ( | void |  | ) |

| Stop the audio input/output stream. It may be necessary to use this method to avoid audio overflow/underflow problems if you wish to temporarily stop the audio stream.

MY_FLOAT RtDuplex::tick | ( | const MY_FLOAT | sample | ) |

| Output a single sample to all channels in a sample frame and return the average across one new input sample frame of data. An StkError will be thrown if an error occurs during input/output.

MY_FLOAT* RtDuplex::tick | ( | MY_FLOAT * | vector,
|  | unsigned int | vectorSize
| ) |

| Output each sample in to all channels per frame and return averaged input sample frames of new data in vector. An StkError will be thrown if an error occurs during input/output.

MY_FLOAT* RtDuplex::tickFrame | ( | MY_FLOAT * | frameVector,
|  | unsigned int | frames = 1
| ) |

| Output sample frames from frameVector and return new input frames in frameVector. An StkError will be thrown if an error occurs during input/output.

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

- RtDuplex.h

The Synthesis ToolKit in C++ (STK)
©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.