Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


TcpWvIn Class Reference

#include <TcpWvIn.h>

Inheritance diagram for TcpWvIn:

WvIn Stk List of all members.

Detailed Description

STK internet streaming input class.

This protected Wvin subclass can read streamed data over a network via a TCP socket connection. The data is assumed in big-endian, or network, byte order.

TcpWvIn supports multi-channel data in interleaved format. It is important to distinguish the tick() methods, which return samples produced by averaging across sample frames, from the tickFrame() methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.

This class starts a socket server, which waits for a single remote connection. The default data type for the incoming stream is signed 16-bit integers, though any of the defined StkFormats are permissible.

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

Definition at line 42 of file TcpWvIn.h.

Public Member Functions

 TcpWvIn (int port=2006)
 Default constructor starts a socket server. If not specified, the server is associated with port 2006.

 ~TcpWvIn ()
 Class destructor.

void listen (unsigned int nChannels=1, Stk::StkFormat format=STK_SINT16)
 Listen for a (new) connection with specified data channels and format.

bool isConnected (void)
 Returns true is an input connection exists or input data remains in the queue.

StkFloat lastOut (void) const
 Return the average across the last output sample frame.

StkFloat tick (void)
 Read out the average across one sample frame of data.

StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Read out vectorSize averaged sample frames of data in vector.

StkFramestick (StkFrames &frames, unsigned int channel=1)
 Fill a channel of the StkFrames object with averaged sample frames.

const StkFloat * lastFrame (void) const
 Return a pointer to the last output sample frame.

const StkFloat * tickFrame (void)
 Return a pointer to the next sample frame of data.

StkFloat * tickFrame (StkFloat *frameVector, unsigned int frames)
 Read out sample frames of data to frameVector.

StkFramestickFrame (StkFrames &frames)
 Fill the StkFrames object with sample frames of data and return the same reference.


Constructor & Destructor Documentation

TcpWvIn::TcpWvIn int  port = 2006  ) 
 

Default constructor starts a socket server. If not specified, the server is associated with port 2006.

An StkError will be thrown if an error occurs while initializing the input thread or starting the socket server.


Member Function Documentation

void TcpWvIn::listen unsigned int  nChannels = 1,
Stk::StkFormat  format = STK_SINT16
 

Listen for a (new) connection with specified data channels and format.

An StkError will be thrown a socket error or an invalid function argument.

bool TcpWvIn::isConnected void   ) 
 

Returns true is an input connection exists or input data remains in the queue.

This method will not return false after an input connection has been closed until all buffered input data has been read out.

StkFrames& TcpWvIn::tick StkFrames frames,
unsigned int  channel = 1
[virtual]
 

Fill a channel of the StkFrames object with averaged sample frames.

The channel argument should be one or greater (the first channel is specified by 1). An StkError will be thrown if the channel argument is zero or it is greater than the number of channels in the StkFrames object.

Reimplemented from WvIn.

StkFrames& TcpWvIn::tickFrame StkFrames frames  )  [virtual]
 

Fill the StkFrames object with sample frames of data and return the same reference.

An StkError will be thrown if there is an incompatability between the number of channels in the TcpWvIn object and that in the StkFrames object.

Reimplemented from WvIn.


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