Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


InetWvOut Class Reference

#include <InetWvOut.h>

Inheritance diagram for InetWvOut:

WvOut Stk List of all members.

Detailed Description

STK internet streaming output class.

This WvOut subclass can stream data over a network via a TCP or UDP socket connection. The data is converted to big-endian byte order, if necessary, before being transmitted.

InetWvOut 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() method, which takes a reference to multi-channel sample frame data.

This class connects to a socket server, the port and IP address of which must be specified as constructor arguments. The default data type is signed 16-bit integers but any of the defined StkFormats are permissible.

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


Public Member Functions

 InetWvOut (unsigned long packetFrames=1024)
 Default constructor ... the socket is not instantiated.
 InetWvOut (int port, Socket::ProtocolType protocol=Socket::PROTO_TCP, std::string hostname="localhost", unsigned int nChannels=1, Stk::StkFormat format=STK_SINT16, unsigned long packetFrames=1024)
 Overloaded constructor which opens a network connection during instantiation.
 ~InetWvOut ()
 Class destructor.
void connect (int port, Socket::ProtocolType protocol=Socket::PROTO_TCP, std::string hostname="localhost", unsigned int nChannels=1, Stk::StkFormat format=STK_SINT16)
 Connect to the specified host and port and prepare to stream nChannels of data in the given data format.
void disconnect (void)
 If a connection is open, write out remaining samples in the queue and then disconnect.


Constructor & Destructor Documentation

InetWvOut::InetWvOut int  port,
Socket::ProtocolType  protocol = Socket::PROTO_TCP,
std::string  hostname = "localhost",
unsigned int  nChannels = 1,
Stk::StkFormat  format = STK_SINT16,
unsigned long  packetFrames = 1024
 

Overloaded constructor which opens a network connection during instantiation.

An StkError is thrown if a socket error occurs or an invalid argument is specified.


Member Function Documentation

void InetWvOut::connect int  port,
Socket::ProtocolType  protocol = Socket::PROTO_TCP,
std::string  hostname = "localhost",
unsigned int  nChannels = 1,
Stk::StkFormat  format = STK_SINT16
 

Connect to the specified host and port and prepare to stream nChannels of data in the given data format.

An StkError is thrown if a socket error occurs or an invalid argument is specified.


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.