MainFX:
Filter:
Classes (extension) | Control > Effects

MainFX : Object
ExtensionExtension

a configurable chain of effects on the main outputs of a server
Source: MainFX.sc
Subclasses: MasterFX

Description

A MainFX can apply effects to the main output channels of a server. One can only make a single MainFX for each server. Each mainFX contains a ProxyChain which handles the named effects slots and their state.

Note that MainFX can be used with ProxyChainPreset, see ProxyChainPreset, in the bottom examples.

NOTE: that MainFX used to be called MasterFX - please rename all uses of it to MainFX.

First examples:

Class Methods

MainFX.all

dictionary for all mainFX, one per server.

MainFX.default

the MainFX instance for the default server.

MainFX.maxNumChans

the maximum number of channels supported. (currently unused)

MainFX.clear(name)

clear the mainFX at name

Arguments:

name

MainFX.new(server, numChannels, slotNames, busIndex)

Arguments:

server

the server on which the MainFX chain will run; default is server.numOutputBusChannels

numChannels

the number of channels it will work on

slotNames

the names of the filters/functions to be used, in order of execution;

busIndex

the bus index where it will process audio.

Inherited class methods

Instance Methods

.key

the key at which the mainFX is stored; usually this is the server name.

.proxyChain

the ProxyChain that has the order of the effects that can be used

.proxy

the NodeProxy inside the the proxyChain.

Methods that get forwarded to proxyChain/proxy:

.add(key, wet, func)

kick in effect

Arguments:

key

name of effect

wet

wet-level of effect

func

an optional func that can locally replace the global func with that name.

.remove(key)

kick out effect

Arguments:

key

name of effect

.set( ... args)

set named parameters of the active slots

.slotsInUse

get the currently used slots of the proxyChain

.slotNames

.slotNames = argSlotNames

get and set the slotNames of the proxyChain

.server

the server on which this MainFX operates

.numChannels

the number of output channels of the MainFX

.busIndex

the index of the bus on which the MainFX operates

.group

the group in which this mainFX proxy runs. this is after the default group.

.checkingBadValues

flag whether the mainFX is checking the final output for bad values. see also CheckBadValues

.checkBad(flag)

set flag whether to check final output, and if needed start the synth

.badSynth

the synth that does the bad value checking.

.wakeUp

Wake up the MainFX proxy. This happens automatically after CmdPeriod.

.clear

clear this MainFX; usually so one can remake it.

.pxChain

alias for the proxyChain (the proxyChain inst var was called pxChain earlier).

.show

.hide

show or hide the MainFX proxy in Ndef.all for that server. the proxy is hidden by default.

.gui(name, numItems, buttonList, parent, bounds, makeSkip: true)

make a MainFXGui for the MainFX.

Arguments:

name

the name the gui will show

numItems

the number of buttons / sliders for parameters the gui will have

buttonList

an optional list of buttons. by default, this is the list of slotNames.

parent

the parent view or window on which to place the gui

bounds

the bounds of the gui

makeSkip

a flag whether to make and start a skipjack for the gui update mechanism.

Inherited instance methods

Undocumented instance methods

.doOnServerTree

.init2(inServer, inNumChannels, inSlotNames, inBusIndex)

Examples