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

    Type Alias CentroidChannel

    key value
    type entity
    key "centroidChannel"
    is

    data structure representing the centroid channel strip

    type CentroidChannel = {
        audioInput: NexusObject<Empty>;
        aux1SendGain: PrimitiveField<number, "mut">;
        aux2SendGain: PrimitiveField<number, "mut">;
        centroid: PrimitiveField<NexusLocation, "immut">;
        displayName: PrimitiveField<string, "mut">;
        eqHighGainDb: PrimitiveField<number, "mut">;
        eqLowGainDb: PrimitiveField<number, "mut">;
        eqMidFrequency: PrimitiveField<number, "mut">;
        eqMidGainDb: PrimitiveField<number, "mut">;
        isMuted: PrimitiveField<boolean, "mut">;
        isSoloed: PrimitiveField<boolean, "mut">;
        orderAmongChannels: PrimitiveField<number, "mut">;
        panning: PrimitiveField<number, "mut">;
        postGain: PrimitiveField<number, "mut">;
        preGain: PrimitiveField<number, "mut">;
        useAuxPreMode: PrimitiveField<boolean, "mut">;
    }
    Index

    Properties

    audioInput: NexusObject<Empty>

    The channel's audio input.

    key value
    is api.TargetType.AudioInput
    aux1SendGain: PrimitiveField<number, "mut">

    Aux 1 send level. Equivalent to a dB range of [-inf, 0.0].

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

    Aux 2 send level. Equivalent to a dB range of [-inf, 0.0].

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

    Centroid reference that owns this channel.

    key value
    default no default, required
    required true
    targets api.TargetType.Centroid, meaning one of:
    entities.Centroid
    immutable true
    displayName: PrimitiveField<string, "mut">

    The user-assigned name of this channel.

    eqHighGainDb: PrimitiveField<number, "mut">

    High gain in decibels. This is the gain of the high band.

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

    Low gain in decibels. This is the gain of the low band.

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

    The center frequency of the mid eq band of the channel.

    key value
    default 1000
    range [240, 4200]
    is api.TargetType.AutomatableParameter
    eqMidGainDb: PrimitiveField<number, "mut">

    Mid gain in decibels. This is the gain of the mid band.

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

    Mute this channel. If is_muted=true, the channel is muted, including its aux sends.

    key value
    default false
    is api.TargetType.AutomatableParameter
    isSoloed: PrimitiveField<boolean, "mut">

    Solo this channel. If is_soloed=true, all channels that don't have is_soloed=true are muted.

    key value
    default false
    is api.TargetType.AutomatableParameter
    orderAmongChannels: PrimitiveField<number, "mut">

    Sorts this channel visually among all channels. Must be unique among all channels of a given centroid.

    key value
    default 0
    range full
    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
    postGain: PrimitiveField<number, "mut">

    Post gain applied after all other processing. Equivalent to a dB range of [-inf, 0.0].

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

    Pre gain. This is the gain before the EQ. Equivalent to a dB range of [-inf, 18.0].

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

    Use the "aux pre mode". If enabled, the signal is sent to the aux before the post_gain is applied, otherwise it is sent after.

    key value
    default false
    is api.TargetType.AutomatableParameter