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

    Type Alias AudioRegion

    key value
    type entity
    key "audioRegion"
    is

    An Region of audio on the timeline. Must be attached to an AudioTrack.

    Note that multiple regions can point to the same sample and/or the same automation collection. In the current audio tool version, it's possible to create "virtual regions" that point to both the same sample and same automation collection, and to create two regions with different collections but the same sample.

    It is also possible to create two regions that point to different samples but the same automation collection, even though the UI doesn't allow for such an operation.

    type AudioRegion = {
        fadeInDurationTicks: PrimitiveField<number, "mut">;
        fadeInSlope: PrimitiveField<number, "mut">;
        fadeOutDurationTicks: PrimitiveField<number, "mut">;
        fadeOutSlope: PrimitiveField<number, "mut">;
        gain: PrimitiveField<number, "mut">;
        pitchShiftSemitones: PrimitiveField<number, "mut">;
        playbackAutomationCollection: PrimitiveField<NexusLocation, "immut">;
        region: NexusObject<Region>;
        sample: PrimitiveField<NexusLocation, "immut">;
        timestretchMode: PrimitiveField<number, "mut">;
        track: PrimitiveField<NexusLocation, "immut">;
    }
    Index

    Properties

    fadeInDurationTicks: PrimitiveField<number, "mut">

    The duration of the fade-in envelope in ticks. The sum of this and fade out duration cannot be higher than the region's total duration.

    key value
    default 10
    range full
    fadeInSlope: PrimitiveField<number, "mut">

    The slope of the fade-in envelope. 0 is linear, more or less curves the slope.

    key value
    default 0
    range [-1, 1]
    fadeOutDurationTicks: PrimitiveField<number, "mut">

    The duration of the fade-out envelope in ticks. The sum of this and fade in duration cannot be higher than the region's total duration.

    key value
    default 10
    range full
    fadeOutSlope: PrimitiveField<number, "mut">

    The slope of the fade-out envelope. 0 is linear, more or less curves the slope.

    key value
    default 0
    range [-1, 1]
    gain: PrimitiveField<number, "mut">

    Gain applied to the sample in the region. Equivalent to a dB range of [-inf, 30.0].

    key value
    default 1
    range [0, 31.622777938842773]
    pitchShiftSemitones: PrimitiveField<number, "mut">

    in timestretch mode, pitch shift the signal by a certain amount of semitones

    key value
    default 0
    range [-24, 24]
    playbackAutomationCollection: PrimitiveField<NexusLocation, "immut">

    Automation events that define the playback speed of the sample in this region.

    key value
    default no default, required
    required true
    targets api.TargetType.AutomationCollection, meaning one of:
    entities.AutomationCollection,
    entities.TempoAutomationTrack
    immutable true

    This region maps to the audio content of the track.

    sample: PrimitiveField<NexusLocation, "immut">

    The sample that is played back in this region.

    key value
    default no default, required
    required true
    targets api.TargetType.Sample, meaning one of:
    entities.Sample
    immutable true
    timestretchMode: PrimitiveField<number, "mut">

    The time stretching algorithm, determines the pitch of the sample if it's stretched or compressed over time:

    • 0: invalid
    • 1: pitch shift no processing - faster/slower playback result in lower/higher pitch
    • 2: time stretch processing - faster/slower keeps the original pitch, with some artifacts.
    key value
    default 2
    range [1, 2]
    track: PrimitiveField<NexusLocation, "immut">

    The track this region belongs to.

    key value
    default no default, required
    required true
    targets api.TargetType.AudioTrack, meaning one of:
    entities.AudioTrack
    immutable true