mcs.gate~ Reference

Route a signal to a channel within a multi-channel output

mcs.gate~

Description

Use gate~ to route an input signal at the second inlet to one of several outlets, or to no outlet at all. When there is only one outlet (the default case), it acts as a simple switch. Unlike the Max gate object, any outlet which is not selected outputs a signal composed of zero values.
When the gate~ object is created as mcs.gate~ all of its signal outlets are combined into a single multichannel outlet. The behavior of mcs.gate~ is analogous to gate~.

Arguments

number-of-outlets [int]

Optional

Number of outlets

initial-open-outlet [int]

Optional

Set the outlet that is initially selected. If 0, all signals are shut off and zero signals are sent out all outlets.

Attributes

ramptime [float] (default: 0.)

Sets the ramp time to use for fading connections in milliseconds. When the ramptime attribute is non-zero, gate~ will crossfade between channels of the output when the connection is switched, fading out the channel that was previous active and fading in the channel that is becoming active.

stepmode [int] (default: 0)

When enabled, all whole-number changes to a signal value in the left inlet (either increasing and decreasing) will increment the active output channel by 1, wrapping accross the available outlets. A value of zero will stop output.

Common Box Attributes

Messages

bang

Same as the next message

int

Arguments

outlet-selected [int]
If the number is 0 or negative a zero signal is sent out all channels. If the number is greater than the number of channels, the signal is sent to the last channel. If a signal is connected to the left inlet, gate~ ignores int or float messages.

float

Float input is truncated and, like the int message, selects the destination outlet for the signal in the right inlet

next

Sending the next message to the left inlet zeroes the current channel and opens the next one, wrapping accross all channels. If all channels are currently closed or the last channel is currenty open, channel 1 will be opened.

signal

In left inlet: Selects destination output channel for the input. If the number is 0 or negative, all channels will be zero. If the number is greater than the number of outlets, the signal is sent to the highest numbered channel. If a signal is connected to the left inlet, gate~ ignores int or float messages.

In right inlet: The input signal to be passed through to one of channels of the outlet multi-channel signal, according to the most recently received int or float in the left inlet, or the value of the signal coming in the left inlet.

Output

multi-channel signal

Depending on the value of the left inlet (either signal or number), one of the channels in the output will send out the input signal and rest will send out zero signals, or (if the inlet is closed) all channels will send out zero signals.

See Also

Name Description
crosspatch
gate
matrix~
gate~
selector~
MSP Basics Tutorial 4: Routing Signals MSP Basics Tutorial 4: Routing Signals
MSP Panning Tutorial 1: Simple panning MSP Panning Tutorial 1: Simple panning