Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members

portaudio::DirectionSpecificStreamParameters Class Reference

#include <DirectionSpecificStreamParameters.hxx>

List of all members.


Detailed Description

All parameters for one direction (either in or out) of a Stream. Together with parameters common to both directions, two DirectionSpecificStreamParameters can make up a StreamParameters object which contains all parameters for a Stream.


Public Member Functions

 DirectionSpecificStreamParameters ()
 DirectionSpecificStreamParameters (const Device &device, int numChannels, SampleDataFormat format, bool interleaved, PaTime suggestedLatency, void *hostApiSpecificStreamInfo)
void setDevice (const Device &device)
void setNumChannels (int numChannels)
void setSampleFormat (SampleDataFormat format, bool interleaved=true)
void setHostApiSpecificSampleFormat (PaSampleFormat format, bool interleaved=true)
void setSuggestedLatency (PaTime latency)
void setHostApiSpecificStreamInfo (void *streamInfo)
PaStreamParameters * paStreamParameters ()
const PaStreamParameters * paStreamParameters () const
Devicedevice () const
int numChannels () const
SampleDataFormat sampleFormat () const
bool isSampleFormatInterleaved () const
bool isSampleFormatHostApiSpecific () const
PaSampleFormat hostApiSpecificSampleFormat () const
PaTime suggestedLatency () const
void * hostApiSpecificStreamInfo () const

Static Public Member Functions

DirectionSpecificStreamParameters null ()

Private Attributes

PaStreamParameters paStreamParameters_


Constructor & Destructor Documentation

portaudio::DirectionSpecificStreamParameters::DirectionSpecificStreamParameters  ) 
 

Default constructor -- all parameters will be uninitialized.

portaudio::DirectionSpecificStreamParameters::DirectionSpecificStreamParameters const Device device,
int  numChannels,
SampleDataFormat  format,
bool  interleaved,
PaTime  suggestedLatency,
void *  hostApiSpecificStreamInfo
 

Constructor which sets all required fields.


Member Function Documentation

DirectionSpecificStreamParameters portaudio::DirectionSpecificStreamParameters::null  )  [static]
 

Returns a `nil' DirectionSpecificStreamParameters object. This can be used to specify that one direction of a Stream is not required (i.e. when creating a half-duplex Stream). All fields of the null DirectionSpecificStreamParameters object are invalid except for the device and the number of channel, which are set to paNoDevice and 0 respectively.

void portaudio::DirectionSpecificStreamParameters::setDevice const Device device  ) 
 

void portaudio::DirectionSpecificStreamParameters::setNumChannels int  numChannels  ) 
 

void portaudio::DirectionSpecificStreamParameters::setSampleFormat SampleDataFormat  format,
bool  interleaved = true
 

void portaudio::DirectionSpecificStreamParameters::setHostApiSpecificSampleFormat PaSampleFormat  format,
bool  interleaved = true
 

void portaudio::DirectionSpecificStreamParameters::setSuggestedLatency PaTime  latency  ) 
 

void portaudio::DirectionSpecificStreamParameters::setHostApiSpecificStreamInfo void *  streamInfo  ) 
 

PaStreamParameters * portaudio::DirectionSpecificStreamParameters::paStreamParameters  ) 
 

const PaStreamParameters * portaudio::DirectionSpecificStreamParameters::paStreamParameters  )  const
 

Device & portaudio::DirectionSpecificStreamParameters::device  )  const
 

int portaudio::DirectionSpecificStreamParameters::numChannels  )  const
 

SampleDataFormat portaudio::DirectionSpecificStreamParameters::sampleFormat  )  const
 

Returns the (non host api-specific) sample format, without including the paNonInterleaved flag. If the sample format is host api-spefific, INVALID_FORMAT (0) will be returned.

bool portaudio::DirectionSpecificStreamParameters::isSampleFormatInterleaved  )  const
 

bool portaudio::DirectionSpecificStreamParameters::isSampleFormatHostApiSpecific  )  const
 

PaSampleFormat portaudio::DirectionSpecificStreamParameters::hostApiSpecificSampleFormat  )  const
 

Returns the host api-specific sample format, without including any paCustomFormat or paNonInterleaved flags. Will return 0 if the sample format is not host api-specific.

PaTime portaudio::DirectionSpecificStreamParameters::suggestedLatency  )  const
 

void * portaudio::DirectionSpecificStreamParameters::hostApiSpecificStreamInfo  )  const
 


Member Data Documentation

PaStreamParameters portaudio::DirectionSpecificStreamParameters::paStreamParameters_ [private]
 


The documentation for this class was generated from the following files:
Generated on Fri Apr 2 20:22:48 2004 for PortAudioCpp by doxygen 1.3.6