Documentation Wiki rss-feed

Cycler

Name

Cycler:

1434
cycler

Description

The Cycler is responsible for damping and polyphony management within the Sampler Instruments. It is almost always used in conjunction with the AHDSR and Sampler Oscillator agents.

Ports

Activation input

  • Name:

1435 116
activation input

  • Input
  • Type: Number
  • Range: 0 to 1; default = 1

The activation input is used in the main to receive activation signals from an upstream Agent (most often a Scaler Agent's activation output in this case).

Pressure input

  • Name:

128 116
pressure input

  • Input
  • Type: Number
  • Range: 0 to 1

The pressure input is normally used to receive key pressure signals from upstream Agents (normally the Scaler's pressure output in this case) and processes them accordingly.

Roll input

  • Name:

131 116
roll input

  • Input
  • Type: Number
  • Range: -1 to 1

The roll input is normally used to receive key roll signals from upstream Agents (normally the Scaler's roll output in this case) and processes them accordingly.

Yaw input

  • Name:

132 116
yaw input

  • Input
  • Type: Number
  • Range: -1 to 1

The yaw input is normally used to receive key yaw signals from upstream Agents (normally the Scaler's yaw output and processes them accordingly.

Scale note input

  • Name:

135 124 116
scale note input

  • Input
  • Type: Number
  • Range: 0 to 1000

The scale note input is normally used to receive scale note information from upstream Agents (normally the Scaler's scale note output in this case).

Frequency input

  • Name:

1128 116
frequency input

  • Input
  • Type: Number
  • Range: 0 to 96000

The frequency input is normally used to receive frequency information from upstream Agents (normally the Scaler's frequency output in this case).

Cycler feedback input

  • Name:

1434 1126 116
cycler feedback input

  • Input
  • Type: Number
  • Range: 0 to 1

The cycler feedback input is used to enable the Cycler to determine when a note stops sounding after the envelope release phase. The AHDSR's volume output is normally connected to this input.

Damper Pedal Input

  • Name:

231 161 116
damper pedal input

  • Input, Set
  • Type: Number
  • Range: 0 to 1; default = 0

The Cycler's damper pedal input enables the user to vary the damping (or sustain) of notes played by the downstream Sampler Oscillator and AHDSR. When using a 'damper' or 'sustain' type expression pedal with a Sampler instrument it is normally connected to this input, but it can also be a value set by the user. When the value of this input is 0, no damping is applied to the envelope - the higher the value the higher the level of damping. The Damper Pedal Input can also be inverted using the 'invert' verb. When connecting a controller other than a sustain type pedal to this input, it will use the static value of the damper pedal input when it is inactive to calculate the damping value. However if you connect a sustain type expression pedal, this value is not used as pedals always send a value even when fully up.

Damper maximum input

  • Name:

231 2342 116
damper maximum input

  • Input, Set
  • Type: Number
  • Range: 0 to 1; default = 1

The Damper Maximum Input determines the amount of damping that occurs when a note overlaps with itself - for example if you play and hold a C using one key, then play the same C using a different key on a different course. If the value is 1, the previous note will decay as fast as possible. Lower values mean that the notes will decay more slowly, but will therefore use more polyphony.

Hold Pedal Input

  • Name:

1418 161 116
hold pedal input

  • Input, Set
  • Type: Number
  • Range: 0 to 1

The Hold Pedal Input is generally used to control the sustain of Sampler Instruments with a switch type pedal.

Damper curve

  • Name:

231 1512
damper curve

  • Input, Set
  • Type: Number
  • Range: 0.1 to 10; default = 1

The Damper Curve determines the shape of the curve applied to the damping values: 1 is linear, values below 1 produce a concave curve (reducing the damping effect) and values above 1 produce a convex curve (increasing the damping effect). The default value is 1.

Activation output

  • Name:

1435 125
activation output

  • Output
  • Type: Generic

The activation output is normally used to send activation information to downstream Agents.

Pressure output

  • Name:

128 125
pressure output

  • Output
  • Type: Generic

The pressure output is used to send key pressure information to downstream Agents (normally the AHDSR's pressure inputs and the Sampler Oscillator pressure input in this case).

Roll output

  • Name:

131 125
roll output

  • Output
  • Type: Generic

The roll output is used to send key roll information to downstream Agents.

Yaw output

  • Name:

132 125
yaw output

  • Output
  • Type: Generic

The yaw output is used to send key yaw information to downstream Agents.

Scale note output

  • Name:

135 124 125
scale note output

  • Output
  • Type: Generic

The scale note output sends scale note information to downstream Agents.

Frequency output

  • Name:

1128 125
frequency output

  • Output
  • Type: Generic

The frequency output sends the frequency information produced by the Scaler to downstream Agents (e.g. the Sampler Oscillator's frequency inputs in this case).

Damper output

  • Name:

231 125
damper output

  • Output
  • Type: Generic

The damper output is used to send damping information to downstream Agents (e.g. the AHDSR's damper input in this case).

Nouns

None

Verbs

Cycle:

232
cycle

The 'cycle' verb is used to turn the cycling behaviour on in the Cycler Agent (it is on by default).

Un Cycle:

6 232
un cycle

The 'un cycle' verb is used to turn the cycling behaviour off in the Cycler Agent (it is on by default).

Invert:

411
invert

The 'invert' verb is used to invert the sense of the damper pedal input for use with a 'sustain' type pedal.

Un Invert:

6 411
un invert

The 'un invert' verb is used to revert the sense of the damper pedal input for standard usage.

Examples

Before using the Belcanto examples below, make sure you have the desired Cycler in the conversation using

1434 ? 1131
cycler X listen

where X is the number of the desired Cycler.

Setting the value of the damper pedal input

To set the value of the damper pedal input, use

231 161 116 23 ? 67
damper pedal input to X set

where X is the desired value of the damper pedal input.

Setting the value of the damper maximum input

To set the value of the damper maximum input, use

231 2342 116 23 ? 67
damper maximum input to X set

where X is the desired damper maximum value.

Setting the damper curve

To set the damper curve value, use

231 1512 23 ? 67
damper curve to X set

where X is the desired damper curve value.

Initiating cycling behaviour

To start cycling behaviour within the Cycler, use

232
cycle

Turn off cycling behaviour

To turn off cycling behaviour within the Cycler, use

6 232
un cycle

Inverting the sense of the damper pedal input value

To invert the damper pedal input, use

411
invert

Un inverting the sense of the damper pedal input value

To revert back to standard usage of the damper pedal input, use

6 411
un invert

See also