|
Csound and CsoundAC API
5.17
|
CsoundChannelList(CSOUND *) CsoundChannelList(Csound *) More...
#include <cs_glue.hpp>
Public Member Functions | |
| void | Clear () |
| Releases the memory used by the channel list. | |
| int | Count () |
| Returns the number of channels (-1 if there is no list). | |
| CsoundChannelList (CSOUND *csound) | |
| CsoundChannelList (Csound *csound) | |
| double | 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. | |
| int | IsAudioChannel (int ndx) |
| Returns 1 if the channel at index 'ndx' (counting from zero) exists and is an audio channel, and 0 otherwise. | |
| int | IsControlChannel (int ndx) |
| Returns 1 if the channel at index 'ndx' (counting from zero) exists and is a control channel, and 0 otherwise. | |
| int | 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 | 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 | IsStringChannel (int ndx) |
| Returns 1 if the channel at index 'ndx' (counting from zero) exists and is a string channel, and 0 otherwise. | |
| double | 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. | |
| double | 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. | |
| const char * | 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 | 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. | |
| int | Type (int ndx) |
| Returns the type of the channel at index 'ndx' (counting from zero), or -1 if the index is out of range. | |
| ~CsoundChannelList () | |
Private Member Functions | |
| int | GetChannelMetaData (int ndx, MYFLT &dflt, MYFLT &min, MYFLT &max) |
| void | ResetVariables () |
Private Attributes | |
| int | cnt |
| CSOUND * | csound |
| CsoundChannelListEntry * | lst |
CsoundChannelList(CSOUND *) CsoundChannelList(Csound *)
Creates an alphabetically sorted list of named channels of a Csound instance. Should be called after csoundCompile() or Csound::Compile().
| CsoundChannelList::CsoundChannelList | ( | CSOUND * | csound | ) |
| CsoundChannelList::CsoundChannelList | ( | Csound * | csound | ) |
| void CsoundChannelList::Clear | ( | ) |
Releases the memory used by the channel list.
Should be called before the Csound instance is destroyed or reset.
| int CsoundChannelList::Count | ( | ) |
Returns the number of channels (-1 if there is no list).
| 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.
| int CsoundChannelList::GetChannelMetaData | ( | int | ndx, |
| MYFLT & | dflt, | ||
| MYFLT & | min, | ||
| MYFLT & | max | ||
| ) | [private] |
| 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::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::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::IsStringChannel | ( | int | ndx | ) |
Returns 1 if the channel at index 'ndx' (counting from zero) exists and is a string channel, and 0 otherwise.
| 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.
| 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.
| 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.
| void CsoundChannelList::ResetVariables | ( | ) | [private] |
| 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.
| 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::cnt [private] |
CSOUND* CsoundChannelList::csound [private] |
CsoundChannelListEntry* CsoundChannelList::lst [private] |
1.7.6.1