Duplex Framework

Documentation of the Duplex framework, its classes and applications

Modules

Duplex.Application The generic application class for Duplex.
Duplex.Applications.Effect The Effect application enables control of DSP chain parameters.
Duplex.Applications.GridPie Grid Pie lets you combine different parts of song, non-linearly, in real time.
Duplex.Applications.Hydra Control any Hydra device in the current song.
Duplex.Applications.Instrument Take control of the Renoise Instrument (tutorial).
Duplex.Applications.Keyboard.GridLayout Custom grid layouts for the Keyboard application.
Duplex.Applications.Keyboard.Layouts.HarmonicLayout Harmonic layout for the Keyboard application.
Duplex.Applications.Keyboard.Layouts.IsomorphicLayout Isomorphic layout for the Keyboard application.
Duplex.Applications.Keyboard.Layouts.PianoLayout Piano-style layout for the Keyboard application.
Duplex.Applications.Keyboard A replacement of the standard Renoise keyboard, supporting for MIDI and OSC.
Duplex.Applications.Matrix Take control of the pattern matrix in Renoise with the endlessly scrollable matrix application.
Duplex.Applications.Metronome Take control of the Renoise metronome (tutorial).
Duplex.Applications.MidiActions.Bindings This is a configuration file for the MidiActions application, supplying semantic information about known/common Renoise MIDI mappings.
Duplex.Applications.MidiActions MidiActions will expose most of the standard Renoise mappings to Duplex.
Duplex.Applications.Mixer The Mixer is a generic class for controlling the Renoise mixer, featuring an endlessly scrollable number of tracks.
Duplex.Applications.Mlrx.Mlrx_group Mlrx_group - this class represent a logical group in mlrx the group takes care of administering updates to it's child tracks
Duplex.Applications.Mlrx.Mlrx_note Mlrx_note - a struct for logical note-objects in mlrx
Duplex.Applications.Mlrx.Mlrx_pos Mlrx_pos is a class for handling operations on song-position objects, a more flexible implementation of the native SongPos
Duplex.Applications.Mlrx.Mlrx_track Mlrx_track - this class represent a logical track in mlrx
Duplex.Applications.Mlrx Mlrx is a comphrehensive live performance environment for Renoise.
Duplex.Applications.Navigator The "Navigator" application allows you to take control of the pattern/block-loop and playback position.
Duplex.Applications.NotesOnWheels Notes On Wheels (N.O.W) is an arpeggiating step sequencer.
Duplex.Applications.PatternCursor Navigate between lines and columns/tracks in the pattern editor.
Duplex.Applications.PatternSequence Basic control of the Renoise pattern-sequence.
Duplex.Applications.Recorder Record and loop any signal that you feed into Renoise, be that your voice, a guitar etc.
Duplex.Applications.Repeater Take control of the native repeater DSP device.
Duplex.Applications.Rotate Rotate a track/pattern upwards or downwards, optionally including automation.
Duplex.Applications.StepSequencer Use your grid controller as a basic step sequencer.
Duplex.Applications.SwitchConfiguration Switch between different configurations (next, previous and set).
Duplex.Applications.TestPad An interactive demo of the various UIComponents.
Duplex.Applications.TrackSelector Select the active Renoise track, including shortcuts for master & send tracks.
Duplex.Applications.Transport The Transport application offers transport controls for Renoise.
Duplex.Applications.UIButtonTest Constructor method
Duplex.Applications.XYPad Control any XYPad device in any Renoise DSP Chain.
Duplex.Automation Provide generic automation features for Duplex applications

In the Renoise API, each pattern-track can contain a list of automation envelopes which are listed in order-of-arrival.

Duplex.Browser The Browser class shows and instantiates registered device configurations and shows the virtual UI for them.
Duplex.BrowserProcess Duplex.BrowserProcess [[--
Duplex.Canvas Employed by the UIComponents to represent their visual state

The canvas is a two-dimensional table of CanvasPoints which can be resized.

Duplex.CanvasPoint
Duplex.ControlMap Load and parse XML based control-map files, add extra methods, handy accessors.
Duplex.Device The Device class is the base class for any OSC or MIDI device.
Duplex.Display The Display is the base class for device displays and the virtual UI

Display performs many duties; it manages UIComponents, as it will both send and recieve their messages, and take care of their visual updates on the idle time update.

Duplex.Globals Various global constants, functions and methods for tracing output
Duplex.Message Initialize Message class
Duplex.MessageStream Recieve messages from connected devices and the virtual control surface.
Duplex.MidiDevice A generic MIDI device class, providing the ability to send and receive MIDI
Duplex.OscClient OscClient is a simple OSC client that connect to the built-in OSC server in Renoise, producing realtime messages that trigger notes or send MIDI messages
Duplex.OscDevice A generic OSC device class, providing the ability to send and receive OSC.
Duplex.OscVoiceMgr The OscVoiceMgr is a class for handling internally triggered notes, keeping track of the active voices and their context

The purpose is to keep track of active voices, and their context: how the note got triggered: which device/application/instrument/pitch etc.

Duplex.Preferences Manage global settings or individual device-configuration settings for Duplex

Device and application setup for controllers are registered by the controllers itself.

Duplex.ProcessSlicer ProcessSlicer allows you to slice up a function which takes a lot of processing time into multiple calls via Lua coroutines.
Duplex.RoamingDSP Extend this class if you want an application to lock onto a specific type of device, or navigate between similar devices.
Duplex.Scheduler Schedule tasks to execute after a defined amount of time
Duplex.StateController The StateController handles states within a display/controlmap

A state can toggle any part of a control-map on/off while a device configuration is running.

Duplex.UIButton The UIButton is a generic button.
Duplex.UIButtonStrip The UIButtonStrip is an array of buttons that control an active index/range, especially useful for controlling a sequence with an a looped region.
Duplex.UIComponent UIComponent is the basic building block from which you create a user interface.
Duplex.UIKey UIKey receives messages from a MIDI keyboard.
Duplex.UIKeyPressure UIKeyPressure is a UIComponent that respond to MIDI channel-pressure events.
Duplex.UILabel UILabel is a component designed for basic text display
Duplex.UIPad UIPad is designed to take control of a X/Y Pad
Duplex.UIPitchBend UIPitchBend is able to receive pitch bend messages from MIDI devices
Duplex.UISlider The Slider supports different input methods: buttons or faders/dials.
Duplex.UISpinner UISpinner makes it possible to select among a list of options
Duplex.WidgetHooks Provide hooks for controls in the virtual control surface (native & custom)
Duplex.WidgetKeyboard
Duplex Include the duplex core, applications and device configurations
main locals
generated by LDoc 1.4.2