REF / Hz.Builtins / Hz.Mod*

Builtin Modulators procedurally modulate anode Parameters.

For more motivation, see here.

Modulators

Like Anodes, Modulators are created via Ascene and have their own parameters. Unlike Anodes, Modulators generate parameter value changes and not an audio signal. For this reason, Modulators require special wiring into the graph through Ascene's ModulateParam method. Modulators are either free running or triggered and produce a modulation value between 0 and 1 that is often remapped to match the range of its target parameter.

snippet

let ascene = await Ascene.BeginFiber(this);
let inst = ascene.NewAnode("Vital");
let preset = {shape: "triangle"};
let lfo = ascene.NewModulator("Hz.ModLFO", JSON.stringify(preset));
ascene.Chain(inst, ascene.GetDAC());
ascene.ModulateParam(lfo, inst, "Oscillator 1 Pan"/*parameter name*/, optionalRemapper);
await ascene.Sync();
lfo.SetParam("Frequency", .1); // .1 Hz => 10 second period.

Modulators can easily be confused with audio modulators like Hz.LFO. Just remember that these Modulators are wired to external plugin parameters. Hz.Syntho further muddies these waters by allowing its internal module parameters to be driven by audio modulators.

Hz.ModLFO

Hz.ModLFO is the most general/versatile of the builtin parameter modulators. The LFO shape is described by a curve that is delivered via a preset mechanism. The preset parameter can be one of triangle, sine, square, sawUp, sawDown or a shape object with an arbitrary shape description described below.

let lfo = ascene.NewModulator("Hz.ModLFO", "triangle");

Parameters

Presets

Presets are string parameters encoding a JSON object with name/value parameters. You can request an LFO shape in two ways.

1. the shape parameter
2. the knotlist parameter

Preset Shapes

Preset Knotlist

Here's the explicit representation of the square preset. The data array is a series of 3 numbers representing the x, y coordinates and the power value. When power is 0 we have a line. Otherwise when > 0 it's a convex curve and when < 0 it's concave. The useful range for power is around -5 - 5.

{ knotlist:  {
    name: "square",
    smooth: false,
    data: [
        // t, v, power
        0, 1, 0,
        0, 0, 0,
        .5, 0, 0,
        .5, 1, 0,
        1, 1, 0,
    ]
  }
}

Hz.ModRand

Hz.ModRand supports a number of random modes to generate a its modulation value.

// a snippet to modulate Anode osc's "Transpose" parameter.
let rand = scene.NewModulator("Hz.ModRand", {
                    choices: [0, 3, 7, -5, 12, -12]
                });
rand.SetParam("Mode", 6); // 'choice'
scene.ModulateParam(rand, osc, "Transpose");

Parameters

Hz.ModEnv

Hz.ModEnv produces a modulation envelope equivalent to Hz.ADSR. It requires triggering via NoteOn/Off methods. This can be done implicitly via Voices or explicitly. As with all modulators, use this only when you have one or more anode parameters that you'd like to drive with note or program-triggered envelope.

code snippet

let env = scene.NewModulator("Hz.ModEnv");
let remap = env.NewRemapper({mode: 1}); // usually envelopes are set, not added
scene.ModulateParam(mod, anotherNode, "Parameter Name", remap);

Parameters

Hz.ModExpr

Hz.ModExpr is used to drive an arbitrary anode parameter via a Clap/MIDI note expression. Instantiate an instance of Hz.ModExpr and make sure its in a position to receive MIDI events from a MIDI device or file. Next, use the instance-method SelectSignal() to establish the specific note expression event the instance should listen (see the table below). Finally, wire the instance into agraph using scene.ModulatorParam and an optional Remapper.

code snippet

let mod = scene.NewModulator("Hz.ModExpr");
mod.SelectSignal(mod.Signals.ModWheel);
scene.ModulateParam(mod, anotherNode, "parameter name", optionalRemapper);
// make sure NoteOn/Off, NoteExpression and  MIDI events are delivered to mod.

CLAP Note Expression Ids

See Also

Modulator API . Remap . Radio Example . Hz.LFO Ref