diff --git a/docs/API/renoise/renoise.ApplicationWindow.md b/docs/API/renoise/renoise.ApplicationWindow.md index 4c87571e..97e2f487 100644 --- a/docs/API/renoise/renoise.ApplicationWindow.md +++ b/docs/API/renoise/renoise.ApplicationWindow.md @@ -1,18 +1,11 @@ # renoise.ApplicationWindow Application window and general UI properties of the Renoise app. ## Constants -### MiddleFrame {#MiddleFrame} +### LowerFrame {#LowerFrame} ```lua { - MIDDLE_FRAME_PATTERN_EDITOR: integer = 1, - MIDDLE_FRAME_MIXER: integer = 2, - MIDDLE_FRAME_INSTRUMENT_PHRASE_EDITOR: integer = 3, - MIDDLE_FRAME_INSTRUMENT_SAMPLE_KEYZONES: integer = 4, - MIDDLE_FRAME_INSTRUMENT_SAMPLE_EDITOR: integer = 5, - MIDDLE_FRAME_INSTRUMENT_SAMPLE_MODULATION: integer = 6, - MIDDLE_FRAME_INSTRUMENT_SAMPLE_EFFECTS: integer = 7, - MIDDLE_FRAME_INSTRUMENT_PLUGIN_EDITOR: integer = 8, - MIDDLE_FRAME_INSTRUMENT_MIDI_EDITOR: integer = 9, + LOWER_FRAME_TRACK_DSPS: integer = 1, + LOWER_FRAME_TRACK_AUTOMATION: integer = 2, } ``` ### UpperFrame {#UpperFrame} @@ -31,11 +24,18 @@ Application window and general UI properties of the Renoise app. MIXER_FADER_TYPE_LINEAR: integer = 4, } ``` -### LowerFrame {#LowerFrame} +### MiddleFrame {#MiddleFrame} ```lua { - LOWER_FRAME_TRACK_DSPS: integer = 1, - LOWER_FRAME_TRACK_AUTOMATION: integer = 2, + MIDDLE_FRAME_PATTERN_EDITOR: integer = 1, + MIDDLE_FRAME_MIXER: integer = 2, + MIDDLE_FRAME_INSTRUMENT_PHRASE_EDITOR: integer = 3, + MIDDLE_FRAME_INSTRUMENT_SAMPLE_KEYZONES: integer = 4, + MIDDLE_FRAME_INSTRUMENT_SAMPLE_EDITOR: integer = 5, + MIDDLE_FRAME_INSTRUMENT_SAMPLE_MODULATION: integer = 6, + MIDDLE_FRAME_INSTRUMENT_SAMPLE_EFFECTS: integer = 7, + MIDDLE_FRAME_INSTRUMENT_PLUGIN_EDITOR: integer = 8, + MIDDLE_FRAME_INSTRUMENT_MIDI_EDITOR: integer = 9, } ``` diff --git a/docs/API/renoise/renoise.Instrument.md b/docs/API/renoise/renoise.Instrument.md index 89455146..6c4346a1 100644 --- a/docs/API/renoise/renoise.Instrument.md +++ b/docs/API/renoise/renoise.Instrument.md @@ -1,11 +1,11 @@ # renoise.Instrument ## Constants -### Tab {#Tab} +### OverlapMode {#OverlapMode} ```lua { - TAB_SAMPLES: integer = 1, - TAB_PLUGIN: integer = 2, - TAB_EXT_MIDI: integer = 3, + OVERLAP_MODE_ALL: integer = 0, + OVERLAP_MODE_CYCLED: integer = 1, + OVERLAP_MODE_RANDOM: integer = 2, } ``` ### PhrasePlaybackMode {#PhrasePlaybackMode} @@ -16,14 +16,6 @@ PHRASES_PLAY_KEYMAP: integer = 3, } ``` -### OverlapMode {#OverlapMode} -```lua -{ - OVERLAP_MODE_ALL: integer = 0, - OVERLAP_MODE_CYCLED: integer = 1, - OVERLAP_MODE_RANDOM: integer = 2, -} -``` ### Layer {#Layer} ```lua { @@ -32,6 +24,14 @@ LAYER_NOTE_OFF: integer = 2, } ``` +### Tab {#Tab} +```lua +{ + TAB_SAMPLES: integer = 1, + TAB_PLUGIN: integer = 2, + TAB_EXT_MIDI: integer = 3, +} +``` --- diff --git a/docs/API/renoise/renoise.Midi.md b/docs/API/renoise/renoise.Midi.md index 63e01799..7e05f8bb 100644 --- a/docs/API/renoise/renoise.Midi.md +++ b/docs/API/renoise/renoise.Midi.md @@ -1,4 +1,6 @@ # renoise.Midi +Raw MIDI IO support for scripts in Renoise; the ability to send and receive +MIDI data. --- ## Functions diff --git a/docs/API/renoise/renoise.NoteColumn.md b/docs/API/renoise/renoise.NoteColumn.md index 720d70b4..ecedf1e3 100644 --- a/docs/API/renoise/renoise.NoteColumn.md +++ b/docs/API/renoise/renoise.NoteColumn.md @@ -11,28 +11,28 @@ them in Renoise's pattern or phrase editor. --- ## Properties ### delay_string : [`string`](/API/builtins/string.md) {#delay_string} -00 +Range: (\'00'-\'FF\') or \'..\' ### delay_value : [`integer`](/API/builtins/integer.md) {#delay_value} -0-255 +Range: (0-255) ### effect_amount_string : [`string`](/API/builtins/string.md) {#effect_amount_string} -00 +Range: (\'00\' - \'FF\') ### effect_amount_value : [`integer`](/API/builtins/integer.md) {#effect_amount_value} -0-255 +Range: (0-255) ### effect_number_string : [`string`](/API/builtins/string.md) {#effect_number_string} -00 +Range: (\'00\'-\'ZZ\') ### effect_number_value : [`integer`](/API/builtins/integer.md) {#effect_number_value} -0-65535 in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 +Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 ### instrument_string : [`string`](/API/builtins/string.md) {#instrument_string} -00 +Range: (\'00\'-\'FE\') or \'..\' ### instrument_value : [`integer`](/API/builtins/integer.md) {#instrument_value} -0-254, 255==Empty +Range: (0-254), 255==Empty ### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} **READ-ONLY** True, when all note column properties are empty. @@ -42,29 +42,29 @@ them in Renoise's pattern or phrase editor. editors current pattern. ### note_string : [`string`](/API/builtins/string.md) {#note_string} -C-0 +Range: (\'C-0\'-\'G-9\') or \'OFF\' or \'---\' ### note_value : [`integer`](/API/builtins/integer.md) {#note_value} -0-119, 120=Off, 121=Empty +Range: (0-119) or 120=Off or 121=Empty ### panning_string : [`string`](/API/builtins/string.md) {#panning_string} -00 +Range: (\'00'-\'ZF\') or \'..\' ### panning_value : [`integer`](/API/builtins/integer.md) {#panning_value} -0-127, 255==Empty when column value is <= 0x80 or is 0xFF, +Range: (0-127) or 255==Empty when column value is <= 0x80 or is 0xFF, i.e. to specify a pan value. -0-65535 in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2, +Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2, when column value is > 0x80, i.e. to specify an effect. ### volume_string : [`string`](/API/builtins/string.md) {#volume_string} -00 +Range(\'00\'-\'ZF\') or \'..\' ### volume_value : [`integer`](/API/builtins/integer.md) {#volume_value} -0-127 or 255==Empty when column value is <= 0x80 or is 0xFF, +Range: (0-127) or 255==Empty when column value is <= 0x80 or is 0xFF, i.e. to specify a volume value. -0-65535 in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2, +Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2, when column value is > 0x80, i.e. to specify an effect. diff --git a/docs/API/renoise/renoise.Osc.md b/docs/API/renoise/renoise.Osc.md index c26df585..bae3a420 100644 --- a/docs/API/renoise/renoise.Osc.md +++ b/docs/API/renoise/renoise.Osc.md @@ -1,7 +1,19 @@ # renoise.Osc +OSC (Open Sound Control) support for Lua scripts in Renoise. --- ## Functions +### `Bundle`(time : [`integer`](/API/builtins/integer.md), arguments : [`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md) | [`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md)`[]`) {#Bundle} +`->`[`renoise.Osc.Bundle`](/API/renoise/renoise.Osc.Bundle.md) + +Create a new bundle by specifying a time-tag and one or more messages. +If you do not know what to do with the time-tag, use `os.clock()`, +which simply means "now". Messages must be renoise.Osc.Message objects. +Nested bundles (bundles in bundles) are right now not supported. +### `Message`(pattern : [`string`](/API/builtins/string.md), arguments : [`OscValue`](#oscvalue)`[]`[`?`](/API/builtins/nil.md)) {#Message} +`->`[`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md) + +Create a new OSC message with the given pattern and optional arguments. ### `from_binary_data`(binary_data : [`string`](/API/builtins/string.md)) {#from_binary_data} `->`[`renoise.Osc.Bundle`](/API/renoise/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) @@ -12,3 +24,49 @@ as first argument and the second return value will contain the error. If de-packetizing was successful, either a renoise.Osc.Bundle or Message object is returned. Bundles may contain multiple messages or nested bundles. + + +--- +## Structs +# OscValue +`tag` is a standard OSC type tag. `value` is the arguments value expressed +by a Lua type. The value must be convertible to the specified tag, which +means, you cannot for example specify an "i" (integer) as type and then pass +a string as the value. Use a number value instead. Not all tags require a +value, like the T,F boolean tags. Then a `value` field should not be +specified. For more info, see: http://opensoundcontrol.org/spec-1_0 + +--- +## Properties +### tag : [`OscTag`](#OscTag) {#tag} +### value : [`boolean`](/API/builtins/boolean.md) | [`string`](/API/builtins/string.md) | [`number`](/API/builtins/number.md) {#value} + + + + + + +--- +## Aliases +# alias OscTag {#OscTag} +`"F"` | `"I"` | `"N"` | `"S"` | `"T"` | `"b"` | `"c"` | `"d"` | `"f"` | `"h"` | `"i"` | `"m"` | `"r"` | `"s"` | `"t"` +```lua +OscTag: + | "i" -- int32 + | "f" -- float32 + | "s" -- OSC-string + | "b" -- OSC-blob (raw string) + | "h" -- 64 bit big-endian two's complement integer + | "t" -- OSC-timetag + | "d" -- 64 bit ("double") IEEE 754 floating point number + | "S" -- Alternate type represented as an OSC-string + | "c" -- An ascii character, sent as 32 bits + | "r" -- 32 bit RGBA color + | "m" -- 4 byte MIDI message. Bytes from MSB to LSB are: port id, status byte, data1, data2 + | "T" -- True. No value needs to be specified. + | "F" -- False. No value needs to be specified. + | "N" -- Nil. No value needs to be specified. + | "I" -- Infinitum. No value needs to be specified. +``` + + diff --git a/docs/API/renoise/renoise.Sample.md b/docs/API/renoise/renoise.Sample.md index 8d08ab2a..5cbcfd1b 100644 --- a/docs/API/renoise/renoise.Sample.md +++ b/docs/API/renoise/renoise.Sample.md @@ -1,13 +1,5 @@ # renoise.Sample ## Constants -### BeatSyncMode {#BeatSyncMode} -```lua -{ - BEAT_SYNC_REPITCH: integer = 1, - BEAT_SYNC_PERCUSSION: integer = 2, - BEAT_SYNC_TEXTURE: integer = 3, -} -``` ### InterpolationMode {#InterpolationMode} ```lua { @@ -17,6 +9,14 @@ INTERPOLATE_SINC: integer = 4, } ``` +### BeatSyncMode {#BeatSyncMode} +```lua +{ + BEAT_SYNC_REPITCH: integer = 1, + BEAT_SYNC_PERCUSSION: integer = 2, + BEAT_SYNC_TEXTURE: integer = 3, +} +``` ### NewNoteActionMode {#NewNoteActionMode} ```lua { diff --git a/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md b/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md index 16eb3ddc..29697599 100644 --- a/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md +++ b/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md @@ -1,13 +1,5 @@ # renoise.SampleEnvelopeModulationDevice ## Constants -### PlayMode {#PlayMode} -```lua -{ - PLAYMODE_POINTS: integer = 1, - PLAYMODE_LINES: integer = 2, - PLAYMODE_CURVES: integer = 3, -} -``` ### LoopMode {#LoopMode} ```lua { @@ -17,6 +9,14 @@ LOOP_MODE_PING_PONG: integer = 4, } ``` +### PlayMode {#PlayMode} +```lua +{ + PLAYMODE_POINTS: integer = 1, + PLAYMODE_LINES: integer = 2, + PLAYMODE_CURVES: integer = 3, +} +``` --- diff --git a/docs/API/renoise/renoise.SampleMapping.md b/docs/API/renoise/renoise.SampleMapping.md index f0329fb3..7280b9cc 100644 --- a/docs/API/renoise/renoise.SampleMapping.md +++ b/docs/API/renoise/renoise.SampleMapping.md @@ -5,7 +5,7 @@ modified. See `sample_mappings[].read_only` --- ## Properties ### base_note : [`integer`](/API/builtins/integer.md) {#base_note} -(0-119, c-4=48)] +Range: (0-119, c-4=48)] ### base_note_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#base_note_observable} Track changes to document properties or general states by attaching listener diff --git a/docs/API/renoise/renoise.Track.md b/docs/API/renoise/renoise.Track.md index ffcb2571..c6b09ba4 100644 --- a/docs/API/renoise/renoise.Track.md +++ b/docs/API/renoise/renoise.Track.md @@ -1,14 +1,6 @@ # renoise.Track Track component of a Renoise song. ## Constants -### MuteState {#MuteState} -```lua -{ - MUTE_STATE_ACTIVE: integer = 1, - MUTE_STATE_OFF: integer = 2, - MUTE_STATE_MUTED: integer = 3, -} -``` ### TrackType {#TrackType} ```lua { @@ -18,6 +10,14 @@ Track component of a Renoise song. TRACK_TYPE_GROUP: integer = 4, } ``` +### MuteState {#MuteState} +```lua +{ + MUTE_STATE_ACTIVE: integer = 1, + MUTE_STATE_OFF: integer = 2, + MUTE_STATE_MUTED: integer = 3, +} +``` --- diff --git a/docs/API/renoise/renoise.Transport.md b/docs/API/renoise/renoise.Transport.md index e053a055..e06e6a07 100644 --- a/docs/API/renoise/renoise.Transport.md +++ b/docs/API/renoise/renoise.Transport.md @@ -8,18 +8,18 @@ Transport component of the Renoise song. PLAYMODE_CONTINUE_PATTERN: integer = 2, } ``` -### TimingModel {#TimingModel} +### RecordParameterMode {#RecordParameterMode} ```lua { - TIMING_MODEL_SPEED: integer = 1, - TIMING_MODEL_LPB: integer = 2, + RECORD_PARAMETER_MODE_PATTERN: integer = 1, + RECORD_PARAMETER_MODE_AUTOMATION: integer = 2, } ``` -### RecordParameterMode {#RecordParameterMode} +### TimingModel {#TimingModel} ```lua { - RECORD_PARAMETER_MODE_PATTERN: integer = 1, - RECORD_PARAMETER_MODE_AUTOMATION: integer = 2, + TIMING_MODEL_SPEED: integer = 1, + TIMING_MODEL_LPB: integer = 2, } ```