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

    Type Alias PatternRegion

    key value
    type entity
    key "patternRegion"
    is

    a region on a pattern track

    type PatternRegion = {
        patternIndex: PrimitiveField<number, "mut">;
        region: NexusObject<Region>;
        restart: PrimitiveField<boolean, "mut">;
        track: PrimitiveField<NexusLocation, "immut">;
    }
    Index

    Properties

    patternIndex: PrimitiveField<number, "mut">

    The index of the pattern in the pattern device that the track points to.

    32 is the maximum number of patterns supported by any current pattern device; if more pattern devices are added, this value must be increased.

    If a region exists with an index higher than the pattern device supports, the region is mute.

    key value
    default 0
    range [0, 32]

    How this region maps to the underlying container.

    restart: PrimitiveField<boolean, "mut">

    Defines whether the pattern is started at this point in time, or whether it uses 0 as its starting point

    key value
    default false
    track: PrimitiveField<NexusLocation, "immut">

    The track this region belongs to.

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