@audiotool/nexus - v0.0.12
    Preparing search index...

    Type Alias MachinisteChannel

    key value
    type object

    Holds the parameters, their modulation amount, and the loaded sample for a single channel.

    The effective "modulation depth" for each step is the multiplication of the various modulation depths for this step & parameter, which are:

    • the global modulation depth
    • the parameter modulation depth
    • the step modulation depth

    Call this "mod amount".

    The effective parameter value used, in % of the parameter's full range, is:

    • -> if the modulation is positive: mod amount * (1 - parameter value) + parameter value
    • -> if the modulation is negative: mod amount * parameter value + parameter value
    type MachinisteChannel = {
        channelOutput: NexusObject<Empty>;
        cutoffFrequencyHz: PrimitiveField<number, "mut">;
        cutoffModulationDepth: PrimitiveField<number, "mut">;
        endTrimFactor: PrimitiveField<number, "mut">;
        endTrimModulationDepth: PrimitiveField<number, "mut">;
        envelopePeakRatio: PrimitiveField<number, "mut">;
        envelopeRatioModulationDepth: PrimitiveField<number, "mut">;
        envelopeSlope: PrimitiveField<number, "mut">;
        envelopeSlopeModulationDepth: PrimitiveField<number, "mut">;
        filterTypeIndex: PrimitiveField<number, "mut">;
        gain: PrimitiveField<number, "mut">;
        gainModulationDepth: PrimitiveField<number, "mut">;
        panning: PrimitiveField<number, "mut">;
        panningModulationDepth: PrimitiveField<number, "mut">;
        pitchModulationDepth: PrimitiveField<number, "mut">;
        pitchSemitones: PrimitiveField<number, "mut">;
        resonance: PrimitiveField<number, "mut">;
        resonanceModulationDepth: PrimitiveField<number, "mut">;
        sample: PrimitiveField<NexusLocation, "mut">;
        startTrimFactor: PrimitiveField<number, "mut">;
        startTrimModulationDepth: PrimitiveField<number, "mut">;
    }
    Index

    Properties

    channelOutput cutoffFrequencyHz cutoffModulationDepth endTrimFactor endTrimModulationDepth envelopePeakRatio envelopeRatioModulationDepth envelopeSlope envelopeSlopeModulationDepth filterTypeIndex gain gainModulationDepth panning panningModulationDepth pitchModulationDepth pitchSemitones resonance resonanceModulationDepth sample startTrimFactor startTrimModulationDepth

    Properties

    channelOutput: NexusObject<Empty>

    Individual channel output, if connected then the audio from this channel no longer outputs via the master output.

    key value
    is api.TargetType.AudioOutput
    cutoffFrequencyHz: PrimitiveField<number, "mut">

    Filter cutoff, mapped to [28hz, 12000hz].

    key value
    default 6000
    range [28, 12000]
    is api.TargetType.AutomatableParameter
    cutoffModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of cutoff. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    endTrimFactor: PrimitiveField<number, "mut">

    This sets the ending point in the sample in % of the sample length. 0 means end is at time 0, 1 means end is at the end of the sample.

    If start > end, the sample is played backwards.

    key value
    default 1
    range [0, 1]
    is api.TargetType.AutomatableParameter
    endTrimModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of end_trim_factor. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    envelopePeakRatio: PrimitiveField<number, "mut">

    At what point during the sample playback, in % of the sample length, the envelope peaks.

    key value
    default 0
    range [0, 1]
    is api.TargetType.AutomatableParameter
    envelopeRatioModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of envelope ratio. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    envelopeSlope: PrimitiveField<number, "mut">

    The steepness of the slope. 0 is linear, -1 slopes up, 1 slopes down.

    key value
    default 1
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    envelopeSlopeModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of envelope slope. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    filterTypeIndex: PrimitiveField<number, "mut">

    Selects the sample filter type.

    • 0: invalid
    • 1: no filter
    • 2: low-pass
    • 3: high-pass
    key value
    default 1
    range [1, 3]
    is api.TargetType.AutomatableParameter
    gain: PrimitiveField<number, "mut">

    Output gain of the channel. Equivalent to a dB range of [-inf, 0.0].

    key value
    default 0.10000000149011612
    range [0, 1]
    is api.TargetType.AutomatableParameter
    gainModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of gain. See message documentation for more details.

    key value
    default 1
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    panning: PrimitiveField<number, "mut">

    Pans the signal to left/right. -1 is fully left, 0 is centered (unchanged), 1 is fully right.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    panningModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of panning. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    pitchModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of tune. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    pitchSemitones: PrimitiveField<number, "mut">

    Tunes the sample by a given amount of semitones by playing it at a different speed.

    For example, -12 detunes the sample by 1 octave by playing it at half the original speed.

    key value
    default 0
    range [-24, 24]
    is api.TargetType.AutomatableParameter
    resonance: PrimitiveField<number, "mut">

    Filter resonance. No unit.

    key value
    default 0
    range [0, 1]
    is api.TargetType.AutomatableParameter
    resonanceModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of resonance. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter
    sample: PrimitiveField<NexusLocation, "mut">

    Audio sample to be played on this channel.

    key value
    default empty location
    required false
    targets api.TargetType.Sample, meaning one of:
    entities.Sample
    startTrimFactor: PrimitiveField<number, "mut">

    This sets the starting point in the sample in % of the sample length. 0 means start is at time 0, 1 means start is at the end of the sample.

    If start > end, the sample is played backwards.

    key value
    default 0
    range [0, 1]
    is api.TargetType.AutomatableParameter
    startTrimModulationDepth: PrimitiveField<number, "mut">

    Modulation depth of start_trim_factor. See message documentation for more details.

    key value
    default 0
    range [-1, 1]
    is api.TargetType.AutomatableParameter

    Settings

    Member Visibility

    On This Page

    Properties