List of all members | Public Member Functions | Public Attributes
AuxEffect Class Reference

an Auxilliary Bus Container for multiple InsertEffect More...

+ Inheritance diagram for AuxEffect:

Public Member Functions

InsertEffect getInsert (int index)
 get the insert fx at the given index
 
Value getParameter (string parameter)
 Gets an Element parameter. More...
 
table getParameterConnections (string parameter)
 Get all SignalConnection for this parameter. More...
 
bool hasParameter (string parameter)
 
void setParameter (string parameter, Value value)
 Sets an Element parameter. More...
 

Public Attributes

table children
 element children using the element name as key
 
string displayName
 name to display on the User Interface, name is used if displayName is not specified.
 
table inserts
 all InsertEffect for this node
 
string name
 internal element name
 
int numInserts
 the number of insert FXs for this node
 
int numParams
 number of parameters
 
table parameterDefinitions
 table of parameter definitions. More...
 
Elementparent
 element parent
 
string type
 internal element type
 

Detailed Description

an Auxilliary Bus Container for multiple InsertEffect

Member Function Documentation

void Element::setParameter ( string  parameter,
Value  value 
)
inherited

Sets an Element parameter.

Parameters
parameterparameterName or parameterId
valueparameterValue (number|bool|string) according to definition
See Also
Elements & parameters
Value Element::getParameter ( string  parameter)
inherited

Gets an Element parameter.

Parameters
parameterparameterName or parameterId
Returns
parameterValue (number|bool|string) according to definition
See Also
Elements & parameters
bool Element::hasParameter ( string  parameter)
inherited
Parameters
parameterparameterName or parameterId
Returns
true or false
See Also
Elements & parameters
table Element::getParameterConnections ( string  parameter)
inherited

Get all SignalConnection for this parameter.

Parameters
parameterparameterName or parameterId
Returns
table of parameter connections
See Also
Elements & parameters

Member Data Documentation

table Element::parameterDefinitions
inherited

table of parameter definitions.

returns the following table:

property type optional
id number no
type "int","float","bool","string" no
default type no
displayName string no
description string no
readOnly number no
serialize boolean no
min type yes
max type yes