Skip to content

Commit e456c44

Browse files
emuellemuell
committed
update bundled API docs
1 parent 724eeb3 commit e456c44

File tree

105 files changed

+905
-1435
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+905
-1435
lines changed

‎docs/API/modules/global.md

-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
---
44
## Functions
5-
### `OnSetText`(uri : [`any`](/API/builtins/any.md), text : [`any`](/API/builtins/any.md)) {#OnSetText}
6-
`->`[`table`](/API/builtins/table.md) | [`nil`](/API/builtins/nil.md)
7-
85
### `class`(name : [`string`](/API/builtins/string.md)) {#class}
96
`->`[`function`](/API/builtins/function.md)
107

‎docs/API/modules/io.md

+48-1
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,55 @@ group and others flags are ignored on windows and won't fire errors
1313

1414
Returns true when a file, folder or link at the given path and name exists
1515
### `stat`(filename : [`string`](/API/builtins/string.md)) {#stat}
16-
`->`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)
16+
`->`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)
1717

1818
Returns a table with status info about the file, folder or link at the given
1919
path and name, else nil the error and the error code is returned.
2020

21+
22+
23+
---
24+
## Structs
25+
# Stat
26+
return value for io.stat
27+
28+
---
29+
## Properties
30+
### atime : [`integer`](/API/builtins/integer.md) {#atime}
31+
last access time in seconds since the epoch
32+
33+
### ctime : [`integer`](/API/builtins/integer.md) {#ctime}
34+
inode change time (NOT creation time!) in seconds
35+
36+
### dev : [`integer`](/API/builtins/integer.md) {#dev}
37+
device number of filesystem
38+
39+
### gid : [`integer`](/API/builtins/integer.md) {#gid}
40+
numeric group ID of file's owner
41+
42+
### ino : [`integer`](/API/builtins/integer.md) {#ino}
43+
inode number
44+
45+
### mode : [`integer`](/API/builtins/integer.md) {#mode}
46+
unix styled file permissions
47+
48+
### mtime : [`integer`](/API/builtins/integer.md) {#mtime}
49+
last modify time in seconds since the epoch
50+
51+
### nlink : [`integer`](/API/builtins/integer.md) {#nlink}
52+
number of (hard) links to the file
53+
54+
### rdev : [`integer`](/API/builtins/integer.md) {#rdev}
55+
the device identifier (special files only)
56+
57+
### size : [`integer`](/API/builtins/integer.md) {#size}
58+
total size of file, in bytes
59+
60+
### type : `"file"` | `"directory"` | `"link"` | `"socket"` | `"named pipe"` | `"char device"` | `"block device"` {#type}
61+
### uid : [`integer`](/API/builtins/integer.md) {#uid}
62+
numeric user ID of file's owner
63+
64+
65+
66+
67+

‎docs/API/renoise/renoise.Application.md

+87-2
Original file line numberDiff line numberDiff line change
@@ -181,13 +181,13 @@ Save a current theme to a file with the given name. returns success.
181181

182182
Save a currently selected track device chain to a file with the given name.
183183
When no device chain is selected an error is raised. returns success.
184-
### `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}
184+
### `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}
185185
`->`[`renoise.Dialog`](/API/renoise/renoise.Dialog.md)
186186

187187
Shows a non modal dialog (a floating tool window) with custom content.
188188
When no key_handler is provided, the Escape key is used to close the dialog.
189189
See: ~renoise.ViewBuilder~ for more info about custom views.
190-
### `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}
190+
### `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}
191191
`->`label : [`string`](/API/builtins/string.md)
192192

193193
Opens a modal dialog with a title, custom content and custom button labels.
@@ -211,9 +211,94 @@ during uninstallation.
211211

212212

213213

214+
---
215+
## Structs
216+
# KeyEvent
217+
218+
---
219+
## Properties
220+
### character : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) {#character}
221+
possible character representation of the key
222+
223+
### modifiers : [`ModifierStates`](#ModifierStates) {#modifiers}
224+
the held down modifiers as a string
225+
226+
### name : [`string`](/API/builtins/string.md) {#name}
227+
name of the key, like 'esc' or 'a'
228+
229+
### note : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#note}
230+
virtual keyboard piano key value (starting from 0)
231+
232+
### repeated : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#repeated}
233+
only present if `send_key_repeat` was set to true
234+
235+
### state : `"pressed"` | `"released"` {#state}
236+
only present if `send_key_release` was set to true
237+
238+
239+
240+
241+
242+
---
243+
## Aliases
244+
# alias ModifierStates {#ModifierStates}
245+
[`string`](/API/builtins/string.md)
246+
The modifier keys will be provided as a string.
247+
Possible keys are dependent on the platform
248+
* Windows : "shift", "alt", "control", "winkey"
249+
* Linux : "shift", "alt", "control", "meta"
250+
* Mac : "shift", "option", "control", "command"
251+
If multiple modifiers are held down, the string will be formatted as
252+
"<key> + <key>"
253+
Their order will correspond to the following precedence
254+
`shift + alt/option + control + winkey/meta/command`
255+
If no modifier is pressed, this will be an empty string
256+
257+
258+
259+
# KeyHandlerOptions
260+
261+
---
262+
## Properties
263+
### send_key_release : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#send_key_release}
264+
Default: false
265+
266+
### send_key_repeat : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#send_key_repeat}
267+
Default: true
268+
269+
270+
271+
272+
273+
274+
214275
---
215276
## Aliases
216277
# alias DialogTitle {#DialogTitle}
217278
[`string`](/API/builtins/string.md)
218279

