CsoundChannelList Class Reference

#include <cs_glue.hpp>

Collaboration diagram for CsoundChannelList:

Collaboration graph
[legend]

Detailed Description

CsoundChannelList(CSOUND *) CsoundChannelList(Csound *)

Creates an alphabetically sorted list of named channels of a Csound instance. Should be called after csoundCompile() or Csound::Compile().

Public Member Functions

int Count ()
const char * Name (int ndx)
int Type (int ndx)
int IsControlChannel (int ndx)
int IsAudioChannel (int ndx)
int IsStringChannel (int ndx)
int IsInputChannel (int ndx)
int IsOutputChannel (int ndx)
int SubType (int ndx)
double DefaultValue (int ndx)
double MinValue (int ndx)
double MaxValue (int ndx)
void Clear ()
 CsoundChannelList (CSOUND *csound)
 CsoundChannelList (Csound *csound)
 ~CsoundChannelList ()

Private Member Functions

void ResetVariables ()
int GetChannelMetaData (int ndx, MYFLT &dflt, MYFLT &min, MYFLT &max)

Private Attributes

CsoundChannelListEntrylst
int cnt
CSOUNDcsound


Constructor & Destructor Documentation

CsoundChannelList::CsoundChannelList ( CSOUND csound  ) 

CsoundChannelList::CsoundChannelList ( Csound *  csound  ) 

CsoundChannelList::~CsoundChannelList (  ) 


Member Function Documentation

void CsoundChannelList::ResetVariables (  )  [private]

int CsoundChannelList::GetChannelMetaData ( int  ndx,
MYFLT &  dflt,
MYFLT &  min,
MYFLT &  max 
) [private]

int CsoundChannelList::Count (  ) 

Returns the number of channels (-1 if there is no list).

const char* CsoundChannelList::Name ( int  ndx  ) 

Returns the name of the channel at index 'ndx' (counting from zero), or NULL if the index is out of range.

int CsoundChannelList::Type ( int  ndx  ) 

Returns the type of the channel at index 'ndx' (counting from zero), or -1 if the index is out of range.

int CsoundChannelList::IsControlChannel ( int  ndx  ) 

Returns 1 if the channel at index 'ndx' (counting from zero) exists and is a control channel, and 0 otherwise.

int CsoundChannelList::IsAudioChannel ( int  ndx  ) 

Returns 1 if the channel at index 'ndx' (counting from zero) exists and is an audio channel, and 0 otherwise.

int CsoundChannelList::IsStringChannel ( int  ndx  ) 

Returns 1 if the channel at index 'ndx' (counting from zero) exists and is a string channel, and 0 otherwise.

int CsoundChannelList::IsInputChannel ( int  ndx  ) 

Returns 1 if the channel at index 'ndx' (counting from zero) exists and the input bit is set, and 0 otherwise.

int CsoundChannelList::IsOutputChannel ( int  ndx  ) 

Returns 1 if the channel at index 'ndx' (counting from zero) exists and the output bit is set, and 0 otherwise.

int CsoundChannelList::SubType ( int  ndx  ) 

Returns the sub-type (0: normal, 1: integer, 2: linear, 3: exponential) of the control channel at index 'ndx' (counting from zero), or -1 if the channel does not exist or is not a control channel.

double CsoundChannelList::DefaultValue ( int  ndx  ) 

Returns the default value set for the control channel at index 'ndx' (counting from zero), or 0.0 if the channel does not exist, is not a control channel, or has no default value.

double CsoundChannelList::MinValue ( int  ndx  ) 

Returns the minimum value set for the control channel at index 'ndx' (counting from zero), or 0.0 if the channel does not exist, is not a control channel, or has no minimum value.

double CsoundChannelList::MaxValue ( int  ndx  ) 

Returns the maximum value set for the control channel at index 'ndx' (counting from zero), or 0.0 if the channel does not exist, is not a control channel, or has no maximum value.

void CsoundChannelList::Clear (  ) 

Releases the memory used by the channel list. Should be called before the Csound instance is destroyed or reset.


Field Documentation

int CsoundChannelList::cnt [private]


Generated on Sun Nov 9 00:08:07 2008 for Csound and CsoundAC by  doxygen 1.5.6