Public Member Functions | Public Attributes

AuxEffect Class Reference
[Engine]

an Auxilliary Bus Container for multiple InsertEffect More...

Inheritance diagram for AuxEffect:
Element

List of all members.

Public Member Functions

 getParameter (string parameter)
 Gets an Element parameter.
table getParameterConnections (string parameter)
 Get all SignalConnection for this parameter.
bool hasParameter (string parameter)
 setParameter (string parameter, Value value)
 Sets an Element parameter.

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 numParams
 number of parameters
table parameterDefinitions
 table of parameter definitions { {name:string, id:int, type:"int"|"float"|"bool"|"string", default:type, displayName:string, description:string, readOnly:bool, serialize:bool, [min:type], [max:type]} }
Element parent
 element parent
string type
 internal element type

Detailed Description

an Auxilliary Bus Container for multiple InsertEffect


Member Function Documentation

Element::setParameter ( string  parameter,
Value  value 
) [inherited]

Sets an Element parameter.

Parameters:
parameter parameterName or parameterId
value parameterValue (number|bool|string) according to definition
See also:
Elements & parameters
Element::getParameter ( string  parameter  )  [inherited]

Gets an Element parameter.

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

Get all SignalConnection for this parameter.

Parameters:
parameter parameterName or parameterId
Returns:
table of parameter connections
See also:
Elements & parameters