280+
281+
# alias KeyHandler {#KeyHandler}
282+
(dialog : [`renoise.Dialog`](/API/renoise/renoise.Dialog.md), key_event : [`KeyEvent`](#keyevent)) `->` [`KeyEvent`](#keyevent)[`?`](/API/builtins/nil.md)
283+
Optional keyhandler to process key events on a custom dialog.
284+
When returning the passed key from the key-handler function, the
285+
key will be passed back to Renoise's key event chain, in order to allow
286+
processing global Renoise key-bindings from your dialog. This will not work
287+
for modal dialogs. This also only applies to global shortcuts in Renoise,
288+
because your dialog will steal the focus from all other Renoise views such as
289+
the Pattern Editor, etc.
290+
291+
# alias ModifierStates {#ModifierStates}
292+
[`string`](/API/builtins/string.md)
293+
The modifier keys will be provided as a string.
294+
Possible keys are dependent on the platform
295+
* Windows : "shift", "alt", "control", "winkey"
296+
* Linux : "shift", "alt", "control", "meta"
297+
* Mac : "shift", "option", "control", "command"
298+
If multiple modifiers are held down, the string will be formatted as
299+
"<key> + <key>"
300+
Their order will correspond to the following precedence
301+
`shift + alt/option + control + winkey/meta/command`
302+
If no modifier is pressed, this will be an empty string
303+
219304

‎docs/API/renoise/renoise.ApplicationWindow.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ Application window and general UI properties of the Renoise app.
88
UPPER_FRAME_MASTER_SPECTRUM: integer = 2,
99
}
1010
```
11-
### MixerFader {#MixerFader}
11+
### LowerFrame {#LowerFrame}
1212
```lua
1313
{
14-
MIXER_FADER_TYPE_24DB: integer = 1,
15-
MIXER_FADER_TYPE_48DB: integer = 2,
16-
MIXER_FADER_TYPE_96DB: integer = 3,
17-
MIXER_FADER_TYPE_LINEAR: integer = 4,
14+
LOWER_FRAME_TRACK_DSPS: integer = 1,
15+
LOWER_FRAME_TRACK_AUTOMATION: integer = 2,
1816
}
1917
```
2018
### MiddleFrame {#MiddleFrame}
@@ -31,11 +29,13 @@ Application window and general UI properties of the Renoise app.
3129
MIDDLE_FRAME_INSTRUMENT_MIDI_EDITOR: integer = 9,
3230
}
3331
```
34-
### LowerFrame {#LowerFrame}
32+
### MixerFader {#MixerFader}
3533
```lua
3634
{
37-
LOWER_FRAME_TRACK_DSPS: integer = 1,
38-
LOWER_FRAME_TRACK_AUTOMATION: integer = 2,
35+
MIXER_FADER_TYPE_24DB: integer = 1,
36+
MIXER_FADER_TYPE_48DB: integer = 2,
37+
MIXER_FADER_TYPE_96DB: integer = 3,
38+
MIXER_FADER_TYPE_LINEAR: integer = 4,
3939
}
4040
```
4141

‎docs/API/renoise/renoise.Document.DocumentList.md

+1
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,5 @@ With a series of swaps you can move the item from/to any position.
4949
# alias ListNotifierFunction {#ListNotifierFunction}
5050
(change : [`ListElementChange`](#ListElementChange))
5151

52+
5253

‎docs/API/renoise/renoise.Document.DocumentNode.md

+2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ Serialize the whole document tree to a XML string.
6666
[`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)
6767
A document node is a sub component in a document which contains other
6868
documents or observables.
69+
6970
# alias ObservableProperties {#ObservableProperties}
7071
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)>
7172

73+
7274

‎docs/API/renoise/renoise.Document.Observable.md

+1
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,5 @@ into an error.
6565
# alias NotifierFunction {#NotifierFunction}
6666
fun()
6767

68+
6869

‎docs/API/renoise/renoise.Document.ObservableBang.md

+1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,5 @@ into an error.
4242
# alias NotifierFunction {#NotifierFunction}
4343
fun()
4444

45+
4546

‎docs/API/renoise/renoise.Document.ObservableBoolean.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,5 @@ Serialize an object to a string.
5555
# alias NotifierFunction {#NotifierFunction}
5656
fun()
5757

58+
5859

‎docs/API/renoise/renoise.Document.ObservableBooleanList.md

+1
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,5 @@ Serialize an object to a string.
5757
# alias ListNotifierFunction {#ListNotifierFunction}
5858
(change : [`ListElementChange`](#ListElementChange))
5959

60+
6061

‎docs/API/renoise/renoise.Document.ObservableList.md

+1
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,5 @@ Returns the number of entries of the list.
5050
# alias ListNotifierFunction {#ListNotifierFunction}
5151
(change : [`ListElementChange`](#ListElementChange))
5252

53+
5354

‎docs/API/renoise/renoise.Document.ObservableNumber.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,5 @@ Serialize an object to a string.
5555
# alias NotifierFunction {#NotifierFunction}
5656
fun()
5757

58+
5859

‎docs/API/renoise/renoise.Document.ObservableNumberList.md

+1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,5 @@ Serialize an object to a string.
5656
# alias ListNotifierFunction {#ListNotifierFunction}
5757
(change : [`ListElementChange`](#ListElementChange))
5858

59+
5960

‎docs/API/renoise/renoise.Document.ObservableString.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,5 @@ Serialize an object to a string.
5555
# alias NotifierFunction {#NotifierFunction}
5656
fun()
5757

58+
5859

‎docs/API/renoise/renoise.Document.ObservableStringList.md

+1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,5 @@ Serialize an object to a string.
5656
# alias ListNotifierFunction {#ListNotifierFunction}
5757
(change : [`ListElementChange`](#ListElementChange))
5858

59+
5960

‎docs/API/renoise/renoise.Document.md

+1
Original file line numberDiff line numberDiff line change
@@ -180,4 +180,5 @@ have been registered with `renoise.Document.create` before.
180180
# alias ObservableProperties {#ObservableProperties}
181181
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)>
182182

183+
183184

‎docs/API/renoise/renoise.GroupTrack.md

+33-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Group track component of a Renoise song.
33

44
---
55
## Properties
6-
### available_device_infos : [`AudioDeviceInfo`](/API/structs/AudioDeviceInfo.md)`[]` {#available_device_infos}
6+
### available_device_infos : [`AudioDeviceInfo`](#audiodeviceinfo)`[]` {#available_device_infos}
77
**READ-ONLY** Array of tables containing information about the devices.
88

99
### 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.
146146

147147

148148

149+
---
150+
## Structs
151+
# AudioDeviceInfo
152+
Audio device info
153+
154+
---
155+
## Properties
156+
### favorite_name : [`string`](/API/builtins/string.md) {#favorite_name}
157+
The device's name as displayed in favorites
158+
159+
### is_bridged : [`boolean`](/API/builtins/boolean.md) {#is_bridged}
160+
true if the device is a bridged plugin
161+
162+
### is_favorite : [`boolean`](/API/builtins/boolean.md) {#is_favorite}
163+
true if the device is a favorite
164+
165+
### name : [`string`](/API/builtins/string.md) {#name}
166+
The device's name
167+
168+
### path : [`string`](/API/builtins/string.md) {#path}
169+
The device's path used by `renoise.Track:insert_device_at`
170+
171+
### short_name : [`string`](/API/builtins/string.md) {#short_name}
172+
The device's name as displayed in shortened lists
173+
174+
175+
176+
177+
178+
179+
149180
---
150181
## Aliases
151182
# alias RGBColor {#RGBColor}
@@ -154,4 +185,5 @@ A table of 3 bytes (ranging from 0 to 255)
154185
representing the red, green and blue channels of a color.
155186
{0xFF, 0xFF, 0xFF} is white
156187
{165, 73, 35} is the red from the Renoise logo
188+
157189

‎docs/API/renoise/renoise.Instrument.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# renoise.Instrument
22
## Constants
3-
### PhrasePlaybackMode {#PhrasePlaybackMode}
4-
```lua
5-
{
6-
PHRASES_OFF: integer = 1,
7-
PHRASES_PLAY_SELECTIVE: integer = 2,
8-
PHRASES_PLAY_KEYMAP: integer = 3,
9-
}
10-
```
113
### Layer {#Layer}
124
```lua
135
{
@@ -32,6 +24,14 @@
3224
TAB_EXT_MIDI: integer = 3,
3325
}
3426
```
27+
### PhrasePlaybackMode {#PhrasePlaybackMode}
28+
```lua
29+
{
30+
PHRASES_OFF: integer = 1,
31+
PHRASES_PLAY_SELECTIVE: integer = 2,
32+
PHRASES_PLAY_KEYMAP: integer = 3,
33+
}
34+
```
3535

3636

3737
---
@@ -96,7 +96,7 @@ Phrase playback program: 0 = Off, 1-126 = specific phrase, 127 = keymap.
9696
### pitchbend_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) {#pitchbend_macro}
9797
Access the MIDI pitch-bend macro
9898

99-
### plugin_properties : [`renoise.InstrumentPluginProperties`](/API/renoise/renoise.InstrumentPluginProperties.md) {#plugin_properties}
99+
### plugin_properties : renoise.InstrumentPluginProperties {#plugin_properties}
100100
**READ-ONLY** Plugin properties.
101101

102102
### sample_device_chains : [`renoise.SampleDeviceChain`](/API/renoise/renoise.SampleDeviceChain.md)`[]` {#sample_device_chains}

‎docs/API/renoise/renoise.InstrumentDevice.md

-2
This file was deleted.

0 commit comments

Comments
 (0)