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

    Type Alias DesktopAudioCable

    key value
    type entity
    key "desktopAudioCable"
    is api.TargetType.Listenable

    A cable connecting an audio output to an audio input on the desktop.

    type DesktopAudioCable = {
        colorIndex: PrimitiveField<number, "mut">;
        fromSocket: PrimitiveField<NexusLocation, "mut">;
        toSocket: PrimitiveField<NexusLocation, "mut">;
    }
    Index

    Properties

    colorIndex fromSocket toSocket

    Properties

    colorIndex: PrimitiveField<number, "mut">

    Index of the color. The meaning of the color index is implementation-specific.

    key value
    default 0
    range [0, 41]
    fromSocket: PrimitiveField<NexusLocation, "mut">

    Pointer to an audio output from which the cable transports audio.

    key value
    default no default, required
    required true
    targets api.TargetType.AudioOutput, meaning one of:
    entities.AudioDevice.audioOutput,
    entities.AudioMerger.audioOutput,
    entities.AudioSplitter.audioOutputA,
    entities.AudioSplitter.audioOutputB,
    entities.AudioSplitter.audioOutputC,
    entities.AutoFilter.audioOutput,
    entities.BandSplitter.highAudioOutput,
    entities.BandSplitter.midAudioOutput,
    entities.BandSplitter.lowAudioOutput,
    entities.Bassline.audioOutput,
    entities.Beatbox8.audioOutput,
    entities.Beatbox8Bassdrum.audioOutput,
    entities.Beatbox8Snaredrum.audioOutput,
    entities.Beatbox8TomCongaLow.audioOutput,
    entities.Beatbox8TomCongaMid.audioOutput,
    entities.Beatbox8TomCongaHigh.audioOutput,
    entities.Beatbox8RimClaves.audioOutput,
    entities.Beatbox8ClapMaracas.audioOutput,
    entities.Beatbox8Cowbell.audioOutput,
    entities.Beatbox8Cymbal.audioOutput,
    entities.Beatbox8OpenHihat.audioOutput,
    entities.Beatbox8ClosedHihat.audioOutput,
    entities.Beatbox9.audioOutput,
    entities.Beatbox9Bassdrum.audioOutput,
    entities.Beatbox9Snaredrum.audioOutput,
    entities.Beatbox9Tom.audioOutput,
    entities.Beatbox9Rim.audioOutput,
    entities.Beatbox9Clap.audioOutput,
    entities.Beatbox9Hihat.audioOutput,
    entities.Beatbox9Crash.audioOutput,
    entities.Beatbox9Ride.audioOutput,
    entities.Centroid.audioOutput,
    entities.CentroidAux.audioOutput,
    entities.Crossfader.audioOutput,
    entities.Curve.audioOutput,
    entities.Exciter.audioOutput,
    entities.Gakki.audioOutput,
    entities.GraphicalEQ.audioOutput,
    entities.Gravity.audioOutput,
    entities.Heisenberg.audioOutput,
    entities.Helmholtz.audioOutput,
    entities.Kobolt.audioOutput,
    entities.Machiniste.mainOutput,
    entities.MachinisteChannel.channelOutput,
    entities.Minimixer.mainOutput,
    entities.Minimixer.auxSendOutput,
    entities.MixerAux.insertOutput,
    entities.MixerGroup.insertOutput,
    entities.MixerMaster.insertOutput,
    entities.Panorama.audioOutput,
    entities.Pulsar.audioOutput,
    entities.Pulverisateur.audioOutput,
    entities.Quantum.audioOutput,
    entities.Quasar.audioOutput,
    entities.Rasselbock.masterOutput,
    entities.RasselbockChannel.audioOutput,
    entities.RingModulator.audioOutput,
    entities.Space.audioOutput,
    entities.SpitfireLabsVst3Plugin.audioOutput,
    entities.StereoEnhancer.audioOutput,
    entities.StompboxChorus.audioOutput,
    entities.StompboxCompressor.audioOutput,
    entities.StompboxCrusher.audioOutput,
    entities.StompboxDelay.audioOutput,
    entities.StompboxFlanger.audioOutput,
    entities.StompboxGate.audioOutput,
    entities.StompboxParametricEqualizer.audioOutput,
    entities.StompboxPhaser.audioOutput,
    entities.StompboxPitchDelay.audioOutput,
    entities.StompboxReverb.audioOutput,
    entities.StompboxSlope.audioOutput,
    entities.StompboxStereoDetune.audioOutput,
    entities.StompboxTube.audioOutput,
    entities.TinyGain.audioOutput,
    entities.Tonematrix.audioOutput,
    entities.Waveshaper.audioOutput
    toSocket: PrimitiveField<NexusLocation, "mut">

    Pointer to an audio input to which the cable transports audio.

    key value
    default no default, required
    required true
    targets api.TargetType.AudioInput, meaning one of:
    entities.AudioMerger.audioInputA,
    entities.AudioMerger.audioInputB,
    entities.AudioMerger.audioInputC,
    entities.AudioSplitter.audioInput,
    entities.AutoFilter.audioInput,
    entities.AutoFilter.sideChainInput,
    entities.BandSplitter.audioInput,
    entities.Bassline.audioInput,
    entities.CentroidAux.audioInput,
    entities.CentroidChannel.audioInput,
    entities.CrossfaderChannel.audioInput,
    entities.Curve.audioInput,
    entities.Exciter.audioInput,
    entities.GraphicalEQ.audioInput,
    entities.Gravity.audioInput,
    entities.Gravity.sideChainInput,
    entities.Helmholtz.audioInput,
    entities.KoboltChannel.audioInput,
    entities.Minimixer.auxReturnInput,
    entities.MinimixerChannel.audioInput,
    entities.MixerAux.insertInput,
    entities.MixerChannel.audioInput,
    entities.MixerGroup.insertInput,
    entities.MixerMaster.insertInput,
    entities.Panorama.audioInput,
    entities.Pulsar.audioInput,
    entities.Pulverisateur.audioInput,
    entities.Quantum.audioInput,
    entities.Quasar.audioInput,
    entities.Rasselbock.audioInput,
    entities.RingModulator.audioInput1,
    entities.RingModulator.audioInput2,
    entities.StereoEnhancer.audioInput,
    entities.StompboxChorus.audioInput,
    entities.StompboxCompressor.audioInput,
    entities.StompboxCompressor.sideChainInput,
    entities.StompboxCrusher.audioInput,
    entities.StompboxDelay.audioInput,
    entities.StompboxFlanger.audioInput,
    entities.StompboxGate.audioInput,
    entities.StompboxGate.sideChainInput,
    entities.StompboxParametricEqualizer.audioInput,
    entities.StompboxPhaser.audioInput,
    entities.StompboxPitchDelay.audioInput,
    entities.StompboxReverb.audioInput,
    entities.StompboxSlope.audioInput,
    entities.StompboxStereoDetune.audioInput,
    entities.StompboxTube.audioInput,
    entities.TinyGain.audioInput,
    entities.Waveshaper.audioInput,
    entities.Waveshaper.sideChainInput

    Settings

    Member Visibility

    On This Page

    Properties