update bundled API docs

renoise · Jul 30, 2024 · e456c44 · e456c44
1 parent 724eeb3
commit e456c44
Show file tree

Hide file tree

Showing 105 changed files with 905 additions and 1,435 deletions.
diff --git a/docs/API/modules/global.md b/docs/API/modules/global.md
@@ -2,9 +2,6 @@
 
 ---  
 ## Functions
-### `OnSetText`(uri : [`any`](/API/builtins/any.md), text : [`any`](/API/builtins/any.md)) {#OnSetText}
-`->`[`table`](/API/builtins/table.md) | [`nil`](/API/builtins/nil.md)  
-
 ### `class`(name : [`string`](/API/builtins/string.md)) {#class}
 `->`[`function`](/API/builtins/function.md)  
 

diff --git a/docs/API/modules/io.md b/docs/API/modules/io.md
@@ -13,8 +13,55 @@ group and others flags are ignored on windows and won't fire errors
 
 Returns true when a file, folder or link at the given path and name exists
 ### `stat`(filename : [`string`](/API/builtins/string.md)) {#stat}
-`->`result : [`Stat`](/API/structs/Stat.md)[`?`](/API/builtins/nil.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md), error_code : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md)  
+`->`result : [`Stat`](#stat)[`?`](/API/builtins/nil.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md), error_code : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md)  
 
 Returns a table with status info about the file, folder or link at the given
 path and name, else nil the error and the error code is returned.  
 
+
+
+---  
+## Structs  
+# Stat  
+return value for io.stat  
+
+---  
+## Properties
+### atime : [`integer`](/API/builtins/integer.md) {#atime}
+last access time in seconds since the epoch
+
+### ctime : [`integer`](/API/builtins/integer.md) {#ctime}
+inode change time (NOT creation time!) in seconds
+
+### dev : [`integer`](/API/builtins/integer.md) {#dev}
+device number of filesystem
+
+### gid : [`integer`](/API/builtins/integer.md) {#gid}
+numeric group ID of file's owner
+
+### ino : [`integer`](/API/builtins/integer.md) {#ino}
+inode number
+
+### mode : [`integer`](/API/builtins/integer.md) {#mode}
+unix styled file permissions
+
+### mtime : [`integer`](/API/builtins/integer.md) {#mtime}
+last modify time in seconds since the epoch
+
+### nlink : [`integer`](/API/builtins/integer.md) {#nlink}
+number of (hard) links to the file
+
+### rdev : [`integer`](/API/builtins/integer.md) {#rdev}
+the device identifier (special files only)
+
+### size : [`integer`](/API/builtins/integer.md) {#size}
+total size of file, in bytes
+
+### type : `"file"` | `"directory"` | `"link"` | `"socket"` | `"named pipe"` | `"char device"` | `"block device"` {#type}
+### uid : [`integer`](/API/builtins/integer.md) {#uid}
+numeric user ID of file's owner
+
+
+
+
+
diff --git a/docs/API/renoise/renoise.Application.md b/docs/API/renoise/renoise.Application.md
@@ -181,13 +181,13 @@ Save a current theme to a file with the given name. returns success.
 
 Save a currently selected track device chain to a file with the given name.
 When no device chain is selected an error is raised. returns success.
-### `show_custom_dialog`([*self*](/API/builtins/self.md), title : [`DialogTitle`](#DialogTitle), content_view : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md), key_handler : [`KeyHandler`](#KeyHandler)[`?`](/API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](/API/structs/KeyHandlerOptions.md)[`?`](/API/builtins/nil.md)) {#show_custom_dialog}
+### `show_custom_dialog`([*self*](/API/builtins/self.md), title : [`DialogTitle`](#DialogTitle), content_view : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md), key_handler : [`KeyHandler`](#KeyHandler)[`?`](/API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](/API/builtins/nil.md)) {#show_custom_dialog}
 `->`[`renoise.Dialog`](/API/renoise/renoise.Dialog.md)  
 
 Shows a non modal dialog (a floating tool window) with custom content.  
 When no key_handler is provided, the Escape key is used to close the dialog.
 See: ~renoise.ViewBuilder~ for more info about custom views.
-### `show_custom_prompt`([*self*](/API/builtins/self.md), title : [`string`](/API/builtins/string.md), content_view : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md), button_labels : [`string`](/API/builtins/string.md)`[]`, key_handler : [`KeyHandler`](#KeyHandler)[`?`](/API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](/API/structs/KeyHandlerOptions.md)[`?`](/API/builtins/nil.md)) {#show_custom_prompt}
+### `show_custom_prompt`([*self*](/API/builtins/self.md), title : [`string`](/API/builtins/string.md), content_view : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md), button_labels : [`string`](/API/builtins/string.md)`[]`, key_handler : [`KeyHandler`](#KeyHandler)[`?`](/API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](/API/builtins/nil.md)) {#show_custom_prompt}
 `->`label : [`string`](/API/builtins/string.md)  
 
 Opens a modal dialog with a title, custom content and custom button labels.  
@@ -211,9 +211,94 @@ during uninstallation.
 
 
 
+---  
+## Structs  
+# KeyEvent  
+
+---  
+## Properties
+### character : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) {#character}
+possible character representation of the key
+
+### modifiers : [`ModifierStates`](#ModifierStates) {#modifiers}
+the held down modifiers as a string
+
+### name : [`string`](/API/builtins/string.md) {#name}
+name of the key, like 'esc' or 'a'
+
+### note : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#note}
+virtual keyboard piano key value (starting from 0)
+
+### repeated : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#repeated}
+only present if `send_key_repeat` was set to true
+
+### state : `"pressed"` | `"released"` {#state}
+only present if `send_key_release` was set to true
+
+
+
+
+
+---  
+## Aliases  
+# alias ModifierStates {#ModifierStates}
+[`string`](/API/builtins/string.md)  
+The modifier keys will be provided as a string.  
+Possible keys are dependent on the platform
+ * Windows : "shift", "alt", "control", "winkey"
+ * Linux : "shift", "alt", "control", "meta"
+ * Mac : "shift", "option", "control", "command"
+If multiple modifiers are held down, the string will be formatted as  
+"<key> + <key>"
+Their order will correspond to the following precedence
+`shift + alt/option + control + winkey/meta/command`  
+If no modifier is pressed, this will be an empty string  
+
+
+
+# KeyHandlerOptions  
+
+---  
+## Properties
+### send_key_release : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#send_key_release}
+Default: false
+
+### send_key_repeat : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#send_key_repeat}
+Default: true
+
+
+
+
+
+
+
 ---  
 ## Aliases  
 # alias DialogTitle {#DialogTitle}
 [`string`](/API/builtins/string.md)  
 
+
+# alias KeyHandler {#KeyHandler}
+(dialog : [`renoise.Dialog`](/API/renoise/renoise.Dialog.md), key_event : [`KeyEvent`](#keyevent)) `->` [`KeyEvent`](#keyevent)[`?`](/API/builtins/nil.md)  
+Optional keyhandler to process key events on a custom dialog.  
+When returning the passed key from the key-handler function, the
+key will be passed back to Renoise's key event chain, in order to allow
+processing global Renoise key-bindings from your dialog. This will not work
+for modal dialogs. This also only applies to global shortcuts in Renoise,
+because your dialog will steal the focus from all other Renoise views such as
+the Pattern Editor, etc.  
+
+# alias ModifierStates {#ModifierStates}
+[`string`](/API/builtins/string.md)  
+The modifier keys will be provided as a string.  
+Possible keys are dependent on the platform
+ * Windows : "shift", "alt", "control", "winkey"
+ * Linux : "shift", "alt", "control", "meta"
+ * Mac : "shift", "option", "control", "command"
+If multiple modifiers are held down, the string will be formatted as  
+"<key> + <key>"
+Their order will correspond to the following precedence
+`shift + alt/option + control + winkey/meta/command`  
+If no modifier is pressed, this will be an empty string  
+
 
diff --git a/docs/API/renoise/renoise.ApplicationWindow.md b/docs/API/renoise/renoise.ApplicationWindow.md
@@ -8,13 +8,11 @@ Application window and general UI properties of the Renoise app.
     UPPER_FRAME_MASTER_SPECTRUM: integer = 2,
 }
 ```
-### MixerFader {#MixerFader}
+### LowerFrame {#LowerFrame}
 ```lua
 {
-    MIXER_FADER_TYPE_24DB: integer = 1,
-    MIXER_FADER_TYPE_48DB: integer = 2,
-    MIXER_FADER_TYPE_96DB: integer = 3,
-    MIXER_FADER_TYPE_LINEAR: integer = 4,
+    LOWER_FRAME_TRACK_DSPS: integer = 1,
+    LOWER_FRAME_TRACK_AUTOMATION: integer = 2,
 }
 ```
 ### MiddleFrame {#MiddleFrame}
@@ -31,11 +29,13 @@ Application window and general UI properties of the Renoise app.
     MIDDLE_FRAME_INSTRUMENT_MIDI_EDITOR: integer = 9,
 }
 ```
-### LowerFrame {#LowerFrame}
+### MixerFader {#MixerFader}
 ```lua
 {
-    LOWER_FRAME_TRACK_DSPS: integer = 1,
-    LOWER_FRAME_TRACK_AUTOMATION: integer = 2,
+    MIXER_FADER_TYPE_24DB: integer = 1,
+    MIXER_FADER_TYPE_48DB: integer = 2,
+    MIXER_FADER_TYPE_96DB: integer = 3,
+    MIXER_FADER_TYPE_LINEAR: integer = 4,
 }
 ```
 

diff --git a/docs/API/renoise/renoise.Document.DocumentList.md b/docs/API/renoise/renoise.Document.DocumentList.md
@@ -49,4 +49,5 @@ With a series of swaps you can move the item from/to any position.
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.DocumentNode.md b/docs/API/renoise/renoise.Document.DocumentNode.md
@@ -66,7 +66,9 @@ Serialize the whole document tree to a XML string.
 [`renoise.Document.DocumentList`](/API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) | [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) | [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md)  
 A document node is a sub component in a document which contains other
 documents or observables.  
+
 # alias ObservableProperties {#ObservableProperties}
 table<[`string`](/API/builtins/string.md), [`ObservableTypes`](#ObservableTypes) | [`renoise.Document.DocumentList`](/API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)>  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.Observable.md b/docs/API/renoise/renoise.Document.Observable.md
@@ -65,4 +65,5 @@ into an error.
 # alias NotifierFunction {#NotifierFunction}
 fun()  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableBang.md b/docs/API/renoise/renoise.Document.ObservableBang.md
@@ -42,4 +42,5 @@ into an error.
 # alias NotifierFunction {#NotifierFunction}
 fun()  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableBoolean.md b/docs/API/renoise/renoise.Document.ObservableBoolean.md
@@ -55,4 +55,5 @@ Serialize an object to a string.
 # alias NotifierFunction {#NotifierFunction}
 fun()  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableBooleanList.md b/docs/API/renoise/renoise.Document.ObservableBooleanList.md
@@ -57,4 +57,5 @@ Serialize an object to a string.
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableList.md b/docs/API/renoise/renoise.Document.ObservableList.md
@@ -50,4 +50,5 @@ Returns the number of entries of the list.
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableNumber.md b/docs/API/renoise/renoise.Document.ObservableNumber.md
@@ -55,4 +55,5 @@ Serialize an object to a string.
 # alias NotifierFunction {#NotifierFunction}
 fun()  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableNumberList.md b/docs/API/renoise/renoise.Document.ObservableNumberList.md
@@ -56,4 +56,5 @@ Serialize an object to a string.
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableString.md b/docs/API/renoise/renoise.Document.ObservableString.md
@@ -55,4 +55,5 @@ Serialize an object to a string.
 # alias NotifierFunction {#NotifierFunction}
 fun()  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableStringList.md b/docs/API/renoise/renoise.Document.ObservableStringList.md
@@ -56,4 +56,5 @@ Serialize an object to a string.
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 
+
 
diff --git a/docs/API/renoise/renoise.Document.md b/docs/API/renoise/renoise.Document.md
@@ -180,4 +180,5 @@ have been registered with `renoise.Document.create` before.
 # alias ObservableProperties {#ObservableProperties}
 table<[`string`](/API/builtins/string.md), [`ObservableTypes`](#ObservableTypes) | [`renoise.Document.DocumentList`](/API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)>  
 
+
 
diff --git a/docs/API/renoise/renoise.GroupTrack.md b/docs/API/renoise/renoise.GroupTrack.md
@@ -3,7 +3,7 @@ Group track component of a Renoise song.
 
 ---  
 ## Properties
-### available_device_infos : [`AudioDeviceInfo`](/API/structs/AudioDeviceInfo.md)`[]` {#available_device_infos}
+### available_device_infos : [`AudioDeviceInfo`](#audiodeviceinfo)`[]` {#available_device_infos}
 **READ-ONLY** Array of tables containing information about the devices.
 
 ### available_devices : [`string`](/API/builtins/string.md)`[]` {#available_devices}
@@ -146,6 +146,37 @@ Swap the positions of two note or effect columns within a track.
 
 
 
+---  
+## Structs  
+# AudioDeviceInfo  
+Audio device info  
+
+---  
+## Properties
+### favorite_name : [`string`](/API/builtins/string.md) {#favorite_name}
+The device's name as displayed in favorites
+
+### is_bridged : [`boolean`](/API/builtins/boolean.md) {#is_bridged}
+true if the device is a bridged plugin
+
+### is_favorite : [`boolean`](/API/builtins/boolean.md) {#is_favorite}
+true if the device is a favorite
+
+### name : [`string`](/API/builtins/string.md) {#name}
+The device's name
+
+### path : [`string`](/API/builtins/string.md) {#path}
+The device's path used by `renoise.Track:insert_device_at`
+
+### short_name : [`string`](/API/builtins/string.md) {#short_name}
+The device's name as displayed in shortened lists
+
+
+
+
+
+
+
 ---  
 ## Aliases  
 # alias RGBColor {#RGBColor}
@@ -154,4 +185,5 @@ A table of 3 bytes (ranging from 0 to 255)
 representing the red, green and blue channels of a color.
 {0xFF, 0xFF, 0xFF} is white
 {165, 73, 35} is the red from the Renoise logo  
+
 
diff --git a/docs/API/renoise/renoise.Instrument.md b/docs/API/renoise/renoise.Instrument.md
@@ -1,13 +1,5 @@
 # renoise.Instrument  
 ## Constants
-### PhrasePlaybackMode {#PhrasePlaybackMode}
-```lua
-{
-    PHRASES_OFF: integer = 1,
-    PHRASES_PLAY_SELECTIVE: integer = 2,
-    PHRASES_PLAY_KEYMAP: integer = 3,
-}
-```
 ### Layer {#Layer}
 ```lua
 {
@@ -32,6 +24,14 @@
     TAB_EXT_MIDI: integer = 3,
 }
 ```
+### PhrasePlaybackMode {#PhrasePlaybackMode}
+```lua
+{
+    PHRASES_OFF: integer = 1,
+    PHRASES_PLAY_SELECTIVE: integer = 2,
+    PHRASES_PLAY_KEYMAP: integer = 3,
+}
+```
 
 
 ---  
@@ -96,7 +96,7 @@ Phrase playback program: 0 = Off, 1-126 = specific phrase, 127 = keymap.
 ### pitchbend_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) {#pitchbend_macro}
 Access the MIDI pitch-bend macro
 
-### plugin_properties : [`renoise.InstrumentPluginProperties`](/API/renoise/renoise.InstrumentPluginProperties.md) {#plugin_properties}
+### plugin_properties : renoise.InstrumentPluginProperties {#plugin_properties}
 **READ-ONLY** Plugin properties.
 
 ### sample_device_chains : [`renoise.SampleDeviceChain`](/API/renoise/renoise.SampleDeviceChain.md)`[]` {#sample_device_chains}

diff --git a/docs/API/renoise/renoise.InstrumentDevice.md b/docs/API/renoise/renoise.InstrumentDevice.md