diff --git a/docs/API/aliases.md b/docs/API/aliases.md deleted file mode 100644 index a2c039f0..00000000 --- a/docs/API/aliases.md +++ /dev/null @@ -1 +0,0 @@ -#Aliases \ No newline at end of file diff --git a/docs/API/aliases/AlignerConstructor.md b/docs/API/aliases/AlignerConstructor.md deleted file mode 100644 index 8eead748..00000000 --- a/docs/API/aliases/AlignerConstructor.md +++ /dev/null @@ -1,17 +0,0 @@ -# alias AlignerConstructor {#AlignerConstructor} -(self : [`ViewBuilderInstance`](/API/structs/ViewBuilderInstance.md), properties : [`AlignerViewProperties`](/API/structs/AlignerViewProperties.md)[`?`](/API/builtins/nil.md)) `->` [`renoise.Views.Aligner`](/API/renoise.Views.Aligner.md) -You can add nested child views when constructing aligners by including them -in the constructor table. - -### example: -```lua -vb:horizontal_aligner { - mode = "center", - vb:text { - text = "Text1" - }, - vb:text { - text = "Text2" - } -} -``` \ No newline at end of file diff --git a/docs/API/aliases/AlignerMode.md b/docs/API/aliases/AlignerMode.md deleted file mode 100644 index a5c6e7d8..00000000 --- a/docs/API/aliases/AlignerMode.md +++ /dev/null @@ -1,13 +0,0 @@ -# alias AlignerMode {#AlignerMode} -`"bottom"` | `"center"` | `"distribute"` | `"justify"` | `"left"` | `"right"` | `"top"` -```lua --- * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) -AlignerMode: - | "left" -- align from left to right (for horizontal_aligner only) - | "right" -- align from right to left (for horizontal_aligner only) - | "top" -- align from top to bottom (for vertical_aligner only) - | "bottom" -- align from bottom to top (for vertical_aligner only) - | "center" -- center all views - | "justify" -- keep outer views at the borders, distribute the rest - | "distribute" -- equally distributes views over the aligners width/height -``` \ No newline at end of file diff --git a/docs/API/aliases/BitmapImagePath.md b/docs/API/aliases/BitmapImagePath.md deleted file mode 100644 index d774a190..00000000 --- a/docs/API/aliases/BitmapImagePath.md +++ /dev/null @@ -1,19 +0,0 @@ -# alias BitmapImagePath {#BitmapImagePath} -[`string`](/API/builtins/string.md) -You can load an image from your tool's directory, -or use one from Renoise's built-in icons. -* For the built-in icons, use "Icons/ArrowRight.bmp" -* For custom images, use a path relative to your tool's root folder. - -For example "Images/MyBitmap.bmp" will load the image from -"com.me.MyTool.xrnx/Images/MyBitmap.bmp". -If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), -your image will be loaded instead of the one from Renoise. - -If you want to support high DPI UI scaling with your bitmaps like the built-in Icons, -include high resolution versions with their filenames ending with "@4x" -The following rules will be used when loading bitmaps -* When UI scaling is 100%, only the base bitmaps are used. -* When UI scaling is 125%, the base bitmaps are used, except if there is a `BitmapName@x1.25.bmp` variant. -* For all other UI scaling > 125% the "@4x" variants are used and downscaled as needed, -except when there is an exact match for the current UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) \ No newline at end of file diff --git a/docs/API/aliases/BitmapMode.md b/docs/API/aliases/BitmapMode.md deleted file mode 100644 index 025c3e42..00000000 --- a/docs/API/aliases/BitmapMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# alias BitmapMode {#BitmapMode} -`"body_color"` | `"button_color"` | `"main_color"` | `"plain"` | `"transparent"` -```lua --- Setup how the bitmap should be drawn, recolored. Available modes are: -BitmapMode: - | "plain" -- bitmap is drawn as is, no recoloring is done (Default) - | "transparent" -- same as plain, but black pixels will be fully transparent - | "button_color" -- recolor the bitmap, using the theme's button color - | "body_color" -- same as 'button_back' but with body text/back color - | "main_color" -- same as 'button_back' but with main text/back colors -``` \ No newline at end of file diff --git a/docs/API/aliases/BitmapPath.md b/docs/API/aliases/BitmapPath.md deleted file mode 100644 index 3e660106..00000000 --- a/docs/API/aliases/BitmapPath.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias BitmapPath {#BitmapPath} -[`BitmapImagePath`](/API/aliases/BitmapImagePath.md) -Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). \ No newline at end of file diff --git a/docs/API/aliases/BooleanValueNotifierFunction.md b/docs/API/aliases/BooleanValueNotifierFunction.md deleted file mode 100644 index 05f1e01b..00000000 --- a/docs/API/aliases/BooleanValueNotifierFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias BooleanValueNotifierFunction {#BooleanValueNotifierFunction} -(value : [`boolean`](/API/builtins/boolean.md)) diff --git a/docs/API/aliases/BooleanValueNotifierMemberFunction.md b/docs/API/aliases/BooleanValueNotifierMemberFunction.md deleted file mode 100644 index e513b104..00000000 --- a/docs/API/aliases/BooleanValueNotifierMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias BooleanValueNotifierMemberFunction {#BooleanValueNotifierMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), value : [`boolean`](/API/builtins/boolean.md)) diff --git a/docs/API/aliases/BooleanValueNotifierMethod1.md b/docs/API/aliases/BooleanValueNotifierMethod1.md deleted file mode 100644 index 2f5657b2..00000000 --- a/docs/API/aliases/BooleanValueNotifierMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias BooleanValueNotifierMethod1 {#BooleanValueNotifierMethod1} -{ 1 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), 2 : [`BooleanValueNotifierMemberFunction`](/API/aliases/BooleanValueNotifierMemberFunction.md) } diff --git a/docs/API/aliases/BooleanValueNotifierMethod2.md b/docs/API/aliases/BooleanValueNotifierMethod2.md deleted file mode 100644 index 1ba1a850..00000000 --- a/docs/API/aliases/BooleanValueNotifierMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias BooleanValueNotifierMethod2 {#BooleanValueNotifierMethod2} -{ 1 : [`BooleanValueNotifierMemberFunction`](/API/aliases/BooleanValueNotifierMemberFunction.md), 2 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md) } diff --git a/docs/API/aliases/ButtonBitmapPath.md b/docs/API/aliases/ButtonBitmapPath.md deleted file mode 100644 index a33097c9..00000000 --- a/docs/API/aliases/ButtonBitmapPath.md +++ /dev/null @@ -1,9 +0,0 @@ -# alias ButtonBitmapPath {#ButtonBitmapPath} -[`BitmapImagePath`](/API/aliases/BitmapImagePath.md) -If set, existing text is removed and the loaded image is displayed instead. -Supported bitmap file formats are ".bmp", ".png" and ".tiff". -Colors in bitmaps will be overridden by the button's theme color, using black -as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. -All other colors are mapped to the theme color according to their grey value, -so plain white is the target theme color, and all other colors blend into the -button's background color of the theme. \ No newline at end of file diff --git a/docs/API/aliases/ButtonColor.md b/docs/API/aliases/ButtonColor.md deleted file mode 100644 index ae35e0a9..00000000 --- a/docs/API/aliases/ButtonColor.md +++ /dev/null @@ -1,6 +0,0 @@ -# alias ButtonColor {#ButtonColor} -[`RGBColor`](/API/aliases/RGBColor.md) -When set, the unpressed button's background will be drawn in the specified color. -A text color is automatically selected unless explicitly set, to make sure it's -always visible. -Set color {0,0,0} to enable the theme colors for the button again. \ No newline at end of file diff --git a/docs/API/aliases/ButtonLabel.md b/docs/API/aliases/ButtonLabel.md deleted file mode 100644 index 4fd6499a..00000000 --- a/docs/API/aliases/ButtonLabel.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias ButtonLabel {#ButtonLabel} -[`string`](/API/builtins/string.md) -The text label of the button -* Default: "" \ No newline at end of file diff --git a/docs/API/aliases/ButtonNotifier.md b/docs/API/aliases/ButtonNotifier.md deleted file mode 100644 index fdf8bf64..00000000 --- a/docs/API/aliases/ButtonNotifier.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias ButtonNotifier {#ButtonNotifier} -[`NotifierFunction`](/API/aliases/NotifierFunction.md) | [`NotifierMethod1`](/API/aliases/NotifierMethod1.md) | [`NotifierMethod2`](/API/aliases/NotifierMethod2.md) -A click notifier \ No newline at end of file diff --git a/docs/API/aliases/CheckBoxBoolean.md b/docs/API/aliases/CheckBoxBoolean.md deleted file mode 100644 index 1901f9e0..00000000 --- a/docs/API/aliases/CheckBoxBoolean.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias CheckBoxBoolean {#CheckBoxBoolean} -[`boolean`](/API/builtins/boolean.md) -The current state of the checkbox, expressed as boolean. -* Default: false \ No newline at end of file diff --git a/docs/API/aliases/CheckBoxBooleanNotifier.md b/docs/API/aliases/CheckBoxBooleanNotifier.md deleted file mode 100644 index d609cc1a..00000000 --- a/docs/API/aliases/CheckBoxBooleanNotifier.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias CheckBoxBooleanNotifier {#CheckBoxBooleanNotifier} -[`BooleanValueNotifierFunction`](/API/aliases/BooleanValueNotifierFunction.md) | [`BooleanValueNotifierMethod1`](/API/aliases/BooleanValueNotifierMethod1.md) | [`BooleanValueNotifierMethod2`](/API/aliases/BooleanValueNotifierMethod2.md) -A notifier for when the checkbox is toggled \ No newline at end of file diff --git a/docs/API/aliases/ControlActive.md b/docs/API/aliases/ControlActive.md deleted file mode 100644 index 09ef8d2b..00000000 --- a/docs/API/aliases/ControlActive.md +++ /dev/null @@ -1,6 +0,0 @@ -# alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) -Instead of making a control invisible, you can also make it inactive. -Deactivated controls will still be shown, and will still show their -currently assigned values, but will not allow changes. Most controls will -display as "grayed out" to visualize the deactivated state. \ No newline at end of file diff --git a/docs/API/aliases/ControlMidiMappingString.md b/docs/API/aliases/ControlMidiMappingString.md deleted file mode 100644 index 9f5f3db5..00000000 --- a/docs/API/aliases/ControlMidiMappingString.md +++ /dev/null @@ -1,8 +0,0 @@ -# alias ControlMidiMappingString {#ControlMidiMappingString} -[`string`](/API/builtins/string.md) -When set, the control will be highlighted when Renoise's MIDI mapping dialog -is open. When clicked, it selects the specified string as a MIDI mapping -target action. This target acton can either be one of the globally available -mappings in Renoise, or those that were created by the tool itself. -Target strings are not verified. When they point to nothing, the mapped MIDI -message will do nothing and no error is fired. \ No newline at end of file diff --git a/docs/API/aliases/DialogTitle.md b/docs/API/aliases/DialogTitle.md deleted file mode 100644 index faa3e779..00000000 --- a/docs/API/aliases/DialogTitle.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias DialogTitle {#DialogTitle} -[`string`](/API/builtins/string.md) diff --git a/docs/API/aliases/DocumentMember.md b/docs/API/aliases/DocumentMember.md deleted file mode 100644 index 6c47f6a6..00000000 --- a/docs/API/aliases/DocumentMember.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias DocumentMember {#DocumentMember} -[`renoise.Document.DocumentList`](/API/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) | [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) | [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) -A document node is a sub component in a document which contains other -documents or observables. \ No newline at end of file diff --git a/docs/API/aliases/FileHookCategory.md b/docs/API/aliases/FileHookCategory.md deleted file mode 100644 index 79c5d406..00000000 --- a/docs/API/aliases/FileHookCategory.md +++ /dev/null @@ -1,13 +0,0 @@ -# alias FileHookCategory {#FileHookCategory} -`"effect chain"` | `"effect preset"` | `"instrument"` | `"modulation set"` | `"phrase"` | `"sample"` | `"song"` | `"theme"` -```lua -FileHookCategory: - | "song" - | "instrument" - | "effect chain" - | "effect preset" - | "modulation set" - | "phrase" - | "sample" - | "theme" -``` \ No newline at end of file diff --git a/docs/API/aliases/FilterTypes.md b/docs/API/aliases/FilterTypes.md deleted file mode 100644 index 9b9db32e..00000000 --- a/docs/API/aliases/FilterTypes.md +++ /dev/null @@ -1,73 +0,0 @@ -# alias FilterTypes {#FilterTypes} -[`FilterTypes1`](/API/aliases/FilterTypes1.md) | [`FilterTypes2`](/API/aliases/FilterTypes2.md) | [`FilterTypes3`](/API/aliases/FilterTypes3.md) -```lua --- Available filter types when filter_version = 3 --- Available filter types when filter_version = 3 --- Available filter types when filter_version = 2 --- Available filter types when filter_version = 1 -FilterTypes: - | "None" - | "LP Clean" - | "LP K35" - | "LP Moog" - | "LP Diode" - | "HP Clean" - | "HP K35" - | "HP Moog" - | "BP Clean" - | "BP K35" - | "BP Moog" - | "BandPass" - | "BandStop" - | "Vowel" - | "Comb" - | "Decimator" - | "Dist Shape" - | "Dist Fold" - | "AM Sine" - | "AM Triangle" - | "AM Saw" - | "AM Pulse" - | "None" - | "LP 2x2 Pole" - | "LP 2 Pole" - | "LP Biquad" - | "LP Moog" - | "LP Single" - | "HP 2x2 Pole" - | "HP 2 Pole" - | "HP Moog" - | "Band Reject" - | "Band Pass" - | "EQ -15 dB" - | "EQ -6 dB" - | "EQ +6 dB" - | "EQ +15 dB" - | "EQ Peaking" - | "Dist. Low" - | "Dist. Mid" - | "Dist. High" - | "Dist." - | "RingMod" - | "None" - | "LP -12 dB" - | "LP -24 dB" - | "LP -48 dB" - | "Moog LP" - | "Single Pole" - | "HP -12 dB" - | "HP -24 dB" - | "Moog HP" - | "Band Reject" - | "Band Pass" - | "EQ -15 dB" - | "EQ -6 dB" - | "EQ +6 dB" - | "EQ +15 dB" - | "Peaking EQ" - | "Dist. Low" - | "Dist. Mid" - | "Dist. High" - | "Dist." - | "AMod" -``` \ No newline at end of file diff --git a/docs/API/aliases/FilterTypes1.md b/docs/API/aliases/FilterTypes1.md deleted file mode 100644 index a9fb394b..00000000 --- a/docs/API/aliases/FilterTypes1.md +++ /dev/null @@ -1,27 +0,0 @@ -# alias FilterTypes1 {#FilterTypes1} -`"AMod"` | `"Band Pass"` | `"Band Reject"` | `"Dist. High"` | `"Dist. Low"` | `"Dist. Mid"` | `"Dist."` | `"EQ +15 dB"` | `"EQ +6 dB"` | `"EQ -15 dB"` | `"EQ -6 dB"` | `"HP -12 dB"` | `"HP -24 dB"` | `"LP -12 dB"` | `"LP -24 dB"` | `"LP -48 dB"` | `"Moog HP"` | `"Moog LP"` | `"None"` | `"Peaking EQ"` | `"Single Pole"` -```lua --- Available filter types when filter_version = 1 -FilterTypes1: - | "None" - | "LP -12 dB" - | "LP -24 dB" - | "LP -48 dB" - | "Moog LP" - | "Single Pole" - | "HP -12 dB" - | "HP -24 dB" - | "Moog HP" - | "Band Reject" - | "Band Pass" - | "EQ -15 dB" - | "EQ -6 dB" - | "EQ +6 dB" - | "EQ +15 dB" - | "Peaking EQ" - | "Dist. Low" - | "Dist. Mid" - | "Dist. High" - | "Dist." - | "AMod" -``` \ No newline at end of file diff --git a/docs/API/aliases/FilterTypes2.md b/docs/API/aliases/FilterTypes2.md deleted file mode 100644 index 788bad34..00000000 --- a/docs/API/aliases/FilterTypes2.md +++ /dev/null @@ -1,27 +0,0 @@ -# alias FilterTypes2 {#FilterTypes2} -`"Band Pass"` | `"Band Reject"` | `"Dist. High"` | `"Dist. Low"` | `"Dist. Mid"` | `"Dist."` | `"EQ +15 dB"` | `"EQ +6 dB"` | `"EQ -15 dB"` | `"EQ -6 dB"` | `"EQ Peaking"` | `"HP 2 Pole"` | `"HP 2x2 Pole"` | `"HP Moog"` | `"LP 2 Pole"` | `"LP 2x2 Pole"` | `"LP Biquad"` | `"LP Moog"` | `"LP Single"` | `"None"` | `"RingMod"` -```lua --- Available filter types when filter_version = 2 -FilterTypes2: - | "None" - | "LP 2x2 Pole" - | "LP 2 Pole" - | "LP Biquad" - | "LP Moog" - | "LP Single" - | "HP 2x2 Pole" - | "HP 2 Pole" - | "HP Moog" - | "Band Reject" - | "Band Pass" - | "EQ -15 dB" - | "EQ -6 dB" - | "EQ +6 dB" - | "EQ +15 dB" - | "EQ Peaking" - | "Dist. Low" - | "Dist. Mid" - | "Dist. High" - | "Dist." - | "RingMod" -``` \ No newline at end of file diff --git a/docs/API/aliases/FilterTypes3.md b/docs/API/aliases/FilterTypes3.md deleted file mode 100644 index 53f32081..00000000 --- a/docs/API/aliases/FilterTypes3.md +++ /dev/null @@ -1,28 +0,0 @@ -# alias FilterTypes3 {#FilterTypes3} -`"AM Pulse"` | `"AM Saw"` | `"AM Sine"` | `"AM Triangle"` | `"BP Clean"` | `"BP K35"` | `"BP Moog"` | `"BandPass"` | `"BandStop"` | `"Comb"` | `"Decimator"` | `"Dist Fold"` | `"Dist Shape"` | `"HP Clean"` | `"HP K35"` | `"HP Moog"` | `"LP Clean"` | `"LP Diode"` | `"LP K35"` | `"LP Moog"` | `"None"` | `"Vowel"` -```lua --- Available filter types when filter_version = 3 -FilterTypes3: - | "None" - | "LP Clean" - | "LP K35" - | "LP Moog" - | "LP Diode" - | "HP Clean" - | "HP K35" - | "HP Moog" - | "BP Clean" - | "BP K35" - | "BP Moog" - | "BandPass" - | "BandStop" - | "Vowel" - | "Comb" - | "Decimator" - | "Dist Shape" - | "Dist Fold" - | "AM Sine" - | "AM Triangle" - | "AM Saw" - | "AM Pulse" -``` \ No newline at end of file diff --git a/docs/API/aliases/IntegerNotifier.md b/docs/API/aliases/IntegerNotifier.md deleted file mode 100644 index 067113db..00000000 --- a/docs/API/aliases/IntegerNotifier.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias IntegerNotifier {#IntegerNotifier} -[`IntegerValueNotifierFunction`](/API/aliases/IntegerValueNotifierFunction.md) | [`IntegerValueNotifierMethod1`](/API/aliases/IntegerValueNotifierMethod1.md) | [`IntegerValueNotifierMethod2`](/API/aliases/IntegerValueNotifierMethod2.md) -Set up a notifier that will be called whenever a new item is picked \ No newline at end of file diff --git a/docs/API/aliases/IntegerValueNotifierFunction.md b/docs/API/aliases/IntegerValueNotifierFunction.md deleted file mode 100644 index 02ba53ed..00000000 --- a/docs/API/aliases/IntegerValueNotifierFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} -(value : [`integer`](/API/builtins/integer.md)) diff --git a/docs/API/aliases/IntegerValueNotifierMemberFunction.md b/docs/API/aliases/IntegerValueNotifierMemberFunction.md deleted file mode 100644 index 32b54b97..00000000 --- a/docs/API/aliases/IntegerValueNotifierMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias IntegerValueNotifierMemberFunction {#IntegerValueNotifierMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), value : [`integer`](/API/builtins/integer.md)) diff --git a/docs/API/aliases/IntegerValueNotifierMethod1.md b/docs/API/aliases/IntegerValueNotifierMethod1.md deleted file mode 100644 index 31008445..00000000 --- a/docs/API/aliases/IntegerValueNotifierMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias IntegerValueNotifierMethod1 {#IntegerValueNotifierMethod1} -{ 1 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), 2 : [`IntegerValueNotifierMemberFunction`](/API/aliases/IntegerValueNotifierMemberFunction.md) } diff --git a/docs/API/aliases/IntegerValueNotifierMethod2.md b/docs/API/aliases/IntegerValueNotifierMethod2.md deleted file mode 100644 index 6994ba80..00000000 --- a/docs/API/aliases/IntegerValueNotifierMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias IntegerValueNotifierMethod2 {#IntegerValueNotifierMethod2} -{ 1 : [`IntegerValueNotifierMemberFunction`](/API/aliases/IntegerValueNotifierMemberFunction.md), 2 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md) } diff --git a/docs/API/aliases/ItemLabels.md b/docs/API/aliases/ItemLabels.md deleted file mode 100644 index 7d1699e8..00000000 --- a/docs/API/aliases/ItemLabels.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias ItemLabels {#ItemLabels} -[`string`](/API/builtins/string.md)`[]` -A list of buttons labels to show in order. Must have more than one item. \ No newline at end of file diff --git a/docs/API/aliases/KeyHandler.md b/docs/API/aliases/KeyHandler.md deleted file mode 100644 index 144374e6..00000000 --- a/docs/API/aliases/KeyHandler.md +++ /dev/null @@ -1,9 +0,0 @@ -# alias KeyHandler {#KeyHandler} -(dialog : [`renoise.Dialog`](/API/renoise.Dialog.md), key_event : [`KeyEvent`](/API/structs/KeyEvent.md)) `->` [`KeyEvent`](/API/structs/KeyEvent.md)[`?`](/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. \ No newline at end of file diff --git a/docs/API/aliases/KeyHandlerMemberFunction.md b/docs/API/aliases/KeyHandlerMemberFunction.md deleted file mode 100644 index 4b6f2078..00000000 --- a/docs/API/aliases/KeyHandlerMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias KeyHandlerMemberFunction {#KeyHandlerMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), dialog : [`renoise.Dialog`](/API/renoise.Dialog.md), key : [`KeyEvent`](/API/structs/KeyEvent.md)) `->` [`KeyEvent`](/API/structs/KeyEvent.md)[`?`](/API/builtins/nil.md) diff --git a/docs/API/aliases/KeyHandlerMethod1.md b/docs/API/aliases/KeyHandlerMethod1.md deleted file mode 100644 index 0938a24d..00000000 --- a/docs/API/aliases/KeyHandlerMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias KeyHandlerMethod1 {#KeyHandlerMethod1} -{ 1 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), 2 : [`KeyHandlerMemberFunction`](/API/aliases/KeyHandlerMemberFunction.md) } diff --git a/docs/API/aliases/KeyHandlerMethod2.md b/docs/API/aliases/KeyHandlerMethod2.md deleted file mode 100644 index d813f0f4..00000000 --- a/docs/API/aliases/KeyHandlerMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias KeyHandlerMethod2 {#KeyHandlerMethod2} -{ 1 : [`KeyHandlerMemberFunction`](/API/aliases/KeyHandlerMemberFunction.md), 2 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md) } diff --git a/docs/API/aliases/ListElementAdded.md b/docs/API/aliases/ListElementAdded.md deleted file mode 100644 index 4b3fc166..00000000 --- a/docs/API/aliases/ListElementAdded.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListElementAdded {#ListElementAdded} -{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` } diff --git a/docs/API/aliases/ListElementChange.md b/docs/API/aliases/ListElementChange.md deleted file mode 100644 index 7df2b0b6..00000000 --- a/docs/API/aliases/ListElementChange.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListElementChange {#ListElementChange} -[`ListElementAdded`](/API/aliases/ListElementAdded.md) | [`ListElementRemoved`](/API/aliases/ListElementRemoved.md) | [`ListElementsSwapped`](/API/aliases/ListElementsSwapped.md) diff --git a/docs/API/aliases/ListElementRemoved.md b/docs/API/aliases/ListElementRemoved.md deleted file mode 100644 index 2d877277..00000000 --- a/docs/API/aliases/ListElementRemoved.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListElementRemoved {#ListElementRemoved} -{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` } diff --git a/docs/API/aliases/ListElementsSwapped.md b/docs/API/aliases/ListElementsSwapped.md deleted file mode 100644 index 066cdc65..00000000 --- a/docs/API/aliases/ListElementsSwapped.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListElementsSwapped {#ListElementsSwapped} -{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` } diff --git a/docs/API/aliases/ListNotifierFunction.md b/docs/API/aliases/ListNotifierFunction.md deleted file mode 100644 index 4d8621ab..00000000 --- a/docs/API/aliases/ListNotifierFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListNotifierFunction {#ListNotifierFunction} -(change : [`ListElementChange`](/API/aliases/ListElementChange.md)) diff --git a/docs/API/aliases/ListNotifierMemberContext.md b/docs/API/aliases/ListNotifierMemberContext.md deleted file mode 100644 index af4071ca..00000000 --- a/docs/API/aliases/ListNotifierMemberContext.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListNotifierMemberContext {#ListNotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) diff --git a/docs/API/aliases/ListNotifierMemberFunction.md b/docs/API/aliases/ListNotifierMemberFunction.md deleted file mode 100644 index 39616011..00000000 --- a/docs/API/aliases/ListNotifierMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListNotifierMemberFunction {#ListNotifierMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), change : [`ListElementChange`](/API/aliases/ListElementChange.md)) diff --git a/docs/API/aliases/ListNotifierMethod1.md b/docs/API/aliases/ListNotifierMethod1.md deleted file mode 100644 index b25a54e4..00000000 --- a/docs/API/aliases/ListNotifierMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListNotifierMethod1 {#ListNotifierMethod1} -{ 1 : [`ListNotifierMemberContext`](/API/aliases/ListNotifierMemberContext.md), 2 : [`ListNotifierMemberFunction`](/API/aliases/ListNotifierMemberFunction.md) } diff --git a/docs/API/aliases/ListNotifierMethod2.md b/docs/API/aliases/ListNotifierMethod2.md deleted file mode 100644 index 3c46acc5..00000000 --- a/docs/API/aliases/ListNotifierMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ListNotifierMethod2 {#ListNotifierMethod2} -{ 1 : [`ListNotifierMemberFunction`](/API/aliases/ListNotifierMemberFunction.md), 2 : [`ListNotifierMemberContext`](/API/aliases/ListNotifierMemberContext.md) } diff --git a/docs/API/aliases/MidiMessage.md b/docs/API/aliases/MidiMessage.md deleted file mode 100644 index c1ca38de..00000000 --- a/docs/API/aliases/MidiMessage.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias MidiMessage {#MidiMessage} -[`integer`](/API/builtins/integer.md)`[]` diff --git a/docs/API/aliases/MidiMessageFunction.md b/docs/API/aliases/MidiMessageFunction.md deleted file mode 100644 index d0eb9a35..00000000 --- a/docs/API/aliases/MidiMessageFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias MidiMessageFunction {#MidiMessageFunction} -(message : [`MidiMessage`](/API/aliases/MidiMessage.md)) diff --git a/docs/API/aliases/MidiMessageMemberContext.md b/docs/API/aliases/MidiMessageMemberContext.md deleted file mode 100644 index 6e88cafc..00000000 --- a/docs/API/aliases/MidiMessageMemberContext.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias MidiMessageMemberContext {#MidiMessageMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) diff --git a/docs/API/aliases/MidiMessageMemberFunction.md b/docs/API/aliases/MidiMessageMemberFunction.md deleted file mode 100644 index 7b33d265..00000000 --- a/docs/API/aliases/MidiMessageMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias MidiMessageMemberFunction {#MidiMessageMemberFunction} -(self : [`MidiMessageMemberContext`](/API/aliases/MidiMessageMemberContext.md), message : [`MidiMessage`](/API/aliases/MidiMessage.md)) diff --git a/docs/API/aliases/MidiMessageMethod1.md b/docs/API/aliases/MidiMessageMethod1.md deleted file mode 100644 index 098f3568..00000000 --- a/docs/API/aliases/MidiMessageMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias MidiMessageMethod1 {#MidiMessageMethod1} -{ 1 : [`MidiMessageMemberContext`](/API/aliases/MidiMessageMemberContext.md), 2 : [`MidiMessageMemberFunction`](/API/aliases/MidiMessageMemberFunction.md) } diff --git a/docs/API/aliases/MidiMessageMethod2.md b/docs/API/aliases/MidiMessageMethod2.md deleted file mode 100644 index e2a9c1c8..00000000 --- a/docs/API/aliases/MidiMessageMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias MidiMessageMethod2 {#MidiMessageMethod2} -{ 1 : [`MidiMessageMemberFunction`](/API/aliases/MidiMessageMemberFunction.md), 2 : [`MidiMessageMemberContext`](/API/aliases/MidiMessageMemberContext.md) } diff --git a/docs/API/aliases/ModifierStates.md b/docs/API/aliases/ModifierStates.md deleted file mode 100644 index d9c226ef..00000000 --- a/docs/API/aliases/ModifierStates.md +++ /dev/null @@ -1,12 +0,0 @@ -# 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 -" + " -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 \ No newline at end of file diff --git a/docs/API/aliases/NotifierFunction.md b/docs/API/aliases/NotifierFunction.md deleted file mode 100644 index dab63d34..00000000 --- a/docs/API/aliases/NotifierFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NotifierFunction {#NotifierFunction} -fun() diff --git a/docs/API/aliases/NotifierMemberContext.md b/docs/API/aliases/NotifierMemberContext.md deleted file mode 100644 index 8a2ac738..00000000 --- a/docs/API/aliases/NotifierMemberContext.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NotifierMemberContext {#NotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) diff --git a/docs/API/aliases/NotifierMemberFunction.md b/docs/API/aliases/NotifierMemberFunction.md deleted file mode 100644 index 4b8dc0f4..00000000 --- a/docs/API/aliases/NotifierMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NotifierMemberFunction {#NotifierMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md)) diff --git a/docs/API/aliases/NotifierMethod1.md b/docs/API/aliases/NotifierMethod1.md deleted file mode 100644 index d8022989..00000000 --- a/docs/API/aliases/NotifierMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NotifierMethod1 {#NotifierMethod1} -{ 1 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), 2 : [`NotifierMemberFunction`](/API/aliases/NotifierMemberFunction.md) } diff --git a/docs/API/aliases/NotifierMethod2.md b/docs/API/aliases/NotifierMethod2.md deleted file mode 100644 index b57bb117..00000000 --- a/docs/API/aliases/NotifierMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NotifierMethod2 {#NotifierMethod2} -{ 1 : [`NotifierMemberFunction`](/API/aliases/NotifierMemberFunction.md), 2 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md) } diff --git a/docs/API/aliases/NumberValueNotifier.md b/docs/API/aliases/NumberValueNotifier.md deleted file mode 100644 index 729d84d8..00000000 --- a/docs/API/aliases/NumberValueNotifier.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias NumberValueNotifier {#NumberValueNotifier} -[`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md) | [`NumberValueNotifierMethod1`](/API/aliases/NumberValueNotifierMethod1.md) | [`NumberValueNotifierMethod2`](/API/aliases/NumberValueNotifierMethod2.md) -Set up a value notifier that will be called whenever the value changes \ No newline at end of file diff --git a/docs/API/aliases/NumberValueNotifierFunction.md b/docs/API/aliases/NumberValueNotifierFunction.md deleted file mode 100644 index 4cc10f53..00000000 --- a/docs/API/aliases/NumberValueNotifierFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) diff --git a/docs/API/aliases/NumberValueNotifierMemberFunction.md b/docs/API/aliases/NumberValueNotifierMemberFunction.md deleted file mode 100644 index f97b33f1..00000000 --- a/docs/API/aliases/NumberValueNotifierMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NumberValueNotifierMemberFunction {#NumberValueNotifierMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), value : [`number`](/API/builtins/number.md)) diff --git a/docs/API/aliases/NumberValueNotifierMethod1.md b/docs/API/aliases/NumberValueNotifierMethod1.md deleted file mode 100644 index 9b81871c..00000000 --- a/docs/API/aliases/NumberValueNotifierMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NumberValueNotifierMethod1 {#NumberValueNotifierMethod1} -{ 1 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), 2 : [`NumberValueNotifierMemberFunction`](/API/aliases/NumberValueNotifierMemberFunction.md) } diff --git a/docs/API/aliases/NumberValueNotifierMethod2.md b/docs/API/aliases/NumberValueNotifierMethod2.md deleted file mode 100644 index 9343d5f7..00000000 --- a/docs/API/aliases/NumberValueNotifierMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias NumberValueNotifierMethod2 {#NumberValueNotifierMethod2} -{ 1 : [`NumberValueNotifierMemberFunction`](/API/aliases/NumberValueNotifierMemberFunction.md), 2 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md) } diff --git a/docs/API/aliases/ObservableProperties.md b/docs/API/aliases/ObservableProperties.md deleted file mode 100644 index b38bdc62..00000000 --- a/docs/API/aliases/ObservableProperties.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ObservableProperties {#ObservableProperties} -table<[`string`](/API/builtins/string.md), [`ObservableTypes`](/API/aliases/ObservableTypes.md) | [`renoise.Document.DocumentList`](/API/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md)> diff --git a/docs/API/aliases/ObservableTypes.md b/docs/API/aliases/ObservableTypes.md deleted file mode 100644 index 44ad3fb4..00000000 --- a/docs/API/aliases/ObservableTypes.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias ObservableTypes {#ObservableTypes} -[`boolean`](/API/builtins/boolean.md) | [`string`](/API/builtins/string.md) | [`number`](/API/builtins/number.md) | [`boolean`](/API/builtins/boolean.md)`[]` | [`number`](/API/builtins/number.md)`[]` | [`string`](/API/builtins/string.md)`[]` diff --git a/docs/API/aliases/OscTag.md b/docs/API/aliases/OscTag.md deleted file mode 100644 index 106baa3e..00000000 --- a/docs/API/aliases/OscTag.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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. -``` \ No newline at end of file diff --git a/docs/API/aliases/PairedParseStringAsNumber.md b/docs/API/aliases/PairedParseStringAsNumber.md deleted file mode 100644 index 32b3df16..00000000 --- a/docs/API/aliases/PairedParseStringAsNumber.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias PairedParseStringAsNumber {#PairedParseStringAsNumber} -(value : [`string`](/API/builtins/string.md)) `->` [`number`](/API/builtins/number.md)[`?`](/API/builtins/nil.md) -Make sure to also set `tostring` if you set this. \ No newline at end of file diff --git a/docs/API/aliases/PairedShowNumberAsString.md b/docs/API/aliases/PairedShowNumberAsString.md deleted file mode 100644 index 3f84c211..00000000 --- a/docs/API/aliases/PairedShowNumberAsString.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias PairedShowNumberAsString {#PairedShowNumberAsString} -[`ShowNumberAsString`](/API/aliases/ShowNumberAsString.md) -Make sure to also set `tonumber` if you set this. \ No newline at end of file diff --git a/docs/API/aliases/ParseStringAsNumber.md b/docs/API/aliases/ParseStringAsNumber.md deleted file mode 100644 index 5a544de0..00000000 --- a/docs/API/aliases/ParseStringAsNumber.md +++ /dev/null @@ -1,6 +0,0 @@ -# alias ParseStringAsNumber {#ParseStringAsNumber} -(value : [`string`](/API/builtins/string.md)) `->` [`number`](/API/builtins/number.md)[`?`](/API/builtins/nil.md) -Set a custom function to parse a number value from a user-provided string. -When returning nil, no conversion will be done and the value will not change. -Note: When the callback fails with an error, it will be disabled to avoid -a flood of error messages. \ No newline at end of file diff --git a/docs/API/aliases/PatternLineChangeCallback.md b/docs/API/aliases/PatternLineChangeCallback.md deleted file mode 100644 index 3ca9fa6f..00000000 --- a/docs/API/aliases/PatternLineChangeCallback.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias PatternLineChangeCallback {#PatternLineChangeCallback} -(pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md)) diff --git a/docs/API/aliases/PatternLineChangeCallbackWithContext.md b/docs/API/aliases/PatternLineChangeCallbackWithContext.md deleted file mode 100644 index 79a260da..00000000 --- a/docs/API/aliases/PatternLineChangeCallbackWithContext.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias PatternLineChangeCallbackWithContext {#PatternLineChangeCallbackWithContext} -(obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md)) diff --git a/docs/API/aliases/PhraseLineChangeCallback.md b/docs/API/aliases/PhraseLineChangeCallback.md deleted file mode 100644 index 5b3e757c..00000000 --- a/docs/API/aliases/PhraseLineChangeCallback.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias PhraseLineChangeCallback {#PhraseLineChangeCallback} -(pos : [`PhraseLinePosition`](/API/structs/PhraseLinePosition.md)) diff --git a/docs/API/aliases/PhraseLineChangeCallbackWithContext.md b/docs/API/aliases/PhraseLineChangeCallbackWithContext.md deleted file mode 100644 index d3d19008..00000000 --- a/docs/API/aliases/PhraseLineChangeCallbackWithContext.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias PhraseLineChangeCallbackWithContext {#PhraseLineChangeCallbackWithContext} -(obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md), pos : [`PhraseLinePosition`](/API/structs/PhraseLinePosition.md)) diff --git a/docs/API/aliases/PopupItemLabels.md b/docs/API/aliases/PopupItemLabels.md deleted file mode 100644 index 5212ab19..00000000 --- a/docs/API/aliases/PopupItemLabels.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias PopupItemLabels {#PopupItemLabels} -[`string`](/API/builtins/string.md)`[]` -A list of buttons labels to show in order -The list can be empty, then "None" is displayed and the value won't change. \ No newline at end of file diff --git a/docs/API/aliases/RGBColor.md b/docs/API/aliases/RGBColor.md deleted file mode 100644 index 04174258..00000000 --- a/docs/API/aliases/RGBColor.md +++ /dev/null @@ -1,6 +0,0 @@ -# alias RGBColor {#RGBColor} -{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } -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 \ No newline at end of file diff --git a/docs/API/aliases/RackConstructor.md b/docs/API/aliases/RackConstructor.md deleted file mode 100644 index ff3741d5..00000000 --- a/docs/API/aliases/RackConstructor.md +++ /dev/null @@ -1,17 +0,0 @@ -# alias RackConstructor {#RackConstructor} -(self : [`ViewBuilderInstance`](/API/structs/ViewBuilderInstance.md), properties : [`RackViewProperties`](/API/structs/RackViewProperties.md)[`?`](/API/builtins/nil.md)) `->` [`renoise.Views.Rack`](/API/renoise.Views.Rack.md) -You can add nested child views when constructing a column or row -by including them in the constructor table in the views property. - -### example: -```lua -vb:column { - margin = 1, - vb:text { - text = "Text1" - }, - vb:text { - text = "Text2" - } -} -``` \ No newline at end of file diff --git a/docs/API/aliases/RackMargin.md b/docs/API/aliases/RackMargin.md deleted file mode 100644 index b485c1e8..00000000 --- a/docs/API/aliases/RackMargin.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias RackMargin {#RackMargin} -[`integer`](/API/builtins/integer.md) -Set the "borders" of a rack (left, right, top and bottom inclusively) -* Default: 0 (no borders) \ No newline at end of file diff --git a/docs/API/aliases/RackSpacing.md b/docs/API/aliases/RackSpacing.md deleted file mode 100644 index 291d761f..00000000 --- a/docs/API/aliases/RackSpacing.md +++ /dev/null @@ -1,5 +0,0 @@ -# alias RackSpacing {#RackSpacing} -[`integer`](/API/builtins/integer.md) -Set the amount stacked child views are separated by (horizontally in -rows, vertically in columns). -* Default: 0 (no spacing) \ No newline at end of file diff --git a/docs/API/aliases/RackUniformity.md b/docs/API/aliases/RackUniformity.md deleted file mode 100644 index 55bc1cea..00000000 --- a/docs/API/aliases/RackUniformity.md +++ /dev/null @@ -1,8 +0,0 @@ -# alias RackUniformity {#RackUniformity} -[`boolean`](/API/builtins/boolean.md) -When set to true, all child views in the rack are automatically resized to -the max size of all child views (width in ViewBuilder.column, height in -ViewBuilder.row). This can be useful to automatically align all sub -columns/panels to the same size. Resizing is done automatically, as soon -as a child view size changes or new children are added. -* Default: false \ No newline at end of file diff --git a/docs/API/aliases/SampleBuffer.ExportType.md b/docs/API/aliases/SampleBuffer.ExportType.md deleted file mode 100644 index 64992834..00000000 --- a/docs/API/aliases/SampleBuffer.ExportType.md +++ /dev/null @@ -1,7 +0,0 @@ -# alias SampleBuffer.ExportType {#SampleBuffer.ExportType} -`"flac"` | `"wav"` -```lua -SampleBuffer.ExportType: - | "wav" - | "flac" -``` \ No newline at end of file diff --git a/docs/API/aliases/SelectedItem.md b/docs/API/aliases/SelectedItem.md deleted file mode 100644 index 995164e2..00000000 --- a/docs/API/aliases/SelectedItem.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias SelectedItem {#SelectedItem} -[`integer`](/API/builtins/integer.md) -The currently selected item's index \ No newline at end of file diff --git a/docs/API/aliases/ShowNumberAsString.md b/docs/API/aliases/ShowNumberAsString.md deleted file mode 100644 index 322a7fdb..00000000 --- a/docs/API/aliases/ShowNumberAsString.md +++ /dev/null @@ -1,8 +0,0 @@ -# alias ShowNumberAsString {#ShowNumberAsString} -(value : [`number`](/API/builtins/number.md)) `->` [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) -Set a custom rule on how a number value should be displayed. -Useful for showing units like decibel or note values etc. -If none are set, a default string/number conversion is done, which -simply shows the number with 3 digits after the decimal point. -Note: When the callback fails with an error, it will be disabled to avoid -a flood of error messages. \ No newline at end of file diff --git a/docs/API/aliases/SliderDefaultValue.md b/docs/API/aliases/SliderDefaultValue.md deleted file mode 100644 index e2529b43..00000000 --- a/docs/API/aliases/SliderDefaultValue.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias SliderDefaultValue {#SliderDefaultValue} -[`number`](/API/builtins/number.md) -The default value that will be re-applied on double-click \ No newline at end of file diff --git a/docs/API/aliases/SliderMaxValue.md b/docs/API/aliases/SliderMaxValue.md deleted file mode 100644 index e1ea3964..00000000 --- a/docs/API/aliases/SliderMaxValue.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias SliderMaxValue {#SliderMaxValue} -[`number`](/API/builtins/number.md) -The maximum value that can be set using the view -* Default: 1.0 \ No newline at end of file diff --git a/docs/API/aliases/SliderMinValue.md b/docs/API/aliases/SliderMinValue.md deleted file mode 100644 index f307b9da..00000000 --- a/docs/API/aliases/SliderMinValue.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias SliderMinValue {#SliderMinValue} -[`number`](/API/builtins/number.md) -The minimum value that can be set using the view -* Default: 0 \ No newline at end of file diff --git a/docs/API/aliases/SliderNumberValue.md b/docs/API/aliases/SliderNumberValue.md deleted file mode 100644 index d9299fb0..00000000 --- a/docs/API/aliases/SliderNumberValue.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias SliderNumberValue {#SliderNumberValue} -[`number`](/API/builtins/number.md) -The current value of the view \ No newline at end of file diff --git a/docs/API/aliases/SliderStepAmounts.md b/docs/API/aliases/SliderStepAmounts.md deleted file mode 100644 index cb1d52e1..00000000 --- a/docs/API/aliases/SliderStepAmounts.md +++ /dev/null @@ -1,6 +0,0 @@ -# alias SliderStepAmounts {#SliderStepAmounts} -{ 1 : [`number`](/API/builtins/number.md), 2 : [`number`](/API/builtins/number.md) } -A table containing two numbers representing the step amounts for incrementing -and decrementing by clicking the <> buttons. -The first value is the small step (applied on left clicks) -second value is the big step (applied on right clicks) \ No newline at end of file diff --git a/docs/API/aliases/SocketReceiveMode.md b/docs/API/aliases/SocketReceiveMode.md deleted file mode 100644 index 09616f31..00000000 --- a/docs/API/aliases/SocketReceiveMode.md +++ /dev/null @@ -1,7 +0,0 @@ -# alias SocketReceiveMode {#SocketReceiveMode} -[`integer`](/API/builtins/integer.md) | `"*all"` | `"*line"` -```lua -SocketReceiveMode: - | "*line" - | "*all" -``` \ No newline at end of file diff --git a/docs/API/aliases/SpaceConstructor.md b/docs/API/aliases/SpaceConstructor.md deleted file mode 100644 index 688757b8..00000000 --- a/docs/API/aliases/SpaceConstructor.md +++ /dev/null @@ -1,19 +0,0 @@ -# alias SpaceConstructor {#SpaceConstructor} -(self : [`ViewBuilderInstance`](/API/structs/ViewBuilderInstance.md), properties : [`ViewProperties`](/API/structs/ViewProperties.md)[`?`](/API/builtins/nil.md)) `->` [`renoise.Views.View`](/API/renoise.Views.View.md) -You can create an empty space in layouts with a space. - -### example: -```lua ---Empty space in layouts -vb:row { - vb:button { - text = "Some Button" - }, - vb:space { -- extra spacing between buttons - width = 8 - }, - vb:button { - text = "Another Button" - }, -} -``` \ No newline at end of file diff --git a/docs/API/aliases/StringChangeNotifier.md b/docs/API/aliases/StringChangeNotifier.md deleted file mode 100644 index ba8bf732..00000000 --- a/docs/API/aliases/StringChangeNotifier.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias StringChangeNotifier {#StringChangeNotifier} -[`StringValueNotifierFunction`](/API/aliases/StringValueNotifierFunction.md) | [`StringValueNotifierMethod1`](/API/aliases/StringValueNotifierMethod1.md) | [`StringValueNotifierMethod2`](/API/aliases/StringValueNotifierMethod2.md) -Set up a notifier for text changes \ No newline at end of file diff --git a/docs/API/aliases/StringValueNotifierFunction.md b/docs/API/aliases/StringValueNotifierFunction.md deleted file mode 100644 index 11d5e060..00000000 --- a/docs/API/aliases/StringValueNotifierFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias StringValueNotifierFunction {#StringValueNotifierFunction} -(value : [`string`](/API/builtins/string.md)) diff --git a/docs/API/aliases/StringValueNotifierMemberFunction.md b/docs/API/aliases/StringValueNotifierMemberFunction.md deleted file mode 100644 index b18a5eff..00000000 --- a/docs/API/aliases/StringValueNotifierMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias StringValueNotifierMemberFunction {#StringValueNotifierMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), value : [`string`](/API/builtins/string.md)) diff --git a/docs/API/aliases/StringValueNotifierMethod1.md b/docs/API/aliases/StringValueNotifierMethod1.md deleted file mode 100644 index 89c4f2c7..00000000 --- a/docs/API/aliases/StringValueNotifierMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias StringValueNotifierMethod1 {#StringValueNotifierMethod1} -{ 1 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), 2 : [`StringValueNotifierMemberFunction`](/API/aliases/StringValueNotifierMemberFunction.md) } diff --git a/docs/API/aliases/StringValueNotifierMethod2.md b/docs/API/aliases/StringValueNotifierMethod2.md deleted file mode 100644 index 1dcda24e..00000000 --- a/docs/API/aliases/StringValueNotifierMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias StringValueNotifierMethod2 {#StringValueNotifierMethod2} -{ 1 : [`StringValueNotifierMemberFunction`](/API/aliases/StringValueNotifierMemberFunction.md), 2 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md) } diff --git a/docs/API/aliases/TextActive.md b/docs/API/aliases/TextActive.md deleted file mode 100644 index b020063e..00000000 --- a/docs/API/aliases/TextActive.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias TextActive {#TextActive} -[`boolean`](/API/builtins/boolean.md) -When false, text is displayed but can not be entered/modified by the user. -* Default: true \ No newline at end of file diff --git a/docs/API/aliases/TextAlignment.md b/docs/API/aliases/TextAlignment.md deleted file mode 100644 index a074c98d..00000000 --- a/docs/API/aliases/TextAlignment.md +++ /dev/null @@ -1,10 +0,0 @@ -# alias TextAlignment {#TextAlignment} -`"center"` | `"left"` | `"right"` -```lua --- Setup the text's alignment. Applies only when the view's size is larger than --- the needed size to draw the text -TextAlignment: - | "left" -- (Default) - | "right" -- aligned to the right - | "center" -- center text -``` \ No newline at end of file diff --git a/docs/API/aliases/TextBackgroundStyle.md b/docs/API/aliases/TextBackgroundStyle.md deleted file mode 100644 index f8ddfa4d..00000000 --- a/docs/API/aliases/TextBackgroundStyle.md +++ /dev/null @@ -1,9 +0,0 @@ -# alias TextBackgroundStyle {#TextBackgroundStyle} -`"body"` | `"border"` | `"strong"` -```lua --- Setup the text view's background: -TextBackgroundStyle: - | "body" -- simple text color with no background - | "strong" -- stronger text color with no background - | "border" -- text on a bordered background -``` \ No newline at end of file diff --git a/docs/API/aliases/TextEditMode.md b/docs/API/aliases/TextEditMode.md deleted file mode 100644 index b546a27f..00000000 --- a/docs/API/aliases/TextEditMode.md +++ /dev/null @@ -1,5 +0,0 @@ -# alias TextEditMode {#TextEditMode} -[`boolean`](/API/builtins/boolean.md) -True when the text field is focused. setting it at run-time programmatically -will focus the text field or remove the focus (focus the dialog) accordingly. -* Default: false \ No newline at end of file diff --git a/docs/API/aliases/TextFontStyle.md b/docs/API/aliases/TextFontStyle.md deleted file mode 100644 index c9213bc3..00000000 --- a/docs/API/aliases/TextFontStyle.md +++ /dev/null @@ -1,11 +0,0 @@ -# alias TextFontStyle {#TextFontStyle} -`"big"` | `"bold"` | `"italic"` | `"mono"` | `"normal"` -```lua --- The style that the text should be displayed with. -TextFontStyle: - | "normal" -- (Default) - | "big" -- big text - | "bold" -- bold font - | "italic" -- italic font - | "mono" -- monospace font -``` \ No newline at end of file diff --git a/docs/API/aliases/TextMultilineString.md b/docs/API/aliases/TextMultilineString.md deleted file mode 100644 index 9f3c3a2f..00000000 --- a/docs/API/aliases/TextMultilineString.md +++ /dev/null @@ -1,5 +0,0 @@ -# alias TextMultilineString {#TextMultilineString} -[`string`](/API/builtins/string.md) -The text that should be displayed. -Newlines (Windows, Mac or Unix styled) in the text can be used to create -paragraphs. \ No newline at end of file diff --git a/docs/API/aliases/TextParagraphs.md b/docs/API/aliases/TextParagraphs.md deleted file mode 100644 index bae15f0b..00000000 --- a/docs/API/aliases/TextParagraphs.md +++ /dev/null @@ -1,5 +0,0 @@ -# alias TextParagraphs {#TextParagraphs} -[`string`](/API/builtins/string.md)`[]` -A table of text lines to be used instead of specifying a single text -line with newline characters like "text" -* Default: [] \ No newline at end of file diff --git a/docs/API/aliases/TextSingleLineString.md b/docs/API/aliases/TextSingleLineString.md deleted file mode 100644 index 8a40ffd5..00000000 --- a/docs/API/aliases/TextSingleLineString.md +++ /dev/null @@ -1,5 +0,0 @@ -# alias TextSingleLineString {#TextSingleLineString} -[`string`](/API/builtins/string.md) -The text that should be displayed. Setting a new text will resize -the view in order to make the text fully visible (expanding only). -* Default: "" \ No newline at end of file diff --git a/docs/API/aliases/TextStyle.md b/docs/API/aliases/TextStyle.md deleted file mode 100644 index 9db8db8a..00000000 --- a/docs/API/aliases/TextStyle.md +++ /dev/null @@ -1,9 +0,0 @@ -# alias TextStyle {#TextStyle} -`"disabled"` | `"normal"` | `"strong"` -```lua --- Get/set the color style the text should be displayed with. -TextStyle: - | "normal" -- (Default) - | "strong" -- highlighted color - | "disabled" -- greyed out color -``` \ No newline at end of file diff --git a/docs/API/aliases/TextValue.md b/docs/API/aliases/TextValue.md deleted file mode 100644 index 5716af68..00000000 --- a/docs/API/aliases/TextValue.md +++ /dev/null @@ -1,5 +0,0 @@ -# alias TextValue {#TextValue} -[`string`](/API/builtins/string.md) -The currently shown text. The text will not be updated when editing, -rather only after editing is complete (return is pressed, or focus is lost). -* Default: "" \ No newline at end of file diff --git a/docs/API/aliases/TextValueAlias.md b/docs/API/aliases/TextValueAlias.md deleted file mode 100644 index 1d45c045..00000000 --- a/docs/API/aliases/TextValueAlias.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias TextValueAlias {#TextValueAlias} -[`string`](/API/builtins/string.md) -Exactly the same as "value"; provided for consistency. -* Default: "" \ No newline at end of file diff --git a/docs/API/aliases/TimerFunction.md b/docs/API/aliases/TimerFunction.md deleted file mode 100644 index 3922db21..00000000 --- a/docs/API/aliases/TimerFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias TimerFunction {#TimerFunction} -fun() diff --git a/docs/API/aliases/TimerMemberContext.md b/docs/API/aliases/TimerMemberContext.md deleted file mode 100644 index 180f771c..00000000 --- a/docs/API/aliases/TimerMemberContext.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias TimerMemberContext {#TimerMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) diff --git a/docs/API/aliases/TimerMemberFunction.md b/docs/API/aliases/TimerMemberFunction.md deleted file mode 100644 index b0064b92..00000000 --- a/docs/API/aliases/TimerMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias TimerMemberFunction {#TimerMemberFunction} -(self : [`TimerMemberContext`](/API/aliases/TimerMemberContext.md)) diff --git a/docs/API/aliases/TimerMethod1.md b/docs/API/aliases/TimerMethod1.md deleted file mode 100644 index e8b32db6..00000000 --- a/docs/API/aliases/TimerMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias TimerMethod1 {#TimerMethod1} -{ 1 : [`TimerMemberContext`](/API/aliases/TimerMemberContext.md), 2 : [`TimerMemberFunction`](/API/aliases/TimerMemberFunction.md) } diff --git a/docs/API/aliases/TimerMethod2.md b/docs/API/aliases/TimerMethod2.md deleted file mode 100644 index 9fc05063..00000000 --- a/docs/API/aliases/TimerMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias TimerMethod2 {#TimerMethod2} -{ 1 : [`TimerMemberFunction`](/API/aliases/TimerMemberFunction.md), 2 : [`TimerMemberContext`](/API/aliases/TimerMemberContext.md) } diff --git a/docs/API/aliases/ValueBoxMaxValue.md b/docs/API/aliases/ValueBoxMaxValue.md deleted file mode 100644 index 866346ab..00000000 --- a/docs/API/aliases/ValueBoxMaxValue.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias ValueBoxMaxValue {#ValueBoxMaxValue} -[`number`](/API/builtins/number.md) -The maximum value that can be set using the view -* Default: 100 \ No newline at end of file diff --git a/docs/API/aliases/ValueBoxMinValue.md b/docs/API/aliases/ValueBoxMinValue.md deleted file mode 100644 index cf2e3f05..00000000 --- a/docs/API/aliases/ValueBoxMinValue.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias ValueBoxMinValue {#ValueBoxMinValue} -[`number`](/API/builtins/number.md) -The minimum value that can be set using the view -* Default: 0 \ No newline at end of file diff --git a/docs/API/aliases/ViewBackgroundStyle.md b/docs/API/aliases/ViewBackgroundStyle.md deleted file mode 100644 index 8e1136c1..00000000 --- a/docs/API/aliases/ViewBackgroundStyle.md +++ /dev/null @@ -1,12 +0,0 @@ -# alias ViewBackgroundStyle {#ViewBackgroundStyle} -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -```lua --- Setup a background style for the view. -ViewBackgroundStyle: - | "invisible" -- no background (Default) - | "plain" -- undecorated, single coloured background - | "border" -- same as plain, but with a bold nested border - | "body" -- main "background" style, as used in dialog backgrounds - | "panel" -- alternative "background" style, beveled - | "group" -- background for "nested" groups within body -``` \ No newline at end of file diff --git a/docs/API/aliases/ViewBooleanObservable.md b/docs/API/aliases/ViewBooleanObservable.md deleted file mode 100644 index 3b820634..00000000 --- a/docs/API/aliases/ViewBooleanObservable.md +++ /dev/null @@ -1,7 +0,0 @@ -# alias ViewBooleanObservable {#ViewBooleanObservable} -[`renoise.Document.ObservableBoolean`](/API/renoise.Document.ObservableBoolean.md) -Bind the view's value to a renoise.Document.ObservableBoolean object. -Automatically keep them in sync. -The view will change the Observable value as soon as its value changes -and change the view's value as soon as the Observable's value changes. -Notifiers can be added to either the view or the Observable object. \ No newline at end of file diff --git a/docs/API/aliases/ViewDimension.md b/docs/API/aliases/ViewDimension.md deleted file mode 100644 index 303e80de..00000000 --- a/docs/API/aliases/ViewDimension.md +++ /dev/null @@ -1,6 +0,0 @@ -# alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) -The dimensions of a view has to be larger than 0. -For nested views you can also specify relative size -for example `vb:text { width = "80%"}`. The percentage values are -relative to the view's parent size and will automatically update on size changes. \ No newline at end of file diff --git a/docs/API/aliases/ViewId.md b/docs/API/aliases/ViewId.md deleted file mode 100644 index 976ba8a7..00000000 --- a/docs/API/aliases/ViewId.md +++ /dev/null @@ -1,5 +0,0 @@ -# alias ViewId {#ViewId} -[`string`](/API/builtins/string.md) -Unique identifier to resolve the view later on in the viewbuilder, -e.g. `vb.views.SomeString` or `vb.views["Some String"]` -View ids must be unique within a single view builder instance. \ No newline at end of file diff --git a/docs/API/aliases/ViewNumberObservable.md b/docs/API/aliases/ViewNumberObservable.md deleted file mode 100644 index 4d4f6430..00000000 --- a/docs/API/aliases/ViewNumberObservable.md +++ /dev/null @@ -1,7 +0,0 @@ -# alias ViewNumberObservable {#ViewNumberObservable} -[`renoise.Document.ObservableNumber`](/API/renoise.Document.ObservableNumber.md) -Bind the view's value to a renoise.Document.ObservableNumber object. -Automatically keep them in sync. -The view will change the Observable value as soon as its value changes -and change the view's value as soon as the Observable's value changes. -Notifiers can be added to either the view or the Observable object. \ No newline at end of file diff --git a/docs/API/aliases/ViewStringListObservable.md b/docs/API/aliases/ViewStringListObservable.md deleted file mode 100644 index d284a856..00000000 --- a/docs/API/aliases/ViewStringListObservable.md +++ /dev/null @@ -1,7 +0,0 @@ -# alias ViewStringListObservable {#ViewStringListObservable} -[`renoise.Document.ObservableStringList`](/API/renoise.Document.ObservableStringList.md) -Bind the view's value to a renoise.Document.ObservableStringList object. -Automatically keep them in sync. -The view will change the Observable value as soon as its value changes -and change the view's value as soon as the Observable's value changes. -Notifiers can be added to either the view or the Observable object. \ No newline at end of file diff --git a/docs/API/aliases/ViewStringObservable.md b/docs/API/aliases/ViewStringObservable.md deleted file mode 100644 index cdb96d34..00000000 --- a/docs/API/aliases/ViewStringObservable.md +++ /dev/null @@ -1,7 +0,0 @@ -# alias ViewStringObservable {#ViewStringObservable} -[`renoise.Document.ObservableString`](/API/renoise.Document.ObservableString.md) -Bind the view's value to a renoise.Document.ObservableString object. -Automatically keep them in sync. -The view will change the Observable value as soon as its value changes -and change the view's value as soon as the Observable's value changes. -Notifiers can be added to either the view or the Observable object. \ No newline at end of file diff --git a/docs/API/aliases/ViewTooltip.md b/docs/API/aliases/ViewTooltip.md deleted file mode 100644 index a6139496..00000000 --- a/docs/API/aliases/ViewTooltip.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias ViewTooltip {#ViewTooltip} -[`string`](/API/builtins/string.md) -A tooltip text that should be shown for this view on mouse hover. -* Default: "" (no tip will be shown) \ No newline at end of file diff --git a/docs/API/aliases/ViewVisibility.md b/docs/API/aliases/ViewVisibility.md deleted file mode 100644 index 97501b1c..00000000 --- a/docs/API/aliases/ViewVisibility.md +++ /dev/null @@ -1,6 +0,0 @@ -# alias ViewVisibility {#ViewVisibility} -[`boolean`](/API/builtins/boolean.md) -Set visible to false to hide a view (make it invisible without removing -it). Please note that view.visible will also return false when any of its -parents are invisible (when its implicitly invisible). -* Default: true \ No newline at end of file diff --git a/docs/API/aliases/XYPadMaxValues.md b/docs/API/aliases/XYPadMaxValues.md deleted file mode 100644 index 847ef9e1..00000000 --- a/docs/API/aliases/XYPadMaxValues.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias XYPadMaxValues {#XYPadMaxValues} -{ x : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md), y : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md) } -A table of allowed maximum values for each axis -* Default: {x: 1.0, y: 1.0} \ No newline at end of file diff --git a/docs/API/aliases/XYPadMinValues.md b/docs/API/aliases/XYPadMinValues.md deleted file mode 100644 index 1b0e8dac..00000000 --- a/docs/API/aliases/XYPadMinValues.md +++ /dev/null @@ -1,4 +0,0 @@ -# alias XYPadMinValues {#XYPadMinValues} -{ x : [`SliderMinValue`](/API/aliases/SliderMinValue.md), y : [`SliderMinValue`](/API/aliases/SliderMinValue.md) } -A table of allowed minimum values for each axis -* Default: {x: 0.0, y: 0.0} \ No newline at end of file diff --git a/docs/API/aliases/XYPadObservables.md b/docs/API/aliases/XYPadObservables.md deleted file mode 100644 index a049e11c..00000000 --- a/docs/API/aliases/XYPadObservables.md +++ /dev/null @@ -1,11 +0,0 @@ -# alias XYPadObservables {#XYPadObservables} -{ x : [`renoise.Document.ObservableNumber`](/API/renoise.Document.ObservableNumber.md), y : [`renoise.Document.ObservableNumber`](/API/renoise.Document.ObservableNumber.md) } - -Bind the view's value to a pair of renoise.Document.ObservableNumber objects. -Automatically keep both values in sync. -Will change the Observables' values as soon as the view's value changes, -and change the view's values as soon as the Observable's value changes. -Notifiers can be added to either the view or the Observable object. -Just like in the other XYPad properties, a table with the fields X and Y -is expected here and not a single value. So you have to bind two -ObservableNumber object to the pad. \ No newline at end of file diff --git a/docs/API/aliases/XYPadSnapbackValues.md b/docs/API/aliases/XYPadSnapbackValues.md deleted file mode 100644 index 49d880ef..00000000 --- a/docs/API/aliases/XYPadSnapbackValues.md +++ /dev/null @@ -1,7 +0,0 @@ -# alias XYPadSnapbackValues {#XYPadSnapbackValues} -{ x : [`number`](/API/builtins/number.md), y : [`number`](/API/builtins/number.md) } -A table of snapback values for each axis -When snapback is enabled, the pad will revert its values to the specified -snapback values as soon as the mouse button is released in the pad. -When disabled, releasing the mouse button will not change the value. -You can disable snapback at runtime by setting it to nil or an empty table. \ No newline at end of file diff --git a/docs/API/aliases/XYPadValues.md b/docs/API/aliases/XYPadValues.md deleted file mode 100644 index 37424453..00000000 --- a/docs/API/aliases/XYPadValues.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias XYPadValues {#XYPadValues} -{ x : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md), y : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md) } -A table of the XYPad's current values on each axis \ No newline at end of file diff --git a/docs/API/aliases/XYValueNotifier.md b/docs/API/aliases/XYValueNotifier.md deleted file mode 100644 index 9968f06b..00000000 --- a/docs/API/aliases/XYValueNotifier.md +++ /dev/null @@ -1,3 +0,0 @@ -# alias XYValueNotifier {#XYValueNotifier} -[`XYValueNotifierFunction`](/API/aliases/XYValueNotifierFunction.md) | [`XYValueNotifierMethod1`](/API/aliases/XYValueNotifierMethod1.md) | [`XYValueNotifierMethod2`](/API/aliases/XYValueNotifierMethod2.md) -Set up a value notifier function that will be used whenever the pad's values change \ No newline at end of file diff --git a/docs/API/aliases/XYValueNotifierFunction.md b/docs/API/aliases/XYValueNotifierFunction.md deleted file mode 100644 index 42a66f4f..00000000 --- a/docs/API/aliases/XYValueNotifierFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias XYValueNotifierFunction {#XYValueNotifierFunction} -(value : [`XYPadValues`](/API/aliases/XYPadValues.md)) diff --git a/docs/API/aliases/XYValueNotifierMemberFunction.md b/docs/API/aliases/XYValueNotifierMemberFunction.md deleted file mode 100644 index ba124ed0..00000000 --- a/docs/API/aliases/XYValueNotifierMemberFunction.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias XYValueNotifierMemberFunction {#XYValueNotifierMemberFunction} -(self : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), value : [`XYPadValues`](/API/aliases/XYPadValues.md)) diff --git a/docs/API/aliases/XYValueNotifierMethod1.md b/docs/API/aliases/XYValueNotifierMethod1.md deleted file mode 100644 index 007a11c8..00000000 --- a/docs/API/aliases/XYValueNotifierMethod1.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias XYValueNotifierMethod1 {#XYValueNotifierMethod1} -{ 1 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md), 2 : [`XYValueNotifierMemberFunction`](/API/aliases/XYValueNotifierMemberFunction.md) } diff --git a/docs/API/aliases/XYValueNotifierMethod2.md b/docs/API/aliases/XYValueNotifierMethod2.md deleted file mode 100644 index d71b06bd..00000000 --- a/docs/API/aliases/XYValueNotifierMethod2.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias XYValueNotifierMethod2 {#XYValueNotifierMethod2} -{ 1 : [`XYValueNotifierMemberFunction`](/API/aliases/XYValueNotifierMemberFunction.md), 2 : [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md) } diff --git a/docs/API/aliases/renoise.PatternTrackLine.md b/docs/API/aliases/renoise.PatternTrackLine.md deleted file mode 100644 index 73852f48..00000000 --- a/docs/API/aliases/renoise.PatternTrackLine.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias renoise.PatternTrackLine {#renoise.PatternTrackLine} -[`renoise.PatternLine`](/API/renoise.PatternLine.md) diff --git a/docs/API/aliases/renoise.TrackDevice.md b/docs/API/aliases/renoise.TrackDevice.md deleted file mode 100644 index f29439d8..00000000 --- a/docs/API/aliases/renoise.TrackDevice.md +++ /dev/null @@ -1,2 +0,0 @@ -# alias renoise.TrackDevice {#renoise.TrackDevice} -[`renoise.AudioDevice`](/API/renoise.AudioDevice.md) diff --git a/docs/API/modules/global.md b/docs/API/modules/global.md index 48f73635..4bfc9204 100644 --- a/docs/API/modules/global.md +++ b/docs/API/modules/global.md @@ -69,7 +69,7 @@ for k,v in ripairs(t) do print(k, v) end -> "3 c, 2 b, 1 a" ### `rprint`(value : [`any`](/API/builtins/any.md)) {#rprint} Recursively dumps a table and all its members to the std out (console). This works for standard Lua types and class objects as well. -### `tostring`(pattern_line : [`renoise.PatternLine`](/API/renoise.PatternLine.md)) {#tostring} +### `tostring`(pattern_line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)) {#tostring} `->`[`string`](/API/builtins/string.md) diff --git a/docs/API/renoise.SampleModulationSet.md b/docs/API/renoise.SampleModulationSet.md deleted file mode 100644 index 713dafba..00000000 --- a/docs/API/renoise.SampleModulationSet.md +++ /dev/null @@ -1,72 +0,0 @@ -# renoise.SampleModulationSet - ---- -## Properties -### available_devices : [`string`](/API/builtins/string.md)`[]` {#available_devices} -**READ-ONLY** All available devices, to be used in 'insert_device_at'. - -### available_filter_types : [`FilterTypes`](/API/aliases/FilterTypes.md)`[]` {#available_filter_types} -**READ-ONLY** List of available filter types depending on the filter_version. - -### cutoff_input : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#cutoff_input} -Input value for the cutoff domain - -### devices : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)`[]` {#devices} -**READ-ONLY** Device list access. - -### devices_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#devices_observable} -### drive_input : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#drive_input} -Input value for the drive domain - -### filter_type : [`FilterTypes`](/API/aliases/FilterTypes.md) {#filter_type} -The type of the filter selected for the modulation set. -Songs made with previous versions of Renoise may use old filter types. - -### filter_type_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#filter_type_observable} -### filter_version : `1` | `2` | `3` {#filter_version} -**READ-ONLY** Filter version, 3 is the latest. - -### filter_version_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#filter_version_observable} -### name : [`string`](/API/builtins/string.md) {#name} -Name of the modulation set. - -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} -### panning_input : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#panning_input} -Input value for the panning domain - -### pitch_input : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#pitch_input} -Input value for the pitch domain - -### pitch_range : [`integer`](/API/builtins/integer.md) {#pitch_range} -Range: (1 - 96) - -### pitch_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#pitch_range_observable} -### resonance_input : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#resonance_input} -Input value for the resonance domain - -### volume_input : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#volume_input} -Input value for the volume domain - - - ---- -## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_set : [`renoise.SampleModulationSet`](/API/renoise.SampleModulationSet.md)) {#copy_from} -Copy all devices from another SampleModulationSet object. -### `delete_device_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_device_at} -Delete a device at the given index. -### `device`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#device} -`->`[`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md) - -Access a single device by index. -### `init`([*self*](/API/builtins/self.md)) {#init} -Reset all chain back to default initial state. Removing all devices too. -### `insert_device_at`([*self*](/API/builtins/self.md), device_path : [`string`](/API/builtins/string.md), target_type : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType), index : [`integer`](/API/builtins/integer.md)) {#insert_device_at} -`->`new_sample_modulation_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md) - -Insert a new device at the given position. "device_path" must be one of -renoise.song().instruments[].sample_modulation_sets[].available_devices. -### `upgrade_filter_version`([*self*](/API/builtins/self.md)) {#upgrade_filter_version} -Upgrade filter to the latest version. Tries to find a somewhat matching -filter in the new version, but things quite likely won't sound the same. - diff --git a/docs/API/renoise.Views.Aligner.md b/docs/API/renoise.Views.Aligner.md deleted file mode 100644 index 84471bea..00000000 --- a/docs/API/renoise.Views.Aligner.md +++ /dev/null @@ -1,18 +0,0 @@ -# renoise.Views.Aligner -Just like a Rack, the Aligner shows no content on its own. It just aligns -child views vertically or horizontally. As soon as children are added, the -Aligner will expand itself to make sure that all children are visible -(including spacing & margins). -To make use of modes like "center", you manually have to setup a size that -is bigger than the sum of the child sizes. - - ---- -## Properties -### margin : [`RackMargin`](/API/aliases/RackMargin.md) {#margin} -### mode : [`AlignerMode`](/API/aliases/AlignerMode.md) {#mode} -* Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) - -### spacing : [`RackSpacing`](/API/aliases/RackSpacing.md) {#spacing} - - diff --git a/docs/API/renoise.Views.Bitmap.md b/docs/API/renoise.Views.Bitmap.md deleted file mode 100644 index 85a92cf4..00000000 --- a/docs/API/renoise.Views.Bitmap.md +++ /dev/null @@ -1,35 +0,0 @@ -# renoise.Views.Bitmap -Draws a bitmap, or a draws a bitmap which acts like a button (as soon as a -notifier is specified). The notifier is called when clicking the mouse -somewhere on the bitmap. When using a re-colorable style (see 'mode'), the -bitmap is automatically recolored to match the current theme's colors. Mouse -hover is also enabled when notifiers are present, to show that the bitmap can -be clicked. -```text - * - *** - + * - / \ - +---+ - | O | o - +---+ | - |||||||||||| -``` - ---- -## Properties -### bitmap : [`BitmapPath`](/API/aliases/BitmapPath.md) {#bitmap} -Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). - -### mode : [`BitmapMode`](/API/aliases/BitmapMode.md) {#mode} -Setup how the bitmap should be drawn, recolored. Available modes are: - - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_notifier} -Add mouse click notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#remove_notifier} -Remove mouse click notifier - diff --git a/docs/API/renoise.Views.Button.md b/docs/API/renoise.Views.Button.md deleted file mode 100644 index 8c09cc50..00000000 --- a/docs/API/renoise.Views.Button.md +++ /dev/null @@ -1,44 +0,0 @@ -# renoise.Views.Button -A simple button that calls a custom notifier function when clicked. -Supports text or bitmap labels. -```text - +--------+ - | Button | - +--------+ -``` - ---- -## Properties -### bitmap : [`ButtonBitmapPath`](/API/aliases/ButtonBitmapPath.md) {#bitmap} -If set, existing text is removed and the loaded image is displayed instead. -Supported bitmap file formats are ".bmp", ".png" and ".tiff". -Colors in bitmaps will be overridden by the button's theme color, using black -as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. -All other colors are mapped to the theme color according to their grey value, -so plain white is the target theme color, and all other colors blend into the -button's background color of the theme. - -### color : [`ButtonColor`](/API/aliases/ButtonColor.md) {#color} -When set, the unpressed button's background will be drawn in the specified color. -A text color is automatically selected unless explicitly set, to make sure it's -always visible. -Set color {0,0,0} to enable the theme colors for the button again. - -### text : [`ButtonLabel`](/API/aliases/ButtonLabel.md) {#text} -The text label of the button -* Default: "" - - - ---- -## Functions -### `add_pressed_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_pressed_notifier} -Add/remove button hit/release notifier functions. -When a "pressed" notifier is set, the release notifier is guaranteed to be -called as soon as the mouse is released, either over your button or anywhere -else. When a "release" notifier is set, it is only called when the mouse -button is pressed !and! released over your button. -### `add_released_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_released_notifier} -### `remove_pressed_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#remove_pressed_notifier} -### `remove_released_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#remove_released_notifier} - diff --git a/docs/API/renoise.Views.CheckBox.md b/docs/API/renoise.Views.CheckBox.md deleted file mode 100644 index 2aa6d5ff..00000000 --- a/docs/API/renoise.Views.CheckBox.md +++ /dev/null @@ -1,24 +0,0 @@ -# renoise.Views.CheckBox -A single button with a checkbox bitmap, which can be used to toggle -something on/off. -```text - +----+ - | _/ | - +----+ -``` - ---- -## Properties -### value : [`CheckBoxBoolean`](/API/aliases/CheckBoxBoolean.md) {#value} -The current state of the checkbox, expressed as boolean. -* Default: false - - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](/API/aliases/BooleanValueNotifierFunction.md)) {#add_notifier} -Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](/API/aliases/BooleanValueNotifierFunction.md)) {#remove_notifier} -Remove value change notifier - diff --git a/docs/API/renoise.Views.Chooser.md b/docs/API/renoise.Views.Chooser.md deleted file mode 100644 index 4767e6b7..00000000 --- a/docs/API/renoise.Views.Chooser.md +++ /dev/null @@ -1,22 +0,0 @@ -# renoise.Views.Chooser -A radio button like set of vertically stacked items. Only one value can be -selected at a time. -```text - . Item A - o Item B - . Item C -``` - ---- -## Properties -### items : [`ItemLabels`](/API/aliases/ItemLabels.md) {#items} -### value : [`SelectedItem`](/API/aliases/SelectedItem.md) {#value} - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](/API/aliases/IntegerValueNotifierFunction.md)) {#add_notifier} -Add index change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](/API/aliases/IntegerValueNotifierFunction.md)) {#remove_notifier} -Remove index change notifier - diff --git a/docs/API/renoise.Views.Control.md b/docs/API/renoise.Views.Control.md deleted file mode 100644 index 8ed8f43d..00000000 --- a/docs/API/renoise.Views.Control.md +++ /dev/null @@ -1,22 +0,0 @@ -# renoise.Views.Control -Control is the base class for all views which let the user change a value or -some "state" from the UI. - ---- -## Properties -### active : [`ControlActive`](/API/aliases/ControlActive.md) {#active} -Instead of making a control invisible, you can also make it inactive. -Deactivated controls will still be shown, and will still show their -currently assigned values, but will not allow changes. Most controls will -display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](/API/aliases/ControlMidiMappingString.md) {#midi_mapping} -When set, the control will be highlighted when Renoise's MIDI mapping dialog -is open. When clicked, it selects the specified string as a MIDI mapping -target action. This target acton can either be one of the globally available -mappings in Renoise, or those that were created by the tool itself. -Target strings are not verified. When they point to nothing, the mapped MIDI -message will do nothing and no error is fired. - - - diff --git a/docs/API/renoise.Views.MiniSlider.md b/docs/API/renoise.Views.MiniSlider.md deleted file mode 100644 index 4791534d..00000000 --- a/docs/API/renoise.Views.MiniSlider.md +++ /dev/null @@ -1,23 +0,0 @@ -# renoise.Views.MiniSlider -Same as a slider, but without arrow buttons and a really tiny height. Just -like the slider, a mini slider can be horizontal or vertical. It will flip -its orientation according to the set width and height. By default horizontal. -```text - --------[] -``` - ---- -## Properties -### default : [`SliderDefaultValue`](/API/aliases/SliderDefaultValue.md) {#default} -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md) {#max} -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md) {#min} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md) {#value} - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#add_notifier} -Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#remove_notifier} -Remove value change notifier - diff --git a/docs/API/renoise.Views.MultiLineTextField.md b/docs/API/renoise.Views.MultiLineTextField.md deleted file mode 100644 index b369d4ab..00000000 --- a/docs/API/renoise.Views.MultiLineTextField.md +++ /dev/null @@ -1,41 +0,0 @@ -# renoise.Views.MultiLineTextField -Shows multiple text lines of text, auto-wrapping paragraphs into lines. The -text can be edited by the user. -```text - +--------------------------+-+ - | Editable Te|xt. |+| - | | | - | With multiple paragraphs | | - | and auto-wrapping |+| - +--------------------------+-+ -``` - ---- -## Properties -### active : [`TextActive`](/API/aliases/TextActive.md) {#active} -### edit_mode : [`TextEditMode`](/API/aliases/TextEditMode.md) {#edit_mode} -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md) {#font} -### paragraphs : [`TextParagraphs`](/API/aliases/TextParagraphs.md) {#paragraphs} -### style : [`TextBackgroundStyle`](/API/aliases/TextBackgroundStyle.md) {#style} -Default: "border" - -### text : [`TextValueAlias`](/API/aliases/TextValueAlias.md) {#text} -### value : [`TextMultilineString`](/API/aliases/TextMultilineString.md) {#value} - - ---- -## Functions -### `add_line`([*self*](/API/builtins/self.md), text : [`string`](/API/builtins/string.md)) {#add_line} -Append a new text to the existing text. Newline characters in the string will -create new paragraphs, otherwise a single paragraph is appended. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](/API/aliases/StringValueNotifierFunction.md)) {#add_notifier} -Add value change (text change) notifier -### `clear`([*self*](/API/builtins/self.md)) {#clear} -Clear the whole text. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](/API/aliases/StringValueNotifierFunction.md)) {#remove_notifier} -Remove value change (text change) notifier -### `scroll_to_first_line`([*self*](/API/builtins/self.md)) {#scroll_to_first_line} -When a scroll bar is visible, scroll the text to show the first line. -### `scroll_to_last_line`([*self*](/API/builtins/self.md)) {#scroll_to_last_line} -When a scroll bar is visible, scroll the text to show the last line. - diff --git a/docs/API/renoise.Views.Popup.md b/docs/API/renoise.Views.Popup.md deleted file mode 100644 index bca72efa..00000000 --- a/docs/API/renoise.Views.Popup.md +++ /dev/null @@ -1,25 +0,0 @@ -# renoise.Views.Popup -A drop-down menu which shows the currently selected value when closed. -When clicked, it pops up a list of all available items. -```text - +--------------++---+ - | Current Item || ^ | - +--------------++---+ -``` - ---- -## Properties -### items : [`PopupItemLabels`](/API/aliases/PopupItemLabels.md) {#items} -A list of buttons labels to show in order -The list can be empty, then "None" is displayed and the value won't change. - -### value : [`SelectedItem`](/API/aliases/SelectedItem.md) {#value} - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](/API/aliases/IntegerValueNotifierFunction.md)) {#add_notifier} -Add index change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](/API/aliases/IntegerValueNotifierFunction.md)) {#remove_notifier} -Remove index change notifier - diff --git a/docs/API/renoise.Views.Rack.md b/docs/API/renoise.Views.Rack.md deleted file mode 100644 index 2b35f47e..00000000 --- a/docs/API/renoise.Views.Rack.md +++ /dev/null @@ -1,27 +0,0 @@ -# renoise.Views.Rack -A Rack has no content on its own. It only stacks child views. Either -vertically (ViewBuilder.column) or horizontally (ViewBuilder.row). It allows -you to create view layouts. - ---- -## Properties -### margin : [`RackMargin`](/API/aliases/RackMargin.md) {#margin} -Set the "borders" of a rack (left, right, top and bottom inclusively) -* Default: 0 (no borders) - -### spacing : [`RackSpacing`](/API/aliases/RackSpacing.md) {#spacing} -Set the amount stacked child views are separated by (horizontally in -rows, vertically in columns). -* Default: 0 (no spacing) - -### style : [`ViewBackgroundStyle`](/API/aliases/ViewBackgroundStyle.md) {#style} -### uniform : [`RackUniformity`](/API/aliases/RackUniformity.md) {#uniform} -When set to true, all child views in the rack are automatically resized to -the max size of all child views (width in ViewBuilder.column, height in -ViewBuilder.row). This can be useful to automatically align all sub -columns/panels to the same size. Resizing is done automatically, as soon -as a child view size changes or new children are added. -* Default: false - - - diff --git a/docs/API/renoise.Views.RotaryEncoder.md b/docs/API/renoise.Views.RotaryEncoder.md deleted file mode 100644 index acd43023..00000000 --- a/docs/API/renoise.Views.RotaryEncoder.md +++ /dev/null @@ -1,28 +0,0 @@ -# renoise.Views.RotaryEncoder -A slider which looks like a potentiometer. -Note: when changing the size, the minimum of either width or height will be -used to draw and control the rotary, therefore you should always set both -equally when possible. -```text - +-+ - / \ \ - | o | - \ | / - +-+ -``` - ---- -## Properties -### default : [`SliderDefaultValue`](/API/aliases/SliderDefaultValue.md) {#default} -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md) {#max} -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md) {#min} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md) {#value} - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#add_notifier} -Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#remove_notifier} -Remove value change notifier - diff --git a/docs/API/renoise.Views.Slider.md b/docs/API/renoise.Views.Slider.md deleted file mode 100644 index a8592daf..00000000 --- a/docs/API/renoise.Views.Slider.md +++ /dev/null @@ -1,41 +0,0 @@ -# renoise.Views.Slider -A slider with arrow buttons, which shows and allows editing of values in a -custom range. A slider can be horizontal or vertical; will flip its -orientation according to the set width and height. By default horizontal. -```text - +---+---------------+ - |<|>| --------[] | - +---+---------------+ -``` - ---- -## Properties -### default : [`SliderDefaultValue`](/API/aliases/SliderDefaultValue.md) {#default} -The default value that will be re-applied on double-click - -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md) {#max} -The maximum value that can be set using the view -* Default: 1.0 - -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md) {#min} -The minimum value that can be set using the view -* Default: 0 - -### steps : [`SliderStepAmounts`](/API/aliases/SliderStepAmounts.md) {#steps} -A table containing two numbers representing the step amounts for incrementing -and decrementing by clicking the <> buttons. -The first value is the small step (applied on left clicks) -second value is the big step (applied on right clicks) - -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md) {#value} -The current value of the view - - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#add_notifier} -Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#remove_notifier} -Remove value change notifier - diff --git a/docs/API/renoise.Views.Switch.md b/docs/API/renoise.Views.Switch.md deleted file mode 100644 index 2043a967..00000000 --- a/docs/API/renoise.Views.Switch.md +++ /dev/null @@ -1,26 +0,0 @@ -# renoise.Views.Switch -A set of horizontally aligned buttons, where only one button can be enabled -at the same time. Select one of multiple choices, indices. -```text - +-----------+------------+----------+ - | Button A | +Button+B+ | Button C | - +-----------+------------+----------+ -``` - ---- -## Properties -### items : [`ItemLabels`](/API/aliases/ItemLabels.md) {#items} -A list of buttons labels to show in order. Must have more than one item. - -### value : [`SelectedItem`](/API/aliases/SelectedItem.md) {#value} -The currently selected item's index - - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](/API/aliases/IntegerValueNotifierFunction.md)) {#add_notifier} -Add index change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](/API/aliases/IntegerValueNotifierFunction.md)) {#remove_notifier} -Remove index change notifier - diff --git a/docs/API/renoise.Views.Text.md b/docs/API/renoise.Views.Text.md deleted file mode 100644 index 4ae6817a..00000000 --- a/docs/API/renoise.Views.Text.md +++ /dev/null @@ -1,28 +0,0 @@ -# renoise.Views.Text -Shows a "static" text string. Static just means that its not linked, bound -to some value and has no notifiers. The text can not be edited by the user. -Nevertheless you can of course change the text at run-time with the "text" -property. -```text - Text, Bla 1 -``` - ---- -## Properties -### align : [`TextAlignment`](/API/aliases/TextAlignment.md) {#align} -Setup the text's alignment. Applies only when the view's size is larger than -the needed size to draw the text - -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md) {#font} -The style that the text should be displayed with. - -### style : [`TextStyle`](/API/aliases/TextStyle.md) {#style} -Get/set the color style the text should be displayed with. - -### text : [`TextSingleLineString`](/API/aliases/TextSingleLineString.md) {#text} -The text that should be displayed. Setting a new text will resize -the view in order to make the text fully visible (expanding only). -* Default: "" - - - diff --git a/docs/API/renoise.Views.TextField.md b/docs/API/renoise.Views.TextField.md deleted file mode 100644 index 51a80b29..00000000 --- a/docs/API/renoise.Views.TextField.md +++ /dev/null @@ -1,40 +0,0 @@ -# renoise.Views.TextField -Shows a text string that can be clicked and edited by the user. -```text - +----------------+ - | Editable Te|xt | - +----------------+ -``` - ---- -## Properties -### active : [`TextActive`](/API/aliases/TextActive.md) {#active} -When false, text is displayed but can not be entered/modified by the user. -* Default: true - -### align : [`TextAlignment`](/API/aliases/TextAlignment.md) {#align} -Only used when not editing. - -### edit_mode : [`TextEditMode`](/API/aliases/TextEditMode.md) {#edit_mode} -True when the text field is focused. setting it at run-time programmatically -will focus the text field or remove the focus (focus the dialog) accordingly. -* Default: false - -### text : [`TextValueAlias`](/API/aliases/TextValueAlias.md) {#text} -Exactly the same as "value"; provided for consistency. -* Default: "" - -### value : [`TextValue`](/API/aliases/TextValue.md) {#value} -The currently shown text. The text will not be updated when editing, -rather only after editing is complete (return is pressed, or focus is lost). -* Default: "" - - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](/API/aliases/StringValueNotifierFunction.md)) {#add_notifier} -Add value change (text change) notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](/API/aliases/StringValueNotifierFunction.md)) {#remove_notifier} -Remove value change (text change) notifier - diff --git a/docs/API/renoise.Views.Value.md b/docs/API/renoise.Views.Value.md deleted file mode 100644 index a0f8afae..00000000 --- a/docs/API/renoise.Views.Value.md +++ /dev/null @@ -1,23 +0,0 @@ -# renoise.Views.Value -A static text view. Shows a string representation of a number and -allows custom "number to string" conversion. -```text - +---+-------+ - | 12.1 dB | - +---+-------+ -``` - ---- -## Properties -### align : [`TextAlignment`](/API/aliases/TextAlignment.md) {#align} -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md) {#font} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md) {#value} - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#add_notifier} -Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#remove_notifier} -Remove value change notifier - diff --git a/docs/API/renoise.Views.ValueBox.md b/docs/API/renoise.Views.ValueBox.md deleted file mode 100644 index 69d590e6..00000000 --- a/docs/API/renoise.Views.ValueBox.md +++ /dev/null @@ -1,30 +0,0 @@ -# renoise.Views.ValueBox -A box with arrow buttons and a text field that can be edited by the user. -Allows showing and editing natural numbers in a custom range. -```text - +---+-------+ - |<|>| 12 | - +---+-------+ -``` - ---- -## Properties -### max : [`ValueBoxMaxValue`](/API/aliases/ValueBoxMaxValue.md) {#max} -The maximum value that can be set using the view -* Default: 100 - -### min : [`ValueBoxMinValue`](/API/aliases/ValueBoxMinValue.md) {#min} -The minimum value that can be set using the view -* Default: 0 - -### steps : [`SliderStepAmounts`](/API/aliases/SliderStepAmounts.md) {#steps} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md) {#value} - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#add_notifier} -Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#remove_notifier} -Remove value change notifier - diff --git a/docs/API/renoise.Views.ValueField.md b/docs/API/renoise.Views.ValueField.md deleted file mode 100644 index 528331c7..00000000 --- a/docs/API/renoise.Views.ValueField.md +++ /dev/null @@ -1,25 +0,0 @@ -# renoise.Views.ValueField -A text view, which shows a string representation of a number and allows -custom "number to string" conversion. The value's text can be edited by the -user. -```lua - +---+-------+ - | 12.1 dB | - +---+-------+ -``` - ---- -## Properties -### align : [`TextAlignment`](/API/aliases/TextAlignment.md) {#align} -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md) {#max} -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md) {#min} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md) {#value} - - ---- -## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#add_notifier} -Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](/API/aliases/NumberValueNotifierFunction.md)) {#remove_notifier} -Remove value change notifier - diff --git a/docs/API/renoise.md b/docs/API/renoise.md index 2d517080..6062611a 100644 --- a/docs/API/renoise.md +++ b/docs/API/renoise.md @@ -18,20 +18,20 @@ Renoise Version "Major.Minor.Revision[AlphaBetaRcVersion][Demo]" --- ## Functions ### `TrackDevice`(device_index : [`integer`](/API/builtins/integer.md)) {#TrackDevice} -`->`[`renoise.AudioDevice`](/API/renoise.AudioDevice.md) +`->`[`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) Access to a single device by index. Use property `devices` to iterate over all devices and to query the device count. ### `app()` {#app} -`->`[`renoise.Application`](/API/renoise.Application.md) +`->`[`renoise.Application`](/API/renoise/renoise.Application.md) Global access to the Renoise Application. ### `app()` {#app} -`->`[`renoise.Application`](/API/renoise.Application.md) +`->`[`renoise.Application`](/API/renoise/renoise.Application.md) Global access to the Renoise Application. ### `song()` {#song} -`->`[`renoise.Song`](/API/renoise.Song.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Song`](/API/renoise/renoise.Song.md)[`?`](/API/builtins/nil.md) Global access to the Renoise Song. @@ -40,7 +40,7 @@ so tools can not memorize the song instance globally once, but must instead react on the application's `new_document_observable` observable. ### `song()` {#song} -`->`[`renoise.Song`](/API/renoise.Song.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Song`](/API/renoise/renoise.Song.md)[`?`](/API/builtins/nil.md) Global access to the Renoise Song. @@ -49,14 +49,14 @@ so tools can not memorize the song instance globally once, but must instead react on the application's `new_document_observable` observable. ### `tool()` {#tool} -`->`[`renoise.ScriptingTool`](/API/renoise.ScriptingTool.md) +`->`[`renoise.ScriptingTool`](/API/renoise/renoise.ScriptingTool.md) Global access to the Renoise Scripting Tool (your XRNX tool). This is only valid when getting called from a tool and not when e.g. using the scripting terminal and editor in Renoise. ### `tool()` {#tool} -`->`[`renoise.ScriptingTool`](/API/renoise.ScriptingTool.md) +`->`[`renoise.ScriptingTool`](/API/renoise/renoise.ScriptingTool.md) Global access to the Renoise Scripting Tool (your XRNX tool). diff --git a/docs/API/renoise.Application.md b/docs/API/renoise/renoise.Application.md similarity index 91% rename from docs/API/renoise.Application.md rename to docs/API/renoise/renoise.Application.md index 623e95da..7db2d050 100644 --- a/docs/API/renoise.Application.md +++ b/docs/API/renoise/renoise.Application.md @@ -6,7 +6,7 @@ The Renoise application. ### active_clipboard_index : `1` | `2` | `3` | `4` {#active_clipboard_index} Range: (1 - 4) Get or set globally used clipboard "slots" in the application. -### current_song : [`renoise.Song`](/API/renoise.Song.md) {#current_song} +### current_song : [`renoise.Song`](/API/renoise/renoise.Song.md) {#current_song} **READ-ONLY** Get the apps main document, the song. The global "renoise.song()" function is, in fact, a shortcut to this property. @@ -27,7 +27,7 @@ from it. ### recently_saved_song_files : [`string`](/API/builtins/string.md)`[]` {#recently_saved_song_files} **READ-ONLY** List of recently saved song files. -### window : [`renoise.ApplicationWindow`](/API/renoise.ApplicationWindow.md) {#window} +### window : [`renoise.ApplicationWindow`](/API/renoise/renoise.ApplicationWindow.md) {#window} **READ-ONLY** Access to the application's window. @@ -117,22 +117,22 @@ Opens the default file browser (explorer, finder...) with the given path. ### `open_url`([*self*](/API/builtins/self.md), url : [`string`](/API/builtins/string.md)) {#open_url} Opens the default internet browser with the given URL. The URL can also be a file that browsers can open (like xml, html files...). -### `prompt_for_filename_to_read`([*self*](/API/builtins/self.md), file_extensions : [`string`](/API/builtins/string.md)`[]`, title : [`DialogTitle`](/API/aliases/DialogTitle.md)) {#prompt_for_filename_to_read} +### `prompt_for_filename_to_read`([*self*](/API/builtins/self.md), file_extensions : [`string`](/API/builtins/string.md)`[]`, title : [`DialogTitle`](#DialogTitle)) {#prompt_for_filename_to_read} `->`path : [`string`](/API/builtins/string.md) Opens a modal dialog to query a filename and path to read from a file. -### `prompt_for_filename_to_write`([*self*](/API/builtins/self.md), file_extension : [`string`](/API/builtins/string.md), title : [`DialogTitle`](/API/aliases/DialogTitle.md)) {#prompt_for_filename_to_write} +### `prompt_for_filename_to_write`([*self*](/API/builtins/self.md), file_extension : [`string`](/API/builtins/string.md), title : [`DialogTitle`](#DialogTitle)) {#prompt_for_filename_to_write} `->`path : [`string`](/API/builtins/string.md) Open a modal dialog to get a filename and path for writing. When an existing file is selected, the dialog will ask whether or not to overwrite it, so you don't have to take care of this on your own. -### `prompt_for_multiple_filenames_to_read`([*self*](/API/builtins/self.md), file_extensions : [`string`](/API/builtins/string.md)`[]`, title : [`DialogTitle`](/API/aliases/DialogTitle.md)) {#prompt_for_multiple_filenames_to_read} +### `prompt_for_multiple_filenames_to_read`([*self*](/API/builtins/self.md), file_extensions : [`string`](/API/builtins/string.md)`[]`, title : [`DialogTitle`](#DialogTitle)) {#prompt_for_multiple_filenames_to_read} `->`paths : [`string`](/API/builtins/string.md)`[]` Same as 'prompt_for_filename_to_read' but allows the user to select more than one file. -### `prompt_for_path`([*self*](/API/builtins/self.md), title : [`DialogTitle`](/API/aliases/DialogTitle.md)) {#prompt_for_path} +### `prompt_for_path`([*self*](/API/builtins/self.md), title : [`DialogTitle`](#DialogTitle)) {#prompt_for_path} `->`path : [`string`](/API/builtins/string.md) Opens a modal dialog to query an existing directory from the user. @@ -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`](/API/aliases/DialogTitle.md), content_view : [`renoise.Views.View`](/API/renoise.Views.View.md), key_handler : [`KeyHandler`](/API/aliases/KeyHandler.md)[`?`](/API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](/API/structs/KeyHandlerOptions.md)[`?`](/API/builtins/nil.md)) {#show_custom_dialog} -`->`[`renoise.Dialog`](/API/renoise.Dialog.md) +### `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} +`->`[`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.Views.View.md), button_labels : [`string`](/API/builtins/string.md)`[]`, key_handler : [`KeyHandler`](/API/aliases/KeyHandler.md)[`?`](/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`](/API/structs/KeyHandlerOptions.md)[`?`](/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. @@ -209,3 +209,11 @@ Shows a warning dialog to the user. Uninstall an existing tool. Any errors are shown to the user during uninstallation. + + +--- +## Aliases +# alias DialogTitle {#DialogTitle} +[`string`](/API/builtins/string.md) + + diff --git a/docs/API/renoise.ApplicationWindow.md b/docs/API/renoise/renoise.ApplicationWindow.md similarity index 81% rename from docs/API/renoise.ApplicationWindow.md rename to docs/API/renoise/renoise.ApplicationWindow.md index d5e6394f..30406028 100644 --- a/docs/API/renoise.ApplicationWindow.md +++ b/docs/API/renoise/renoise.ApplicationWindow.md @@ -1,20 +1,6 @@ # renoise.ApplicationWindow Application window and general UI properties of the Renoise app. ## Constants -### MiddleFrame {#MiddleFrame} -```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, -} -``` ### UpperFrame {#UpperFrame} ```lua { @@ -31,6 +17,20 @@ Application window and general UI properties of the Renoise app. MIXER_FADER_TYPE_LINEAR: integer = 4, } ``` +### MiddleFrame {#MiddleFrame} +```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, +} +``` ### LowerFrame {#LowerFrame} ```lua { @@ -43,28 +43,28 @@ Application window and general UI properties of the Renoise app. --- ## Properties ### active_lower_frame : [`renoise.ApplicationWindow.LowerFrame`](renoise.ApplicationWindow.md#LowerFrame) {#active_lower_frame} -### active_lower_frame_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#active_lower_frame_observable} +### active_lower_frame_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#active_lower_frame_observable} ### active_middle_frame : [`renoise.ApplicationWindow.MiddleFrame`](renoise.ApplicationWindow.md#MiddleFrame) {#active_middle_frame} Frame with the pattern editor, mixer... -### active_middle_frame_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#active_middle_frame_observable} +### active_middle_frame_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#active_middle_frame_observable} ### active_upper_frame : [`renoise.ApplicationWindow.UpperFrame`](renoise.ApplicationWindow.md#UpperFrame) {#active_upper_frame} -### active_upper_frame_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#active_upper_frame_observable} +### active_upper_frame_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#active_upper_frame_observable} ### disk_browser_is_visible : [`boolean`](/API/builtins/boolean.md) {#disk_browser_is_visible} Diskbrowser Panel. -### disk_browser_is_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#disk_browser_is_visible_observable} +### disk_browser_is_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#disk_browser_is_visible_observable} ### fullscreen : [`boolean`](/API/builtins/boolean.md) {#fullscreen} Get/set if the application is running fullscreen. ### instrument_box_is_visible : [`boolean`](/API/builtins/boolean.md) {#instrument_box_is_visible} InstrumentBox -### instrument_box_is_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#instrument_box_is_visible_observable} +### instrument_box_is_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#instrument_box_is_visible_observable} ### instrument_editor_is_detached : [`boolean`](/API/builtins/boolean.md) {#instrument_editor_is_detached} Instrument Editor detaching. -### instrument_editor_is_detached_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#instrument_editor_is_detached_observable} +### instrument_editor_is_detached_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#instrument_editor_is_detached_observable} ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} **READ-ONLY**. Window status flag. @@ -78,34 +78,34 @@ stay focused unless alt or middle mouse is clicked. ### lower_frame_is_visible : [`boolean`](/API/builtins/boolean.md) {#lower_frame_is_visible} Frame with the DSP chain view, automation, etc. -### lower_frame_is_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#lower_frame_is_visible_observable} +### lower_frame_is_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#lower_frame_is_visible_observable} ### mixer_fader_type : [`renoise.ApplicationWindow.MixerFader`](renoise.ApplicationWindow.md#MixerFader) {#mixer_fader_type} Mixer fader type setting. -### mixer_fader_type_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#mixer_fader_type_observable} +### mixer_fader_type_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#mixer_fader_type_observable} ### mixer_view_is_detached : [`boolean`](/API/builtins/boolean.md) {#mixer_view_is_detached} Mixer View detaching. -### mixer_view_is_detached_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#mixer_view_is_detached_observable} +### mixer_view_is_detached_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#mixer_view_is_detached_observable} ### mixer_view_post_fx : [`boolean`](/API/builtins/boolean.md) {#mixer_view_post_fx} Mixer views Pre/Post volume setting. -### mixer_view_post_fx_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#mixer_view_post_fx_observable} +### mixer_view_post_fx_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#mixer_view_post_fx_observable} ### pattern_advanced_edit_is_visible : [`boolean`](/API/builtins/boolean.md) {#pattern_advanced_edit_is_visible} Pattern advanced edit, visible in pattern editor only... -### pattern_advanced_edit_is_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#pattern_advanced_edit_is_visible_observable} +### pattern_advanced_edit_is_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#pattern_advanced_edit_is_visible_observable} ### pattern_matrix_is_visible : [`boolean`](/API/builtins/boolean.md) {#pattern_matrix_is_visible} Pattern matrix, visible in pattern editor and mixer only... -### pattern_matrix_is_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#pattern_matrix_is_visible_observable} +### pattern_matrix_is_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#pattern_matrix_is_visible_observable} ### sample_record_dialog_is_visible : [`boolean`](/API/builtins/boolean.md) {#sample_record_dialog_is_visible} Dialog for recording new samples, floating above the main window. ### upper_frame_is_visible : [`boolean`](/API/builtins/boolean.md) {#upper_frame_is_visible} Frame with the scopes/master spectrum... -### upper_frame_is_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#upper_frame_is_visible_observable} +### upper_frame_is_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#upper_frame_is_visible_observable} --- diff --git a/docs/API/renoise.AudioDevice.md b/docs/API/renoise/renoise.AudioDevice.md similarity index 82% rename from docs/API/renoise.AudioDevice.md rename to docs/API/renoise/renoise.AudioDevice.md index ced2911c..70b7f155 100644 --- a/docs/API/renoise.AudioDevice.md +++ b/docs/API/renoise/renoise.AudioDevice.md @@ -9,7 +9,7 @@ Audio DSP device in tracks or sample device chains. ### active_preset_data : [`string`](/API/builtins/string.md) {#active_preset_data} raw serialized data in XML format of the active preset -### active_preset_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#active_preset_observable} +### active_preset_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#active_preset_observable} ### device_path : [`string`](/API/builtins/string.md) {#device_path} **READ-ONLY** Returns a string that uniquely identifies the device, from `available_devices`. The string can be passed into: @@ -18,7 +18,7 @@ raw serialized data in XML format of the active preset ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. When empty `name` is displayed. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### external_editor_available : [`boolean`](/API/builtins/boolean.md) {#external_editor_available} **READ-ONLY** Returns whether or not the device provides its own custom GUI (only available for some plugin devices) @@ -29,18 +29,18 @@ true to show the editor, false to close it ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} !active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in DSP chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### presets : [`string`](/API/builtins/string.md)`[]` {#presets} @@ -54,7 +54,7 @@ Maximize state in DSP chain. --- ## Functions ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.DeviceParameter.md b/docs/API/renoise/renoise.DeviceParameter.md similarity index 86% rename from docs/API/renoise.DeviceParameter.md rename to docs/API/renoise/renoise.DeviceParameter.md index 931da3c2..192282f6 100644 --- a/docs/API/renoise.DeviceParameter.md +++ b/docs/API/renoise/renoise.DeviceParameter.md @@ -18,11 +18,11 @@ A single parameter within an audio DSP effect (renoise.AudioDevice) ### is_automated : [`boolean`](/API/builtins/boolean.md) {#is_automated} **READ-ONLY** Is automated. Not valid for parameters of instrument devices. -### is_automated_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_automated_observable} +### is_automated_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_automated_observable} ### is_midi_mapped : [`boolean`](/API/builtins/boolean.md) {#is_midi_mapped} **READ-ONLY** Parameter has a custom MIDI mapping in the current song. -### is_midi_mapped_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_midi_mapped_observable} +### is_midi_mapped_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_midi_mapped_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** @@ -33,7 +33,7 @@ A single parameter within an audio DSP effect (renoise.AudioDevice) - Show in mixer. Not valid for parameters of instrument devices. -### show_in_mixer_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#show_in_mixer_observable} +### show_in_mixer_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#show_in_mixer_observable} ### time_quantum : [`number`](/API/builtins/number.md) {#time_quantum} **READ-ONLY** @@ -49,12 +49,12 @@ value in Range: (value_min - value_max) ### value_min : [`number`](/API/builtins/number.md) {#value_min} **READ-ONLY** -### value_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#value_observable} +### value_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#value_observable} ### value_quantum : [`number`](/API/builtins/number.md) {#value_quantum} **READ-ONLY** ### value_string : [`string`](/API/builtins/string.md) {#value_string} -### value_string_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#value_string_observable} +### value_string_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#value_string_observable} --- diff --git a/docs/API/renoise.Dialog.md b/docs/API/renoise/renoise.Dialog.md similarity index 100% rename from docs/API/renoise.Dialog.md rename to docs/API/renoise/renoise.Dialog.md diff --git a/docs/API/renoise.Document.DocumentList.md b/docs/API/renoise/renoise.Document.DocumentList.md similarity index 76% rename from docs/API/renoise.Document.DocumentList.md rename to docs/API/renoise/renoise.Document.DocumentList.md index d702fae2..b1fc94e7 100644 --- a/docs/API/renoise.Document.DocumentList.md +++ b/docs/API/renoise/renoise.Document.DocumentList.md @@ -4,30 +4,30 @@ nodes in an observable list. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the document lists layout changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. -### `find`([*self*](/API/builtins/self.md), start_pos : [`integer`](/API/builtins/integer.md), value : [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md)) {#find} +### `find`([*self*](/API/builtins/self.md), start_pos : [`integer`](/API/builtins/integer.md), value : [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)) {#find} `->`[`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) Find a value in the list by comparing the list values with the passed value. The first successful match is returned. When no match is found, nil is returned. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#has_notifier} Checks if the given function, method was already registered as notifier. -### `insert`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md), value : [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md)) {#insert} -`->`[`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) +### `insert`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md), value : [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)) {#insert} +`->`[`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) Insert a new item to the end of the list when no position is specified, or at the specified position. Returns the newly created and inserted Observable. ### `property`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#property} -`->`[`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)[`?`](/API/builtins/nil.md) List item access by index. returns nil for non existing items. ### `remove`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md)) {#remove} Removes an item (or the last one if no index is specified) from the list. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md) | [`ListNotifierMemberContext`](/API/aliases/ListNotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#remove_notifier} Unregister a previously registered list notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -42,3 +42,11 @@ Swaps the positions of two items without adding/removing the items. With a series of swaps you can move the item from/to any position. + + +--- +## Aliases +# alias ListNotifierFunction {#ListNotifierFunction} +(change : [`ListElementChange`](#ListElementChange)) + + diff --git a/docs/API/renoise.Document.DocumentNode.md b/docs/API/renoise/renoise.Document.DocumentNode.md similarity index 73% rename from docs/API/renoise.Document.DocumentNode.md rename to docs/API/renoise/renoise.Document.DocumentNode.md index 532b4f9d..51774f89 100644 --- a/docs/API/renoise.Document.DocumentNode.md +++ b/docs/API/renoise/renoise.Document.DocumentNode.md @@ -7,10 +7,10 @@ documents or observables. ### `__init`([*self*](/API/builtins/self.md)) {#__init} Base constructor, only necessary to be called in your custom class constructor, when inheriting from renoise.Document.DocumentNode. -### `add_properties`([*self*](/API/builtins/self.md), properties : [`ObservableProperties`](/API/aliases/ObservableProperties.md)) {#add_properties} +### `add_properties`([*self*](/API/builtins/self.md), properties : [`ObservableProperties`](#ObservableProperties)) {#add_properties} Add a batch of properties in one go, similar to renoise.Document.create. -### `add_property`([*self*](/API/builtins/self.md), name : [`string`](/API/builtins/string.md), value : [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md)) {#add_property} -`->`[`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) +### `add_property`([*self*](/API/builtins/self.md), name : [`string`](/API/builtins/string.md), value : [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)) {#add_property} +`->`[`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) Add a new property. Name must be unique: overwriting already existing properties with the same name is not allowed and will fire an error. @@ -39,11 +39,11 @@ A document's type is specified in the renoise.Document.create() function as "model_name". For classes which inherit from renoise.Document.DocumentNode it's the class name. ### `property`([*self*](/API/builtins/self.md), property_name : [`string`](/API/builtins/string.md)) {#property} -`->`[`DocumentMember`](/API/aliases/DocumentMember.md)[`?`](/API/builtins/nil.md) +`->`[`DocumentMember`](#DocumentMember)[`?`](/API/builtins/nil.md) Access a property by name. Returns the property, or nil when there is no such property. -### `remove_property`([*self*](/API/builtins/self.md), value : [`DocumentMember`](/API/aliases/DocumentMember.md)) {#remove_property} +### `remove_property`([*self*](/API/builtins/self.md), value : [`DocumentMember`](#DocumentMember)) {#remove_property} Remove a previously added property. Property must exist. In order to remove a value by it's key, use @@ -58,3 +58,15 @@ file when it already exists. Serialize the whole document tree to a XML string. + + +--- +## Aliases +# alias DocumentMember {#DocumentMember} +[`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.Document.Observable.md b/docs/API/renoise/renoise.Document.Observable.md similarity index 88% rename from docs/API/renoise.Document.Observable.md rename to docs/API/renoise/renoise.Document.Observable.md index 29a2b624..95e50a1c 100644 --- a/docs/API/renoise.Document.Observable.md +++ b/docs/API/renoise/renoise.Document.Observable.md @@ -28,7 +28,7 @@ end --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable's value changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -47,14 +47,22 @@ renoise.song().transport.bpm_observable:add_notifier({ end }) ``` -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} `->`[`boolean`](/API/builtins/boolean.md) Checks if the given function, method was already registered as notifier. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md) | [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#remove_notifier} Unregister a previously registered notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. Trying to unregister a function or method which wasn't registered, will resolve into an error. + + +--- +## Aliases +# alias NotifierFunction {#NotifierFunction} +fun() + + diff --git a/docs/API/renoise.Document.ObservableBang.md b/docs/API/renoise/renoise.Document.ObservableBang.md similarity index 82% rename from docs/API/renoise.Document.ObservableBang.md rename to docs/API/renoise/renoise.Document.ObservableBang.md index 6bb07401..d73e38cd 100644 --- a/docs/API/renoise.Document.ObservableBang.md +++ b/docs/API/renoise/renoise.Document.ObservableBang.md @@ -3,7 +3,7 @@ Observable without a value which sends out notifications when "banging" it. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable's value changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -24,14 +24,22 @@ renoise.song().transport.bpm_observable:add_notifier({ ``` ### `bang`([*self*](/API/builtins/self.md)) {#bang} fire a notification, calling all registered notifiers. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} `->`[`boolean`](/API/builtins/boolean.md) Checks if the given function, method was already registered as notifier. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md) | [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#remove_notifier} Unregister a previously registered notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. Trying to unregister a function or method which wasn't registered, will resolve into an error. + + +--- +## Aliases +# alias NotifierFunction {#NotifierFunction} +fun() + + diff --git a/docs/API/renoise.Document.ObservableBoolean.md b/docs/API/renoise/renoise.Document.ObservableBoolean.md similarity index 85% rename from docs/API/renoise.Document.ObservableBoolean.md rename to docs/API/renoise/renoise.Document.ObservableBoolean.md index 38359cf5..a0620193 100644 --- a/docs/API/renoise.Document.ObservableBoolean.md +++ b/docs/API/renoise/renoise.Document.ObservableBoolean.md @@ -9,7 +9,7 @@ Read/write access to the value of an observable. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable's value changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -33,11 +33,11 @@ renoise.song().transport.bpm_observable:add_notifier({ Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} `->`[`boolean`](/API/builtins/boolean.md) Checks if the given function, method was already registered as notifier. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md) | [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#remove_notifier} Unregister a previously registered notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -48,3 +48,11 @@ into an error. Serialize an object to a string. + + +--- +## Aliases +# alias NotifierFunction {#NotifierFunction} +fun() + + diff --git a/docs/API/renoise.Document.ObservableBooleanList.md b/docs/API/renoise/renoise.Document.ObservableBooleanList.md similarity index 81% rename from docs/API/renoise.Document.ObservableBooleanList.md rename to docs/API/renoise/renoise.Document.ObservableBooleanList.md index 614f9136..608e160b 100644 --- a/docs/API/renoise.Document.ObservableBooleanList.md +++ b/docs/API/renoise/renoise.Document.ObservableBooleanList.md @@ -3,7 +3,7 @@ A observable list of boolean values. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable lists layout changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -18,20 +18,20 @@ is returned. Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#has_notifier} Checks if the given function, method was already registered as notifier. ### `insert`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md), value : [`boolean`](/API/builtins/boolean.md)) {#insert} -`->`[`renoise.Document.ObservableBoolean`](/API/renoise.Document.ObservableBoolean.md) +`->`[`renoise.Document.ObservableBoolean`](/API/renoise/renoise.Document.ObservableBoolean.md) Insert a new item to the end of the list when no position is specified, or at the specified position. Returns the newly created and inserted Observable. ### `property`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#property} -`->`[`renoise.Document.ObservableBoolean`](/API/renoise.Document.ObservableBoolean.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Document.ObservableBoolean`](/API/renoise/renoise.Document.ObservableBoolean.md)[`?`](/API/builtins/nil.md) List item access by index. returns nil for non existing items. ### `remove`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md)) {#remove} Removes an item (or the last one if no index is specified) from the list. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md) | [`ListNotifierMemberContext`](/API/aliases/ListNotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#remove_notifier} Unregister a previously registered list notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -50,3 +50,11 @@ With a series of swaps you can move the item from/to any position. Serialize an object to a string. + + +--- +## Aliases +# alias ListNotifierFunction {#ListNotifierFunction} +(change : [`ListElementChange`](#ListElementChange)) + + diff --git a/docs/API/renoise.Document.ObservableList.md b/docs/API/renoise/renoise.Document.ObservableList.md similarity index 83% rename from docs/API/renoise.Document.ObservableList.md rename to docs/API/renoise/renoise.Document.ObservableList.md index 21e492f5..1d7f8e82 100644 --- a/docs/API/renoise.Document.ObservableList.md +++ b/docs/API/renoise/renoise.Document.ObservableList.md @@ -26,13 +26,13 @@ renoise.song().tracks_observable:add_notifier(tracks_changed) --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable lists layout changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#has_notifier} Checks if the given function, method was already registered as notifier. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md) | [`ListNotifierMemberContext`](/API/aliases/ListNotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#remove_notifier} Unregister a previously registered list notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -43,3 +43,11 @@ into an error. Returns the number of entries of the list. + + +--- +## Aliases +# alias ListNotifierFunction {#ListNotifierFunction} +(change : [`ListElementChange`](#ListElementChange)) + + diff --git a/docs/API/renoise.Document.ObservableNumber.md b/docs/API/renoise/renoise.Document.ObservableNumber.md similarity index 85% rename from docs/API/renoise.Document.ObservableNumber.md rename to docs/API/renoise/renoise.Document.ObservableNumber.md index bf4b8ab6..425c100d 100644 --- a/docs/API/renoise.Document.ObservableNumber.md +++ b/docs/API/renoise/renoise.Document.ObservableNumber.md @@ -9,7 +9,7 @@ Read/write access to the value of an Observable. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable's value changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -33,11 +33,11 @@ renoise.song().transport.bpm_observable:add_notifier({ Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} `->`[`boolean`](/API/builtins/boolean.md) Checks if the given function, method was already registered as notifier. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md) | [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#remove_notifier} Unregister a previously registered notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -48,3 +48,11 @@ into an error. Serialize an object to a string. + + +--- +## Aliases +# alias NotifierFunction {#NotifierFunction} +fun() + + diff --git a/docs/API/renoise.Document.ObservableNumberList.md b/docs/API/renoise/renoise.Document.ObservableNumberList.md similarity index 81% rename from docs/API/renoise.Document.ObservableNumberList.md rename to docs/API/renoise/renoise.Document.ObservableNumberList.md index cd39d779..830e588d 100644 --- a/docs/API/renoise.Document.ObservableNumberList.md +++ b/docs/API/renoise/renoise.Document.ObservableNumberList.md @@ -3,7 +3,7 @@ A observable list of number values. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable lists layout changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -18,20 +18,20 @@ is returned. Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#has_notifier} Checks if the given function, method was already registered as notifier. ### `insert`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md), value : [`number`](/API/builtins/number.md)) {#insert} -`->`[`renoise.Document.ObservableNumber`](/API/renoise.Document.ObservableNumber.md) +`->`[`renoise.Document.ObservableNumber`](/API/renoise/renoise.Document.ObservableNumber.md) Insert a new item to the end of the list when no position is specified, or at the specified position. Returns the newly created and inserted Observable. ### `property`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#property} -`->`[`renoise.Document.ObservableNumber`](/API/renoise.Document.ObservableNumber.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Document.ObservableNumber`](/API/renoise/renoise.Document.ObservableNumber.md)[`?`](/API/builtins/nil.md) List item access by index. returns nil for non existing items. ### `remove`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md)) {#remove} Removes an item (or the last one if no index is specified) from the list. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md) | [`ListNotifierMemberContext`](/API/aliases/ListNotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#remove_notifier} Unregister a previously registered list notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -49,3 +49,11 @@ With a series of swaps you can move the item from/to any position. Serialize an object to a string. + + +--- +## Aliases +# alias ListNotifierFunction {#ListNotifierFunction} +(change : [`ListElementChange`](#ListElementChange)) + + diff --git a/docs/API/renoise.Document.ObservableString.md b/docs/API/renoise/renoise.Document.ObservableString.md similarity index 85% rename from docs/API/renoise.Document.ObservableString.md rename to docs/API/renoise/renoise.Document.ObservableString.md index 24622b05..6f45bd3f 100644 --- a/docs/API/renoise.Document.ObservableString.md +++ b/docs/API/renoise/renoise.Document.ObservableString.md @@ -9,7 +9,7 @@ Read/write access to the value of an Observable. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable's value changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -33,11 +33,11 @@ renoise.song().transport.bpm_observable:add_notifier({ Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} `->`[`boolean`](/API/builtins/boolean.md) Checks if the given function, method was already registered as notifier. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](/API/aliases/NotifierFunction.md) | [`NotifierMemberContext`](/API/aliases/NotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#remove_notifier} Unregister a previously registered notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -48,3 +48,11 @@ into an error. Serialize an object to a string. + + +--- +## Aliases +# alias NotifierFunction {#NotifierFunction} +fun() + + diff --git a/docs/API/renoise.Document.ObservableStringList.md b/docs/API/renoise/renoise.Document.ObservableStringList.md similarity index 81% rename from docs/API/renoise.Document.ObservableStringList.md rename to docs/API/renoise/renoise.Document.ObservableStringList.md index d134ca3c..9ed6a275 100644 --- a/docs/API/renoise.Document.ObservableStringList.md +++ b/docs/API/renoise/renoise.Document.ObservableStringList.md @@ -3,7 +3,7 @@ A observable list of number values. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#add_notifier} Register a function or method as a notifier, which will be called as soon as the observable lists layout changed. The passed notifier can either be a function or a table with a function and some context (an "object") -> method. @@ -18,20 +18,20 @@ is returned. Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md)) {#has_notifier} +### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#has_notifier} Checks if the given function, method was already registered as notifier. ### `insert`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md), value : [`number`](/API/builtins/number.md)) {#insert} -`->`[`renoise.Document.ObservableString`](/API/renoise.Document.ObservableString.md) +`->`[`renoise.Document.ObservableString`](/API/renoise/renoise.Document.ObservableString.md) Insert a new item to the end of the list when no position is specified, or at the specified position. Returns the newly created and inserted Observable. ### `property`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#property} -`->`[`renoise.Document.ObservableString`](/API/renoise.Document.ObservableString.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Document.ObservableString`](/API/renoise/renoise.Document.ObservableString.md)[`?`](/API/builtins/nil.md) List item access by index. returns nil for non existing items. ### `remove`([*self*](/API/builtins/self.md), pos : [`integer`](/API/builtins/integer.md)) {#remove} Removes an item (or the last one if no index is specified) from the list. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](/API/aliases/ListNotifierFunction.md) | [`ListNotifierMemberContext`](/API/aliases/ListNotifierMemberContext.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#remove_notifier} Unregister a previously registered list notifier. When only passing an object, all notifier functions that match the given object will be removed. This will not fire errors when no methods for the given object are attached. @@ -49,3 +49,11 @@ With a series of swaps you can move the item from/to any position. Serialize an object to a string. + + +--- +## Aliases +# alias ListNotifierFunction {#ListNotifierFunction} +(change : [`ListElementChange`](#ListElementChange)) + + diff --git a/docs/API/renoise.Document.Serializable.md b/docs/API/renoise/renoise.Document.Serializable.md similarity index 100% rename from docs/API/renoise.Document.Serializable.md rename to docs/API/renoise/renoise.Document.Serializable.md diff --git a/docs/API/renoise.Document.md b/docs/API/renoise/renoise.Document.md similarity index 88% rename from docs/API/renoise.Document.md rename to docs/API/renoise/renoise.Document.md index c822c542..28a4bfff 100644 --- a/docs/API/renoise.Document.md +++ b/docs/API/renoise/renoise.Document.md @@ -83,7 +83,7 @@ Construct a new document node. --- ## Functions ### `create`(model_name : [`string`](/API/builtins/string.md)) {#create} -`->`(properties : [`ObservableProperties`](/API/aliases/ObservableProperties.md)) `->` [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) +`->`(properties : [`ObservableProperties`](#ObservableProperties)) `->` [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) Create an empty DocumentNode or a DocumentNode that is modeled after the passed key value table. "model_name" will be used to identify the documents @@ -123,7 +123,7 @@ create new instances. my_other_document = renoise.Document.instantiate("MyDoc") ``` ### `create`(model_name : [`string`](/API/builtins/string.md)) {#create} -`->`(properties : [`ObservableProperties`](/API/aliases/ObservableProperties.md)) `->` [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) +`->`(properties : [`ObservableProperties`](#ObservableProperties)) `->` [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) Create an empty DocumentNode or a DocumentNode that is modeled after the passed key value table. "model_name" will be used to identify the documents @@ -163,13 +163,21 @@ create new instances. my_other_document = renoise.Document.instantiate("MyDoc") ``` ### `instantiate`(model_name : [`string`](/API/builtins/string.md)) {#instantiate} -`->`[`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) +`->`[`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) Create a new instance of the given document model. Given `model_name` must have been registered with `renoise.Document.create` before. ### `instantiate`(model_name : [`string`](/API/builtins/string.md)) {#instantiate} -`->`[`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) +`->`[`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) Create a new instance of the given document model. Given `model_name` must have been registered with `renoise.Document.create` before. + + +--- +## Aliases +# 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.EffectColumn.md b/docs/API/renoise/renoise.EffectColumn.md similarity index 94% rename from docs/API/renoise.EffectColumn.md rename to docs/API/renoise/renoise.EffectColumn.md index 96f3958c..db828ce5 100644 --- a/docs/API/renoise.EffectColumn.md +++ b/docs/API/renoise/renoise.EffectColumn.md @@ -31,6 +31,6 @@ Range: ('00' - 'ZZ') ## Functions ### `clear`([*self*](/API/builtins/self.md)) {#clear} Clear the effect column. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.EffectColumn`](/API/renoise.EffectColumn.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md)) {#copy_from} Copy the column's content from another column. diff --git a/docs/API/renoise.GroupTrack.md b/docs/API/renoise/renoise.GroupTrack.md similarity index 72% rename from docs/API/renoise.GroupTrack.md rename to docs/API/renoise/renoise.GroupTrack.md index bee97b3c..f2c2a06f 100644 --- a/docs/API/renoise.GroupTrack.md +++ b/docs/API/renoise/renoise.GroupTrack.md @@ -15,8 +15,8 @@ Group track component of a Renoise song. ### collapsed : [`boolean`](/API/builtins/boolean.md) {#collapsed} Collapsed/expanded visual appearance. -### collapsed_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#collapsed_observable} -### color : [`RGBColor`](/API/aliases/RGBColor.md) {#color} +### collapsed_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#collapsed_observable} +### color : [`RGBColor`](#RGBColor) {#color} 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 @@ -25,18 +25,18 @@ representing the red, green and blue channels of a color. ### color_blend : [`integer`](/API/builtins/integer.md) {#color_blend} Range: (0 - 100) Color blend in percent -### color_blend_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#color_blend_observable} -### color_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#color_observable} +### color_blend_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_blend_observable} +### color_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_observable} ### delay_column_visible : [`boolean`](/API/builtins/boolean.md) {#delay_column_visible} -### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#delay_column_visible_observable} -### devices : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md)`[]` {#devices} +### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} +### devices : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md)`[]` {#devices} **READ-ONLY** List of audio DSP FX. -### devices_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#devices_observable} +### devices_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#devices_observable} ### group_collapsed : [`boolean`](/API/builtins/boolean.md) {#group_collapsed} Collapsed/expanded visual appearance of whole group. -### group_parent : [`renoise.GroupTrack`](/API/renoise.GroupTrack.md) {#group_parent} +### group_parent : [`renoise.GroupTrack`](/API/renoise/renoise.GroupTrack.md) {#group_parent} **READ-ONLY** ### max_effect_columns : [`integer`](/API/builtins/integer.md) {#max_effect_columns} @@ -45,7 +45,7 @@ Collapsed/expanded visual appearance of whole group. ### max_note_columns : [`integer`](/API/builtins/integer.md) {#max_note_columns} **READ-ONLY** 12 OR 0 depending on the track type -### members : [`renoise.Track`](/API/renoise.Track.md)`[]` {#members} +### members : [`renoise.Track`](/API/renoise/renoise.Track.md)`[]` {#members} **READ-ONLY** All member tracks of this group, including subgroups and their tracks. @@ -58,53 +58,53 @@ their tracks. ### mute_state : [`renoise.Track.MuteState`](renoise.Track.md#MuteState) {#mute_state} Mute and solo states. Not available for the master track. -### mute_state_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#mute_state_observable} +### mute_state_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#mute_state_observable} ### name : [`string`](/API/builtins/string.md) {#name} Name, as visible in track headers -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### output_delay : [`number`](/API/builtins/number.md) {#output_delay} Range: (-100.0-100.0) in ms -### output_delay_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#output_delay_observable} +### output_delay_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_delay_observable} ### output_routing : [`string`](/API/builtins/string.md) {#output_routing} One of `available_output_routings` -### output_routing_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#output_routing_observable} +### output_routing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_routing_observable} ### panning_column_visible : [`boolean`](/API/builtins/boolean.md) {#panning_column_visible} -### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#panning_column_visible_observable} -### postfx_panning : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#postfx_panning} +### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} +### postfx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_panning} **READ-ONLY** -### postfx_volume : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#postfx_volume} +### postfx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_volume} **READ-ONLY** -### prefx_panning : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#prefx_panning} +### prefx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_panning} **READ-ONLY** -### prefx_volume : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#prefx_volume} +### prefx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_volume} **READ-ONLY** -### prefx_width : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#prefx_width} +### prefx_width : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_width} **READ-ONLY** ### sample_effects_column_visible : [`boolean`](/API/builtins/boolean.md) {#sample_effects_column_visible} -### sample_effects_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} +### sample_effects_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} ### solo_state : [`boolean`](/API/builtins/boolean.md) {#solo_state} -### solo_state_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#solo_state_observable} +### solo_state_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#solo_state_observable} ### type : [`renoise.Track.TrackType`](renoise.Track.md#TrackType) {#type} **READ-ONLY** ### visible_effect_columns : [`integer`](/API/builtins/integer.md) {#visible_effect_columns} 1-8 OR 0-8, depending on the track type -### visible_effect_columns_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#visible_effect_columns_observable} +### visible_effect_columns_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#visible_effect_columns_observable} ### visible_note_columns : [`integer`](/API/builtins/integer.md) {#visible_note_columns} 0 OR 1-12, depending on the track type -### visible_note_columns_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#visible_note_columns_observable} +### visible_note_columns_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#visible_note_columns_observable} ### volume_column_visible : [`boolean`](/API/builtins/boolean.md) {#volume_column_visible} -### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#volume_column_visible_observable} +### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} --- @@ -114,20 +114,20 @@ One of `available_output_routings` Note column mutes. Only valid within (1-track.max_note_columns) ### `column_is_muted_observable`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_is_muted_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) ### `column_name`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_name} `->`[`string`](/API/builtins/string.md) Note column names. Only valid within (1-track.max_note_columns) ### `column_name_observable`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_name_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) ### `delete_device_at`([*self*](/API/builtins/self.md), device_index : [`any`](/API/builtins/any.md)) {#delete_device_at} Delete an existing device in a track. The mixer device at index 1 can not be deleted from any track. ### `insert_device_at`([*self*](/API/builtins/self.md), device_path : [`string`](/API/builtins/string.md), device_index : [`integer`](/API/builtins/integer.md)) {#insert_device_at} -`->`[`renoise.AudioDevice`](/API/renoise.AudioDevice.md) +`->`[`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) Insert a new device at the given position. `device_path` must be one of `renoise.Track.available_devices`. @@ -144,3 +144,14 @@ index 1 can not be swapped or moved. Swap the positions of two note or effect columns within a track. ### `unmute`([*self*](/API/builtins/self.md)) {#unmute} + + +--- +## Aliases +# alias RGBColor {#RGBColor} +{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +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.Instrument.md b/docs/API/renoise/renoise.Instrument.md similarity index 75% rename from docs/API/renoise.Instrument.md rename to docs/API/renoise/renoise.Instrument.md index 4117b97a..14b57178 100644 --- a/docs/API/renoise.Instrument.md +++ b/docs/API/renoise/renoise.Instrument.md @@ -1,21 +1,5 @@ # renoise.Instrument ## Constants -### OverlapMode {#OverlapMode} -```lua -{ - OVERLAP_MODE_ALL: integer = 0, - OVERLAP_MODE_CYCLED: integer = 1, - OVERLAP_MODE_RANDOM: integer = 2, -} -``` -### Tab {#Tab} -```lua -{ - TAB_SAMPLES: integer = 1, - TAB_PLUGIN: integer = 2, - TAB_EXT_MIDI: integer = 3, -} -``` ### PhrasePlaybackMode {#PhrasePlaybackMode} ```lua { @@ -32,6 +16,22 @@ LAYER_NOTE_OFF: integer = 2, } ``` +### OverlapMode {#OverlapMode} +```lua +{ + OVERLAP_MODE_ALL: integer = 0, + OVERLAP_MODE_CYCLED: integer = 1, + OVERLAP_MODE_RANDOM: integer = 2, +} +``` +### Tab {#Tab} +```lua +{ + TAB_SAMPLES: integer = 1, + TAB_PLUGIN: integer = 2, + TAB_EXT_MIDI: integer = 3, +} +``` --- @@ -41,103 +41,103 @@ ### active_tab : [`renoise.Instrument.Tab`](renoise.Instrument.md#Tab) {#active_tab} Currently active tab in the instrument GUI (samples, plugin or MIDI). -### active_tab_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#active_tab_observable} -### channel_pressure_macro : [`renoise.InstrumentMacro`](/API/renoise.InstrumentMacro.md) {#channel_pressure_macro} +### active_tab_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#active_tab_observable} +### channel_pressure_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) {#channel_pressure_macro} Access the MIDI channel pressure macro ### comments : [`string`](/API/builtins/string.md)`[]` {#comments} Instrument's comment list. See renoise.song().comments for more info on how to get notified on changes and how to change it. -### comments_assignment_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#comments_assignment_observable} +### comments_assignment_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#comments_assignment_observable} Notifier which is called as soon as any paragraph in the comments change. -### comments_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#comments_observable} -### macros : [`renoise.InstrumentMacro`](/API/renoise.InstrumentMacro.md)`[]` {#macros} +### comments_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#comments_observable} +### macros : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md)`[]` {#macros} **READ-ONLY** Macro parameters. Array with size Instrument.NUMBER_OF_MACROS. ### macros_visible : [`boolean`](/API/builtins/boolean.md) {#macros_visible} Macro parameter pane visibility in the GUI. -### macros_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#macros_visible_observable} -### midi_input_properties : [`renoise.InstrumentMidiInputProperties`](/API/renoise.InstrumentMidiInputProperties.md) {#midi_input_properties} +### macros_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#macros_visible_observable} +### midi_input_properties : [`renoise.InstrumentMidiInputProperties`](/API/renoise/renoise.InstrumentMidiInputProperties.md) {#midi_input_properties} **READ-ONLY** MIDI input properties. -### midi_output_properties : [`renoise.InstrumentMidiOutputProperties`](/API/renoise.InstrumentMidiOutputProperties.md) {#midi_output_properties} +### midi_output_properties : [`renoise.InstrumentMidiOutputProperties`](/API/renoise/renoise.InstrumentMidiOutputProperties.md) {#midi_output_properties} **READ-ONLY** MIDI output properties. -### modulation_wheel_macro : [`renoise.InstrumentMacro`](/API/renoise.InstrumentMacro.md) {#modulation_wheel_macro} +### modulation_wheel_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) {#modulation_wheel_macro} Access the MIDI modulation-wheel macro ### name : [`string`](/API/builtins/string.md) {#name} Instrument's name. -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### phrase_editor_visible : [`boolean`](/API/builtins/boolean.md) {#phrase_editor_visible} Phrase editor pane visibility in the GUI. -### phrase_editor_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#phrase_editor_visible_observable} -### phrase_mappings : [`renoise.InstrumentPhraseMapping`](/API/renoise.InstrumentPhraseMapping.md)`[]` {#phrase_mappings} +### phrase_editor_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#phrase_editor_visible_observable} +### phrase_mappings : [`renoise.InstrumentPhraseMapping`](/API/renoise/renoise.InstrumentPhraseMapping.md)`[]` {#phrase_mappings} **READ-ONLY** Phrase mappings. -### phrase_mappings_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#phrase_mappings_observable} +### phrase_mappings_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#phrase_mappings_observable} ### phrase_playback_mode : [`renoise.Instrument.PhrasePlaybackMode`](renoise.Instrument.md#PhrasePlaybackMode) {#phrase_playback_mode} Phrase playback. -### phrase_playback_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#phrase_playback_mode_observable} +### phrase_playback_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#phrase_playback_mode_observable} ### phrase_program : [`integer`](/API/builtins/integer.md) {#phrase_program} Phrase playback program: 0 = Off, 1-126 = specific phrase, 127 = keymap. -### phrase_program_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#phrase_program_observable} -### phrases : [`renoise.InstrumentPhrase`](/API/renoise.InstrumentPhrase.md)`[]` {#phrases} +### phrase_program_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#phrase_program_observable} +### phrases : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md)`[]` {#phrases} **READ-ONLY** Phrases. -### phrases_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#phrases_observable} -### pitchbend_macro : [`renoise.InstrumentMacro`](/API/renoise.InstrumentMacro.md) {#pitchbend_macro} +### phrases_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#phrases_observable} +### pitchbend_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) {#pitchbend_macro} Access the MIDI pitch-bend macro -### plugin_properties : [`renoise.InstrumentPluginProperties`](/API/renoise.InstrumentPluginProperties.md) {#plugin_properties} +### plugin_properties : [`renoise.InstrumentPluginProperties`](/API/renoise/renoise.InstrumentPluginProperties.md) {#plugin_properties} **READ-ONLY** Plugin properties. -### sample_device_chains : [`renoise.SampleDeviceChain`](/API/renoise.SampleDeviceChain.md)`[]` {#sample_device_chains} +### sample_device_chains : [`renoise.SampleDeviceChain`](/API/renoise/renoise.SampleDeviceChain.md)`[]` {#sample_device_chains} **READ-ONLY** Sample device chains. -### sample_device_chains_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#sample_device_chains_observable} +### sample_device_chains_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#sample_device_chains_observable} ### sample_mapping_overlap_mode : [`renoise.Instrument.OverlapMode`](renoise.Instrument.md#OverlapMode) {#sample_mapping_overlap_mode} Sample mapping's overlap trigger mode. -### sample_mapping_overlap_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#sample_mapping_overlap_mode_observable} -### sample_mappings : [`renoise.SampleMapping`](/API/renoise.SampleMapping.md)`[]` {#sample_mappings} +### sample_mapping_overlap_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sample_mapping_overlap_mode_observable} +### sample_mappings : [`renoise.SampleMapping`](/API/renoise/renoise.SampleMapping.md)`[]` {#sample_mappings} **READ-ONLY** Sample mappings (key/velocity to sample slot mappings). sample_mappings[LAYER_NOTE_ON/OFF][]. Sample mappings also can be accessed via ---@field samples[].sample_mapping -### sample_mappings_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#sample_mappings_observable} -### sample_modulation_sets : [`renoise.SampleModulationSet`](/API/renoise.SampleModulationSet.md)`[]` {#sample_modulation_sets} +### sample_mappings_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#sample_mappings_observable} +### sample_modulation_sets : [`renoise.SampleModulationSet`](/API/renoise/renoise.SampleModulationSet.md)`[]` {#sample_modulation_sets} **READ-ONLY** Sample modulation sets. -### sample_modulation_sets_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#sample_modulation_sets_observable} -### samples : [`renoise.Sample`](/API/renoise.Sample.md)`[]` {#samples} +### sample_modulation_sets_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#sample_modulation_sets_observable} +### samples : [`renoise.Sample`](/API/renoise/renoise.Sample.md)`[]` {#samples} **READ-ONLY** Samples slots. -### samples_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#samples_observable} +### samples_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#samples_observable} ### show_comments_after_loading : [`boolean`](/API/builtins/boolean.md) {#show_comments_after_loading} Set this to true to show the comments dialog after loading a song -### show_comments_after_loading_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#show_comments_after_loading_observable} +### show_comments_after_loading_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#show_comments_after_loading_observable} ### transpose : [`integer`](/API/builtins/integer.md) {#transpose} Range: (-120 - 120). Global relative pitch in semi tones. Applied to all samples, MIDI and plugins in the instrument. -### transpose_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#transpose_observable} -### trigger_options : [`renoise.InstrumentTriggerOptions`](/API/renoise.InstrumentTriggerOptions.md) {#trigger_options} +### transpose_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#transpose_observable} +### trigger_options : [`renoise.InstrumentTriggerOptions`](/API/renoise/renoise.InstrumentTriggerOptions.md) {#trigger_options} Global trigger options (quantization and scaling options). ### volume : [`number`](/API/builtins/number.md) {#volume} Range: (0 - math.db2lin(6)) -### volume_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#volume_observable} +### volume_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_observable} --- @@ -154,7 +154,7 @@ a single key only. To make up room for new phrases, access phrases by index, adjust their note_range, then call 'insert_phrase_mapping_at' again. ### `clear`([*self*](/API/builtins/self.md)) {#clear} Reset, clear all settings and all samples. -### `copy_from`([*self*](/API/builtins/self.md), instrument : [`renoise.Instrument`](/API/renoise.Instrument.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), instrument : [`renoise.Instrument`](/API/renoise/renoise.Instrument.md)) {#copy_from} Copy all settings from the other instrument, including all samples. ### `delete_phrase_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_phrase_at} Delete a new phrase at the given phrase index. @@ -167,64 +167,64 @@ Delete an existing sample device chain at the given index. ### `delete_sample_modulation_set_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_sample_modulation_set_at} Delete an existing modulation set at the given index. ### `insert_phrase_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#insert_phrase_at} -`->`new_phrase : [`renoise.InstrumentPhrase`](/API/renoise.InstrumentPhrase.md) +`->`new_phrase : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md) Insert a new phrase behind the given phrase index (1 for the first one). -### `insert_phrase_mapping_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md), phrase : [`renoise.InstrumentPhrase`](/API/renoise.InstrumentPhrase.md)) {#insert_phrase_mapping_at} -`->`new_mapping : [`renoise.InstrumentPhraseMapping`](/API/renoise.InstrumentPhraseMapping.md) +### `insert_phrase_mapping_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md), phrase : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md)) {#insert_phrase_mapping_at} +`->`new_mapping : [`renoise.InstrumentPhraseMapping`](/API/renoise/renoise.InstrumentPhraseMapping.md) Insert a new phrase mapping behind the given phrase mapping index. The new phrase mapping will by default use the entire free (note) range between the previous and next phrase (if any). To adjust the note range of the new phrase change its 'new_phrase_mapping.note_range' property. ### `insert_sample_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#insert_sample_at} -`->`new_sample : [`renoise.Sample`](/API/renoise.Sample.md) +`->`new_sample : [`renoise.Sample`](/API/renoise/renoise.Sample.md) Insert a new empty sample. returns the new renoise.Sample object. Every newly inserted sample has a default mapping, which covers the entire key and velocity range, or it gets added as drum kit mapping when the instrument used a drum-kit mapping before the sample got added. ### `insert_sample_device_chain_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#insert_sample_device_chain_at} -`->`new_sample_device_chain : [`renoise.SampleDeviceChain`](/API/renoise.SampleDeviceChain.md) +`->`new_sample_device_chain : [`renoise.SampleDeviceChain`](/API/renoise/renoise.SampleDeviceChain.md) Insert a new sample device chain at the given index. ### `insert_sample_modulation_set_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#insert_sample_modulation_set_at} -`->`new_sample_modulation_set : [`renoise.SampleModulationSet`](/API/renoise.SampleModulationSet.md) +`->`new_sample_modulation_set : [`renoise.SampleModulationSet`](/API/renoise/renoise.SampleModulationSet.md) Insert a new modulation set at the given index ### `macro`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#macro} -`->`instrument_macro : [`renoise.InstrumentMacro`](/API/renoise.InstrumentMacro.md) +`->`instrument_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) Range: (1 - renoise.Instrument.NUMBER_OF_MACROS) Access a single macro by index. See also property `macros`. ### `phrase`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#phrase} -`->`[`renoise.InstrumentPhrase`](/API/renoise.InstrumentPhrase.md) +`->`[`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md) Access a single phrase by index. Use properties 'phrases' to iterate over all phrases and to query the phrase count. ### `phrase_mapping`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#phrase_mapping} -`->`[`renoise.InstrumentPhraseMapping`](/API/renoise.InstrumentPhraseMapping.md) +`->`[`renoise.InstrumentPhraseMapping`](/API/renoise/renoise.InstrumentPhraseMapping.md) Access to a phrase note mapping by index. Use property 'phrase_mappings' to iterate over all phrase mappings and to query the phrase (mapping) count. ### `sample`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#sample} -`->`[`renoise.Sample`](/API/renoise.Sample.md) +`->`[`renoise.Sample`](/API/renoise/renoise.Sample.md) Access to a single sample by index. Use properties 'samples' to iterate over all samples and to query the sample count. ### `sample_device_chain`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#sample_device_chain} -`->`[`renoise.SampleDeviceChain`](/API/renoise.SampleDeviceChain.md) +`->`[`renoise.SampleDeviceChain`](/API/renoise/renoise.SampleDeviceChain.md) Access to a single device chain by index. Use property 'sample_device_chains' to iterate over all chains and to query the chain count. ### `sample_mapping`([*self*](/API/builtins/self.md), layer : [`renoise.Instrument.Layer`](renoise.Instrument.md#Layer), index : [`integer`](/API/builtins/integer.md)) {#sample_mapping} -`->`[`renoise.SampleMapping`](/API/renoise.SampleMapping.md) +`->`[`renoise.SampleMapping`](/API/renoise/renoise.SampleMapping.md) Access to a sample mapping by index. Use property 'sample_mappings' to iterate over all sample mappings and to query the sample (mapping) count. ### `sample_modulation_set`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#sample_modulation_set} -`->`[`renoise.SampleModulationSet`](/API/renoise.SampleModulationSet.md) +`->`[`renoise.SampleModulationSet`](/API/renoise/renoise.SampleModulationSet.md) Access to a single sample modulation set by index. Use property 'sample_modulation_sets' to iterate over all sets and to query the set count. diff --git a/docs/API/renoise.InstrumentDevice.md b/docs/API/renoise/renoise.InstrumentDevice.md similarity index 100% rename from docs/API/renoise.InstrumentDevice.md rename to docs/API/renoise/renoise.InstrumentDevice.md diff --git a/docs/API/renoise.InstrumentMacro.md b/docs/API/renoise/renoise.InstrumentMacro.md similarity index 65% rename from docs/API/renoise.InstrumentMacro.md rename to docs/API/renoise/renoise.InstrumentMacro.md index 583e0bb3..0efa0a60 100644 --- a/docs/API/renoise.InstrumentMacro.md +++ b/docs/API/renoise/renoise.InstrumentMacro.md @@ -2,28 +2,28 @@ --- ## Properties -### mappings : [`renoise.InstrumentMacroMapping`](/API/renoise.InstrumentMacroMapping.md)`[]` {#mappings} +### mappings : [`renoise.InstrumentMacroMapping`](/API/renoise/renoise.InstrumentMacroMapping.md)`[]` {#mappings} **READ-ONLY** Macro mappings, target parameters -### mappings_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#mappings_observable} +### mappings_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#mappings_observable} ### name : [`string`](/API/builtins/string.md) {#name} Macro name as visible in the GUI when mappings are presents. -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### value : [`number`](/API/builtins/number.md) {#value} Range: (0 - 1) -### value_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#value_observable} +### value_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#value_observable} ### value_string : [`string`](/API/builtins/string.md) {#value_string} Range: (0 - 100) -### value_string_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#value_string_observable} +### value_string_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#value_string_observable} --- ## Functions ### `mapping`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#mapping} -`->`[`renoise.InstrumentMacroMapping`](/API/renoise.InstrumentMacroMapping.md) +`->`[`renoise.InstrumentMacroMapping`](/API/renoise/renoise.InstrumentMacroMapping.md) Access to a single attached parameter mapping by index. Use property 'mappings' to query mapping count. diff --git a/docs/API/renoise.InstrumentMacroMapping.md b/docs/API/renoise/renoise.InstrumentMacroMapping.md similarity index 75% rename from docs/API/renoise.InstrumentMacroMapping.md rename to docs/API/renoise/renoise.InstrumentMacroMapping.md index e3ed0e8e..abe64c9f 100644 --- a/docs/API/renoise.InstrumentMacroMapping.md +++ b/docs/API/renoise/renoise.InstrumentMacroMapping.md @@ -14,21 +14,21 @@ --- ## Properties -### parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#parameter} +### parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#parameter} **READ-ONLY** Linked parameter. Can be a sample FX- or modulation parameter. Never nil. ### parameter_max : [`number`](/API/builtins/number.md) {#parameter_max} Range: (0 - 1) -### parameter_max_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#parameter_max_observable} +### parameter_max_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#parameter_max_observable} ### parameter_min : [`number`](/API/builtins/number.md) {#parameter_min} Range: (0 - 1) -### parameter_min_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#parameter_min_observable} +### parameter_min_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#parameter_min_observable} ### parameter_scaling : [`renoise.InstrumentMacroMapping.Scaling`](renoise.InstrumentMacroMapping.md#Scaling) {#parameter_scaling} Scaling which gets applied within the min/max range to set the dest value. -### parameter_scaling_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#parameter_scaling_observable} +### parameter_scaling_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#parameter_scaling_observable} diff --git a/docs/API/renoise.InstrumentMidiInputProperties.md b/docs/API/renoise/renoise.InstrumentMidiInputProperties.md similarity index 78% rename from docs/API/renoise.InstrumentMidiInputProperties.md rename to docs/API/renoise/renoise.InstrumentMidiInputProperties.md index 82ddf0ab..efea1cc7 100644 --- a/docs/API/renoise.InstrumentMidiInputProperties.md +++ b/docs/API/renoise/renoise.InstrumentMidiInputProperties.md @@ -5,21 +5,21 @@ ### assigned_track : [`integer`](/API/builtins/integer.md) {#assigned_track} Range: (1 - song.sequencer_track_count) 0 = Current track -### assigned_track_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#assigned_track_observable} +### assigned_track_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#assigned_track_observable} ### channel : [`integer`](/API/builtins/integer.md) {#channel} Range: (1 - 16) 0 = Omni -### channel_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#channel_observable} +### channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#channel_observable} ### device_name : [`string`](/API/builtins/string.md) {#device_name} When setting new devices, device names must be one of renoise.Midi.available_input_devices. Devices are automatically opened when needed. To close a device, set its name to "", e.g. an empty string. -### device_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#device_name_observable} +### device_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#device_name_observable} ### note_range : [`integer`](/API/builtins/integer.md)`[]` {#note_range} Table of two numbers in range (0-119) where C-4 is 48 -### note_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#note_range_observable} +### note_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#note_range_observable} diff --git a/docs/API/renoise.InstrumentMidiOutputProperties.md b/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md similarity index 79% rename from docs/API/renoise.InstrumentMidiOutputProperties.md rename to docs/API/renoise/renoise.InstrumentMidiOutputProperties.md index 45ad1ac2..cdf272b7 100644 --- a/docs/API/renoise.InstrumentMidiOutputProperties.md +++ b/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md @@ -15,40 +15,40 @@ ### bank : [`integer`](/API/builtins/integer.md) {#bank} Range: (1 - 65536) 0 = OFF -### bank_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bank_observable} +### bank_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bank_observable} ### channel : [`integer`](/API/builtins/integer.md) {#channel} Range: (1 - 16) -### channel_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#channel_observable} +### channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#channel_observable} ### delay : [`integer`](/API/builtins/integer.md) {#delay} Range: (0 - 100) -### delay_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#delay_observable} +### delay_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_observable} ### device_name : [`string`](/API/builtins/string.md) {#device_name} When setting new devices, device names must be one of: renoise.Midi.available_output_devices. Devices are automatically opened when needed. To close a device, set its name to "", e.g. an empty string. -### device_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#device_name_observable} +### device_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#device_name_observable} ### duration : [`integer`](/API/builtins/integer.md) {#duration} Range: (1 - 8000) 8000 = INF -### duration_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#duration_observable} +### duration_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#duration_observable} ### instrument_type : [`renoise.InstrumentMidiOutputProperties.Type`](renoise.InstrumentMidiOutputProperties.md#Type) {#instrument_type} Note: ReWire device always start with "ReWire: " in the device_name and will always ignore the instrument_type and channel properties. MIDI channels are not configurable for ReWire MIDI, and instrument_type will always be "TYPE_INTERNAL" for ReWire devices. -### instrument_type_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#instrument_type_observable} +### instrument_type_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#instrument_type_observable} ### program : [`integer`](/API/builtins/integer.md) {#program} Range: (1 - 128) 0 = OFF -### program_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#program_observable} +### program_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#program_observable} ### transpose : [`integer`](/API/builtins/integer.md) {#transpose} Range: (-120 - 120) -### transpose_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#transpose_observable} +### transpose_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#transpose_observable} diff --git a/docs/API/renoise.InstrumentPhrase.md b/docs/API/renoise/renoise.InstrumentPhrase.md similarity index 71% rename from docs/API/renoise.InstrumentPhrase.md rename to docs/API/renoise/renoise.InstrumentPhrase.md index 3f43996a..f18a3089 100644 --- a/docs/API/renoise.InstrumentPhrase.md +++ b/docs/API/renoise/renoise.InstrumentPhrase.md @@ -29,90 +29,90 @@ Min/Maximum number of note columns that can be present in a phrase. ### autoseek : [`boolean`](/API/builtins/boolean.md) {#autoseek} Phrase autoseek settings -### autoseek_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#autoseek_observable} +### autoseek_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#autoseek_observable} ### base_note : [`integer`](/API/builtins/integer.md) {#base_note} Range: (0 - 119) where C-4 is 48 Phrase's base-note. Only relevant when key_tracking is set to transpose. -### base_note_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#base_note_observable} +### base_note_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#base_note_observable} ### delay_column_visible : [`boolean`](/API/builtins/boolean.md) {#delay_column_visible} -### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#delay_column_visible_observable} +### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} ### instrument_column_visible : [`boolean`](/API/builtins/boolean.md) {#instrument_column_visible} Column visibility. -### instrument_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#instrument_column_visible_observable} +### instrument_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#instrument_column_visible_observable} ### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} **READ-ONLY** Quickly check if a phrase has some non empty pattern lines. -### is_empty_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_empty_observable} +### is_empty_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_empty_observable} ### key_tracking : [`renoise.InstrumentPhrase.KeyTrackingMode`](renoise.InstrumentPhrase.md#KeyTrackingMode) {#key_tracking} Phrase's key-tracking mode. -### key_tracking_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#key_tracking_observable} -### lines : [`renoise.PatternLine`](/API/renoise.PatternLine.md)`[]` {#lines} +### key_tracking_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#key_tracking_observable} +### lines : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)`[]` {#lines} **READ-ONLY** Get all lines in a range [1, number_of_lines_in_pattern] ### loop_end : [`integer`](/API/builtins/integer.md) {#loop_end} Range: (loop_start - number_of_lines) Loop end. Needs to be > loop_start and <= number_of_lines -### loop_end_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_end_observable} ### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} Range: (1 - number_of_lines) Loop start. Playback will start from the beginning before entering loop -### loop_start_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_start_observable} ### looping : [`boolean`](/API/builtins/boolean.md) {#looping} Loop mode. The phrase plays as one-shot when disabled. -### looping_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#looping_observable} +### looping_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#looping_observable} ### lpb : [`integer`](/API/builtins/integer.md) {#lpb} Range: (1 - 256) Phrase local lines per beat setting. New phrases get initialized with the song's current LPB setting. TPL can not be configured in phrases. -### lpb_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#lpb_observable} -### mapping : [`renoise.InstrumentPhraseMapping`](/API/renoise.InstrumentPhraseMapping.md) {#mapping} +### lpb_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#lpb_observable} +### mapping : [`renoise.InstrumentPhraseMapping`](/API/renoise/renoise.InstrumentPhraseMapping.md) {#mapping} (Key)Mapping properties of the phrase or nil when no mapping is present. ### name : [`string`](/API/builtins/string.md) {#name} Name of the phrase as visible in the phrase editor and piano mappings. -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### number_of_lines : [`integer`](/API/builtins/integer.md) {#number_of_lines} Default: 16, Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_LINES) Number of lines the phrase currently has. -### number_of_lines_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#number_of_lines_observable} +### number_of_lines_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#number_of_lines_observable} ### panning_column_visible : [`boolean`](/API/builtins/boolean.md) {#panning_column_visible} -### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#panning_column_visible_observable} +### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} ### sample_effects_column_visible : [`boolean`](/API/builtins/boolean.md) {#sample_effects_column_visible} -### sample_effects_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} +### sample_effects_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} ### shuffle : [`number`](/API/builtins/number.md) {#shuffle} Range: (0 - 1) Shuffle groove amount for a phrase. 0.0 = no shuffle (off), 1.0 = full shuffle -### shuffle_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#shuffle_observable} +### shuffle_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#shuffle_observable} ### visible_effect_columns : [`integer`](/API/builtins/integer.md) {#visible_effect_columns} Range: (MIN_NUMBER_OF_EFFECT_COLUMNS - MAX_NUMBER_OF_EFFECT_COLUMNS) How many effect columns are visible in the phrase. -### visible_effect_columns_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#visible_effect_columns_observable} +### visible_effect_columns_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#visible_effect_columns_observable} ### visible_note_columns : [`integer`](/API/builtins/integer.md) {#visible_note_columns} Range: (MIN_NUMBER_OF_NOTE_COLUMNS - MAX_NUMBER_OF_NOTE_COLUMNS) How many note columns are visible in the phrase. -### visible_note_columns_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#visible_note_columns_observable} +### visible_note_columns_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#visible_note_columns_observable} ### volume_column_visible : [`boolean`](/API/builtins/boolean.md) {#volume_column_visible} -### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#volume_column_visible_observable} +### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} --- ## Functions -### `add_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](/API/aliases/PhraseLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_edited_notifier} -### `add_line_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](/API/aliases/PhraseLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_notifier} +### `add_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_edited_notifier} +### `add_line_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_notifier} ### `clear`([*self*](/API/builtins/self.md)) {#clear} Deletes all lines. ### `column_is_muted`([*self*](/API/builtins/self.md), column : [`integer`](/API/builtins/integer.md)) {#column_is_muted} @@ -120,42 +120,42 @@ Deletes all lines. Note column mute states. ### `column_is_muted_observable`([*self*](/API/builtins/self.md), column : [`integer`](/API/builtins/integer.md)) {#column_is_muted_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) ### `column_name`([*self*](/API/builtins/self.md), column : [`integer`](/API/builtins/integer.md)) {#column_name} `->`[`string`](/API/builtins/string.md) Note column names. ### `column_name_observable`([*self*](/API/builtins/self.md), column : [`integer`](/API/builtins/integer.md)) {#column_name_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) -### `copy_from`([*self*](/API/builtins/self.md), phrase : [`renoise.InstrumentPhrase`](/API/renoise.InstrumentPhrase.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), phrase : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md)) {#copy_from} Copy contents from another phrase. -### `has_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](/API/aliases/PhraseLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_edited_notifier} +### `has_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_edited_notifier} `->`[`boolean`](/API/builtins/boolean.md) Same as line_notifier above, but the notifier only fires when the user added, changed or deleted a line with the computer keyboard. See: ~renoise.Pattern.has_line_editoed_notifier~ for more details. -### `has_line_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](/API/aliases/PhraseLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_notifier} +### `has_line_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_notifier} `->`[`boolean`](/API/builtins/boolean.md) Check/add/remove notifier functions or methods, which are called by Renoise as soon as any of the phrases's lines have changed. See: ~renoise.Pattern.has_line_notifier~ for more details. ### `line`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#line} -`->`[`renoise.PatternLine`](/API/renoise.PatternLine.md) +`->`[`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md) Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_LINES) Access to a single line by index. Line must be in Range: (1 - MAX_NUMBER_OF_LINES). This is a !lot! more efficient than calling the property: lines[index] to randomly access lines. ### `lines_in_range`([*self*](/API/builtins/self.md), index_from : [`integer`](/API/builtins/integer.md), index_to : [`integer`](/API/builtins/integer.md)) {#lines_in_range} -`->`[`renoise.PatternLine`](/API/renoise.PatternLine.md)`[]` +`->`[`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)`[]` Get a specific line range -### `remove_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](/API/aliases/PhraseLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_edited_notifier} -### `remove_line_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](/API/aliases/PhraseLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_notifier} +### `remove_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_edited_notifier} +### `remove_line_notifier`([*self*](/API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_notifier} ### `set_column_is_muted`([*self*](/API/builtins/self.md), column : [`integer`](/API/builtins/integer.md), muted : [`boolean`](/API/builtins/boolean.md)) {#set_column_is_muted} ### `set_column_name`([*self*](/API/builtins/self.md), column : [`integer`](/API/builtins/integer.md), name : [`string`](/API/builtins/string.md)) {#set_column_name} ### `swap_effect_columns_at`([*self*](/API/builtins/self.md), index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md)) {#swap_effect_columns_at} @@ -163,3 +163,11 @@ Swap the positions of two effect columns within a phrase. ### `swap_note_columns_at`([*self*](/API/builtins/self.md), index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md)) {#swap_note_columns_at} Swap the positions of two note columns within a phrase. + + +--- +## Aliases +# alias PhraseLineChangeCallbackWithContext {#PhraseLineChangeCallbackWithContext} +(obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md), pos : [`PhraseLinePosition`](/API/structs/PhraseLinePosition.md)) + + diff --git a/docs/API/renoise.InstrumentPhraseMapping.md b/docs/API/renoise/renoise.InstrumentPhraseMapping.md similarity index 72% rename from docs/API/renoise.InstrumentPhraseMapping.md rename to docs/API/renoise/renoise.InstrumentPhraseMapping.md index 69241b75..7b18fd38 100644 --- a/docs/API/renoise.InstrumentPhraseMapping.md +++ b/docs/API/renoise/renoise.InstrumentPhraseMapping.md @@ -15,24 +15,24 @@ ### base_note : [`integer`](/API/builtins/integer.md) {#base_note} Range: (0 - 119) where C-4 is 48 -### base_note_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#base_note_observable} +### base_note_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#base_note_observable} ### key_tracking : [`renoise.InstrumentPhraseMapping.KeyTrackingMode`](renoise.InstrumentPhraseMapping.md#KeyTrackingMode) {#key_tracking} Phrase's key-tracking mode. -### key_tracking_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#key_tracking_observable} +### key_tracking_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#key_tracking_observable} ### loop_end : [`integer`](/API/builtins/integer.md) {#loop_end} -### loop_end_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_end_observable} ### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} -### loop_start_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_start_observable} ### looping : [`boolean`](/API/builtins/boolean.md) {#looping} Loop mode. The phrase plays as one-shot when disabled. -### looping_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#looping_observable} +### looping_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#looping_observable} ### note_range : [`integer`](/API/builtins/integer.md)`[]` {#note_range} Range: (0 - 119) where C-4 is 48 -### note_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#note_range_observable} -### phrase : [`renoise.InstrumentPhrase`](/API/renoise.InstrumentPhrase.md) {#phrase} +### note_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#note_range_observable} +### phrase : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md) {#phrase} Linked phrase. diff --git a/docs/API/renoise.InstrumentPluginDevice.md b/docs/API/renoise/renoise.InstrumentPluginDevice.md similarity index 87% rename from docs/API/renoise.InstrumentPluginDevice.md rename to docs/API/renoise/renoise.InstrumentPluginDevice.md index 9ae62d00..623ff6cd 100644 --- a/docs/API/renoise.InstrumentPluginDevice.md +++ b/docs/API/renoise/renoise.InstrumentPluginDevice.md @@ -8,7 +8,7 @@ Preset handling. 0 when when none is active (or available) ### active_preset_data : [`string`](/API/builtins/string.md) {#active_preset_data} raw XML data of the active preset -### active_preset_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#active_preset_observable} +### active_preset_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#active_preset_observable} ### device_path : [`string`](/API/builtins/string.md) {#device_path} **READ-ONLY** Returns a string that uniquely identifies the plugin The string can be passed into: renoise.InstrumentPluginProperties:load_plugin() @@ -24,7 +24,7 @@ set to true to show the editor, false to close it ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Device name. -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### presets : [`string`](/API/builtins/string.md)`[]` {#presets} @@ -38,7 +38,7 @@ set to true to show the editor, false to close it --- ## Functions ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.InstrumentPluginProperties.md b/docs/API/renoise/renoise.InstrumentPluginProperties.md similarity index 74% rename from docs/API/renoise.InstrumentPluginProperties.md rename to docs/API/renoise/renoise.InstrumentPluginProperties.md index d2cb3020..221c4bfb 100644 --- a/docs/API/renoise.InstrumentPluginProperties.md +++ b/docs/API/renoise/renoise.InstrumentPluginProperties.md @@ -5,19 +5,19 @@ ### alias_fx_device_index : [`integer`](/API/builtins/integer.md) {#alias_fx_device_index} **READ-ONLY** 0 when no alias FX is set -### alias_fx_device_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#alias_fx_device_index_observable} +### alias_fx_device_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#alias_fx_device_index_observable} ### alias_fx_track_index : [`integer`](/API/builtins/integer.md) {#alias_fx_track_index} **READ-ONLY** 0 when no alias FX is set -### alias_fx_track_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#alias_fx_track_index_observable} +### alias_fx_track_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#alias_fx_track_index_observable} ### alias_instrument_index : [`integer`](/API/builtins/integer.md) {#alias_instrument_index} 0 when no alias instrument is set -### alias_instrument_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#alias_instrument_index_observable} +### alias_instrument_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#alias_instrument_index_observable} ### auto_suspend : [`boolean`](/API/builtins/boolean.md) {#auto_suspend} Valid for loaded and unloaded plugins. -### auto_suspend_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#auto_suspend_observable} +### auto_suspend_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#auto_suspend_observable} ### available_plugin_infos : [`PluginInfo`](/API/structs/PluginInfo.md)`[]` {#available_plugin_infos} **READ-ONLY** Returns a list of tables containing more information about the plugins. @@ -31,29 +31,29 @@ the identifier is an empty string. ### channel : [`integer`](/API/builtins/integer.md) {#channel} Range: (1 - 16) -### channel_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#channel_observable} +### channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#channel_observable} ### midi_output_routing_index : [`integer`](/API/builtins/integer.md) {#midi_output_routing_index} 0 when no routing is set -### midi_output_routing_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#midi_output_routing_index_observable} -### plugin_device : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md) | [`renoise.InstrumentPluginDevice`](/API/renoise.InstrumentPluginDevice.md) {#plugin_device} +### midi_output_routing_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#midi_output_routing_index_observable} +### plugin_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) | [`renoise.InstrumentPluginDevice`](/API/renoise/renoise.InstrumentPluginDevice.md) {#plugin_device} Valid object for successfully loaded plugins, otherwise nil. Alias plugin instruments of FX will return the resolved device, will link to the device the alias points to. The observable is fired when the device changes: when a plugin gets loaded or unloaded or a plugin alias is assigned or unassigned. -### plugin_device_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#plugin_device_observable} +### plugin_device_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#plugin_device_observable} ### plugin_loaded : [`boolean`](/API/builtins/boolean.md) {#plugin_loaded} **READ-ONLY** Returns true when a plugin is present; loaded successfully. ### transpose : [`integer`](/API/builtins/integer.md) {#transpose} Range: (-120 - 120) -### transpose_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#transpose_observable} +### transpose_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#transpose_observable} ### volume : [`number`](/API/builtins/number.md) {#volume} Range: (0.0 - 4.0) linear gain -### volume_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#volume_observable} +### volume_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_observable} diff --git a/docs/API/renoise.InstrumentTriggerOptions.md b/docs/API/renoise/renoise.InstrumentTriggerOptions.md similarity index 79% rename from docs/API/renoise.InstrumentTriggerOptions.md rename to docs/API/renoise/renoise.InstrumentTriggerOptions.md index de4c7197..8e1ef887 100644 --- a/docs/API/renoise.InstrumentTriggerOptions.md +++ b/docs/API/renoise/renoise.InstrumentTriggerOptions.md @@ -22,19 +22,19 @@ Mono/Poly mode. ### monophonic_glide : [`integer`](/API/builtins/integer.md) {#monophonic_glide} Glide amount when monophonic. 0 == off, 255 = instant -### monophonic_glide_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#monophonic_glide_observable} -### monophonic_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#monophonic_observable} +### monophonic_glide_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#monophonic_glide_observable} +### monophonic_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#monophonic_observable} ### quantize : [`renoise.InstrumentTriggerOptions.QuantizeMode`](renoise.InstrumentTriggerOptions.md#QuantizeMode) {#quantize} Trigger quantization mode. -### quantize_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#quantize_observable} +### quantize_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#quantize_observable} ### scale_key : [`integer`](/API/builtins/integer.md) {#scale_key} Scale-key to use when transposing (1=C, 2=C#, 3=D, ...) -### scale_key_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#scale_key_observable} +### scale_key_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#scale_key_observable} ### scale_mode : [`string`](/API/builtins/string.md) {#scale_mode} one of 'available_scales'] -### scale_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#scale_mode_observable} +### scale_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#scale_mode_observable} diff --git a/docs/API/renoise.Midi.MidiDevice.md b/docs/API/renoise/renoise.Midi.MidiDevice.md similarity index 100% rename from docs/API/renoise.Midi.MidiDevice.md rename to docs/API/renoise/renoise.Midi.MidiDevice.md diff --git a/docs/API/renoise.Midi.MidiInputDevice.md b/docs/API/renoise/renoise.Midi.MidiInputDevice.md similarity index 100% rename from docs/API/renoise.Midi.MidiInputDevice.md rename to docs/API/renoise/renoise.Midi.MidiInputDevice.md diff --git a/docs/API/renoise.Midi.MidiOutputDevice.md b/docs/API/renoise/renoise.Midi.MidiOutputDevice.md similarity index 100% rename from docs/API/renoise.Midi.MidiOutputDevice.md rename to docs/API/renoise/renoise.Midi.MidiOutputDevice.md diff --git a/docs/API/renoise.Midi.md b/docs/API/renoise/renoise.Midi.md similarity index 77% rename from docs/API/renoise.Midi.md rename to docs/API/renoise/renoise.Midi.md index 67eea47d..874f9e83 100644 --- a/docs/API/renoise.Midi.md +++ b/docs/API/renoise/renoise.Midi.md @@ -14,8 +14,8 @@ See `renoise.Midi.devices_changed_observable` Return a list of strings with currently available MIDI output devices. This list can change when devices are hot-plugged. See `renoise.Midi.devices_changed_observable` -### `create_input_device`(device_name : [`string`](/API/builtins/string.md), callback : [`MidiMessageFunction`](/API/aliases/MidiMessageFunction.md) | [`MidiMessageMethod1`](/API/aliases/MidiMessageMethod1.md) | [`MidiMessageMethod2`](/API/aliases/MidiMessageMethod2.md)[`?`](/API/builtins/nil.md), sysex_callback : [`MidiMessageFunction`](/API/aliases/MidiMessageFunction.md) | [`MidiMessageMethod1`](/API/aliases/MidiMessageMethod1.md) | [`MidiMessageMethod2`](/API/aliases/MidiMessageMethod2.md)[`?`](/API/builtins/nil.md)) {#create_input_device} -`->`[`renoise.Midi.MidiInputDevice`](/API/renoise.Midi.MidiInputDevice.md) +### `create_input_device`(device_name : [`string`](/API/builtins/string.md), callback : [`MidiMessageFunction`](#MidiMessageFunction) | [`MidiMessageMethod1`](#MidiMessageMethod1) | [`MidiMessageMethod2`](#MidiMessageMethod2)[`?`](/API/builtins/nil.md), sysex_callback : [`MidiMessageFunction`](#MidiMessageFunction) | [`MidiMessageMethod1`](#MidiMessageMethod1) | [`MidiMessageMethod2`](#MidiMessageMethod2)[`?`](/API/builtins/nil.md)) {#create_input_device} +`->`[`renoise.Midi.MidiInputDevice`](/API/renoise/renoise.Midi.MidiInputDevice.md) Listen to incoming MIDI data: opens access to a MIDI input device by specifying a device name. @@ -33,7 +33,7 @@ Messages are received until the device reference is manually closed (see renoise.Midi.MidiDevice:close()) or until the MidiInputDevice object gets garbage collected. ### `create_output_device`(device_name : [`string`](/API/builtins/string.md)) {#create_output_device} -`->`[`renoise.Midi.MidiOutputDevice`](/API/renoise.Midi.MidiOutputDevice.md) +`->`[`renoise.Midi.MidiOutputDevice`](/API/renoise/renoise.Midi.MidiOutputDevice.md) Open access to a MIDI device by specifying the device name. Name must be one of `renoise.Midi.available_input_devices()`. @@ -43,7 +43,7 @@ The real device driver gets automatically closed when the MidiOutputDevice object gets garbage collected or when the device is explicitly closed via midi_device:close() and nothing else references it. ### `devices_changed_observable()` {#devices_changed_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) Fire notifications as soon as new devices become active or a previously added device gets removed/unplugged. diff --git a/docs/API/renoise.NoteColumn.md b/docs/API/renoise/renoise.NoteColumn.md similarity index 97% rename from docs/API/renoise.NoteColumn.md rename to docs/API/renoise/renoise.NoteColumn.md index b7790187..720d70b4 100644 --- a/docs/API/renoise.NoteColumn.md +++ b/docs/API/renoise/renoise.NoteColumn.md @@ -73,6 +73,6 @@ when column value is > 0x80, i.e. to specify an effect. ## Functions ### `clear`([*self*](/API/builtins/self.md)) {#clear} Clear the note column. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.NoteColumn`](/API/renoise.NoteColumn.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md)) {#copy_from} Copy the column's content from another column. diff --git a/docs/API/renoise.Osc.Bundle.md b/docs/API/renoise/renoise.Osc.Bundle.md similarity index 73% rename from docs/API/renoise.Osc.Bundle.md rename to docs/API/renoise/renoise.Osc.Bundle.md index 96a1b9b4..9aca66a2 100644 --- a/docs/API/renoise.Osc.Bundle.md +++ b/docs/API/renoise/renoise.Osc.Bundle.md @@ -6,7 +6,7 @@ **READ-ONLY** Raw binary representation of the bundle, as needed when e.g. sending the message over the network through sockets. -### elements : [`renoise.Osc.Bundle`](/API/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](/API/renoise.Osc.Message.md)`[]` {#elements} +### elements : [`renoise.Osc.Bundle`](/API/renoise/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md)`[]` {#elements} **READ-ONLY** Access to the bundle elements (table of messages or bundles) ### timetag : [`number`](/API/builtins/number.md) {#timetag} diff --git a/docs/API/renoise.Osc.Message.md b/docs/API/renoise/renoise.Osc.Message.md similarity index 100% rename from docs/API/renoise.Osc.Message.md rename to docs/API/renoise/renoise.Osc.Message.md diff --git a/docs/API/renoise.Osc.md b/docs/API/renoise/renoise.Osc.md similarity index 72% rename from docs/API/renoise.Osc.md rename to docs/API/renoise/renoise.Osc.md index 6e9cc920..c26df585 100644 --- a/docs/API/renoise.Osc.md +++ b/docs/API/renoise/renoise.Osc.md @@ -3,7 +3,7 @@ --- ## Functions ### `from_binary_data`(binary_data : [`string`](/API/builtins/string.md)) {#from_binary_data} -`->`[`renoise.Osc.Bundle`](/API/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](/API/renoise.Osc.Message.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +`->`[`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) De-packetizing raw (socket) data to OSC messages or bundles: Converts the binary data to an OSC message or bundle. If the data does not diff --git a/docs/API/renoise.Pattern.md b/docs/API/renoise/renoise.Pattern.md similarity index 63% rename from docs/API/renoise.Pattern.md rename to docs/API/renoise/renoise.Pattern.md index 4a4bec32..a57d66cd 100644 --- a/docs/API/renoise.Pattern.md +++ b/docs/API/renoise/renoise.Pattern.md @@ -12,13 +12,13 @@ This does not look at track automation. ### name : [`string`](/API/builtins/string.md) {#name} Name of the pattern, as visible in the pattern sequencer. -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### number_of_lines : [`integer`](/API/builtins/integer.md) {#number_of_lines} Number of lines the pattern currently has. 64 by default. Max is renoise.Pattern.MAX_NUMBER_OF_LINES, min is 1. -### number_of_lines_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#number_of_lines_observable} -### tracks : [`renoise.PatternTrack`](/API/renoise.PatternTrack.md)`[]` {#tracks} +### number_of_lines_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#number_of_lines_observable} +### tracks : [`renoise.PatternTrack`](/API/renoise/renoise.PatternTrack.md)`[]` {#tracks} **READ-ONLY** Access to the pattern tracks. Each pattern has #renoise.song().tracks amount of tracks. @@ -26,18 +26,18 @@ renoise.Pattern.MAX_NUMBER_OF_LINES, min is 1. --- ## Functions -### `add_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](/API/aliases/PatternLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_edited_notifier} -### `add_line_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](/API/aliases/PatternLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_notifier} +### `add_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_edited_notifier} +### `add_line_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#add_line_notifier} ### `clear`([*self*](/API/builtins/self.md)) {#clear} Deletes all lines & automation. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.Pattern`](/API/renoise.Pattern.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.Pattern`](/API/renoise/renoise.Pattern.md)) {#copy_from} Copy contents from other patterns, including automation, when possible. -### `has_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](/API/aliases/PatternLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_edited_notifier} +### `has_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_edited_notifier} `->`[`boolean`](/API/builtins/boolean.md) Same as `line_notifier`, but the notifier only fires when the user added, changed or deleted a line with the computer or MIDI keyboard. -### `has_line_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](/API/aliases/PatternLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_notifier} +### `has_line_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_notifier} `->`[`boolean`](/API/builtins/boolean.md) Check/add/remove notifier functions or methods, which are called by Renoise @@ -62,11 +62,19 @@ be called hundreds of times when, for example, simply clearing a pattern. If you are only interested in changes that are made to the currently edited pattern, dynamically attach and detach to the selected pattern's line notifiers by listening to "renoise.song().selected_pattern_observable". -### `remove_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](/API/aliases/PatternLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_edited_notifier} -### `remove_line_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](/API/aliases/PatternLineChangeCallbackWithContext.md), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_notifier} +### `remove_line_edited_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_edited_notifier} +### `remove_line_notifier`([*self*](/API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#remove_line_notifier} ### `track`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#track} -`->`[`renoise.PatternTrack`](/API/renoise.PatternTrack.md) +`->`[`renoise.PatternTrack`](/API/renoise/renoise.PatternTrack.md) Access to a single pattern track by index. Use properties 'tracks' to iterate over all tracks and to query the track count. + + +--- +## Aliases +# alias PatternLineChangeCallbackWithContext {#PatternLineChangeCallbackWithContext} +(obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md)) + + diff --git a/docs/API/renoise.PatternIterator.md b/docs/API/renoise/renoise.PatternIterator.md similarity index 69% rename from docs/API/renoise.PatternIterator.md rename to docs/API/renoise/renoise.PatternIterator.md index c7174abb..25572bca 100644 --- a/docs/API/renoise.PatternIterator.md +++ b/docs/API/renoise/renoise.PatternIterator.md @@ -21,49 +21,49 @@ only once. --- ## Functions ### `effect_columns_in_pattern`([*self*](/API/builtins/self.md), pattern_index : [`integer`](/API/builtins/integer.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#effect_columns_in_pattern} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) Iterate over all note columns in the specified pattern. ### `effect_columns_in_pattern_track`([*self*](/API/builtins/self.md), pattern_index : [`integer`](/API/builtins/integer.md), track_index : [`integer`](/API/builtins/integer.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#effect_columns_in_pattern_track} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) ### `effect_columns_in_song`([*self*](/API/builtins/self.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#effect_columns_in_song} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) Iterate over all effect columns in the song. ### `effect_columns_in_track`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#effect_columns_in_track} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) ### `lines_in_pattern`([*self*](/API/builtins/self.md), pattern_index : [`integer`](/API/builtins/integer.md)) {#lines_in_pattern} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) Iterate over all lines in the given pattern only. ### `lines_in_pattern_track`([*self*](/API/builtins/self.md), pattern_index : [`integer`](/API/builtins/integer.md), track_index : [`integer`](/API/builtins/integer.md)) {#lines_in_pattern_track} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) Iterate over all lines in the given pattern, track only. ### `lines_in_song`([*self*](/API/builtins/self.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#lines_in_song} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) Iterate over all pattern lines in the song. ### `lines_in_track`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#lines_in_track} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternLinePosition`](/API/structs/PatternLinePosition.md), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](/API/structs/PatternLinePosition.md) Iterate over all lines in the given track only. ### `note_columns_in_pattern`([*self*](/API/builtins/self.md), pattern_index : [`integer`](/API/builtins/integer.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#note_columns_in_pattern} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) Iterate over all note columns in the specified pattern. ### `note_columns_in_pattern_track`([*self*](/API/builtins/self.md), pattern_index : [`integer`](/API/builtins/integer.md), track_index : [`integer`](/API/builtins/integer.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#note_columns_in_pattern_track} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) Iterate over all note/effect columns in the specified pattern track. ### `note_columns_in_song`([*self*](/API/builtins/self.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#note_columns_in_song} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) Iterate over all note columns in the song. ### `note_columns_in_track`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), visible_only : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md)) {#note_columns_in_track} -`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) +`->`(context : [`unknown`](/API/builtins/unknown.md)) `->` [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](/API/structs/PatternColumnPosition.md) Iterate over all note/effect columns in the specified track. diff --git a/docs/API/renoise.PatternLine.md b/docs/API/renoise/renoise.PatternLine.md similarity index 82% rename from docs/API/renoise.PatternLine.md rename to docs/API/renoise/renoise.PatternLine.md index b09f93ef..fc25b445 100644 --- a/docs/API/renoise.PatternLine.md +++ b/docs/API/renoise/renoise.PatternLine.md @@ -10,13 +10,13 @@ ### EMPTY_PANNING : [`integer`](/API/builtins/integer.md) {#EMPTY_PANNING} ### EMPTY_VOLUME : [`integer`](/API/builtins/integer.md) {#EMPTY_VOLUME} ### NOTE_OFF : [`integer`](/API/builtins/integer.md) {#NOTE_OFF} -### effect_columns : [`renoise.EffectColumn`](/API/renoise.EffectColumn.md)`[]` {#effect_columns} +### effect_columns : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md)`[]` {#effect_columns} **READ-ONLY** ### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} **READ-ONLY** -### note_columns : [`renoise.NoteColumn`](/API/renoise.NoteColumn.md)`[]` {#note_columns} +### note_columns : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md)`[]` {#note_columns} **READ-ONLY** @@ -25,10 +25,10 @@ ## Functions ### `clear`([*self*](/API/builtins/self.md)) {#clear} Clear all note and effect columns. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.PatternLine`](/API/renoise.PatternLine.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)) {#copy_from} Copy contents from other_line, trashing column content. ### `effect_column`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#effect_column} -`->`[`renoise.EffectColumn`](/API/renoise.EffectColumn.md) +`->`[`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md) Access to a single effect column by index. Use properties 'effect_columns' to iterate over all effect columns and to query the effect_column count. @@ -36,7 +36,7 @@ This is a !lot! more efficient than calling the property: effect_columns[index] to randomly access columns. When iterating over all columns, use pairs(effect_columns). ### `note_column`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#note_column} -`->`[`renoise.NoteColumn`](/API/renoise.NoteColumn.md) +`->`[`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md) Access to a single note column by index. Use properties 'note_columns' to iterate over all note columns and to query the note_column count. diff --git a/docs/API/renoise.PatternSequencer.md b/docs/API/renoise/renoise.PatternSequencer.md similarity index 91% rename from docs/API/renoise.PatternSequencer.md rename to docs/API/renoise/renoise.PatternSequencer.md index 314d926d..9d9fde3f 100644 --- a/docs/API/renoise.PatternSequencer.md +++ b/docs/API/renoise/renoise.PatternSequencer.md @@ -6,8 +6,8 @@ Pattern sequencer component of the Renoise song. ### keep_sequence_sorted : [`boolean`](/API/builtins/boolean.md) {#keep_sequence_sorted} When true, the sequence will be auto sorted. -### keep_sequence_sorted_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#keep_sequence_sorted_observable} -### pattern_assignments_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#pattern_assignments_observable} +### keep_sequence_sorted_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#keep_sequence_sorted_observable} +### pattern_assignments_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#pattern_assignments_observable} Attach notifiers that will be called as soon as any pattern assignment at any sequence position changes. @@ -16,8 +16,8 @@ Pattern order list: Notifiers will only be fired when sequence positions are added, removed or their order changed. To get notified of pattern assignment changes use the property `pattern_assignments_observable`. -### pattern_sequence_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#pattern_sequence_observable} -### pattern_slot_mutes_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#pattern_slot_mutes_observable} +### pattern_sequence_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#pattern_sequence_observable} +### pattern_slot_mutes_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#pattern_slot_mutes_observable} Attach notifiers that will be fired as soon as any slot muting property in any track/sequence slot changes. @@ -25,7 +25,7 @@ in any track/sequence slot changes. Access to the selected slots in the sequencer. When no selection is present `{0, 0}` is returned, else Range: (1 - #sequencer.pattern_sequence) -### selection_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selection_range_observable} +### selection_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_range_observable} --- @@ -66,7 +66,7 @@ Access to pattern sequence sections. When the `is_start_of_section flag` is set for a sequence pos, a section ranges from this pos to the next pos which starts a section, or till the end of the song when there are no others. ### `sequence_is_start_of_section_observable`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#sequence_is_start_of_section_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) ### `sequence_section_name`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#sequence_section_name} `->`[`string`](/API/builtins/string.md) @@ -74,10 +74,10 @@ which starts a section, or till the end of the song when there are no others. Access to a pattern sequence section's name. Section names are only visible for a sequence pos which starts the section (see `sequence_is_start_of_section`). ### `sequence_section_name_observable`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#sequence_section_name_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) ### `sequence_sections_changed_observable`([*self*](/API/builtins/self.md)) {#sequence_sections_changed_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) Observable, which is fired, whenever the section layout in the sequence changed in any way, i.e. new sections got added, existing ones got deleted diff --git a/docs/API/renoise.PatternTrack.md b/docs/API/renoise/renoise.PatternTrack.md similarity index 66% rename from docs/API/renoise.PatternTrack.md rename to docs/API/renoise/renoise.PatternTrack.md index ef6dd243..c34d2795 100644 --- a/docs/API/renoise.PatternTrack.md +++ b/docs/API/renoise/renoise.PatternTrack.md @@ -5,23 +5,23 @@ ### alias_pattern_index : [`integer`](/API/builtins/integer.md) {#alias_pattern_index} index or 0 when no alias is present -### alias_pattern_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#alias_pattern_index_observable} -### automation : [`renoise.PatternTrackAutomation`](/API/renoise.PatternTrackAutomation.md)`[]` {#automation} +### alias_pattern_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#alias_pattern_index_observable} +### automation : [`renoise.PatternTrackAutomation`](/API/renoise/renoise.PatternTrackAutomation.md)`[]` {#automation} Automation. -### automation_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#automation_observable} -### color : [`RGBColor`](/API/aliases/RGBColor.md)[`?`](/API/builtins/nil.md) {#color} +### automation_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#automation_observable} +### color : [`RGBColor`](#RGBColor)[`?`](/API/builtins/nil.md) {#color} slot color of the pattern in the matrix, nil when no slot color is set -### color_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#color_observable} +### color_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_observable} ### is_alias : [`boolean`](/API/builtins/boolean.md) {#is_alias} **READ-ONLY** ### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} Returns true when all the track lines are empty. Does not look at automation. -### is_empty_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_empty_observable} -### lines : [`renoise.PatternLine`](/API/renoise.PatternLine.md)`[]` {#lines} +### is_empty_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_empty_observable} +### lines : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)`[]` {#lines} **READ-ONLY** Get all lines in range [1, number_of_lines_in_pattern]. Use `renoise.Pattern:add/remove_line_notifier` for change notifications. @@ -31,31 +31,31 @@ Use `renoise.Pattern:add/remove_line_notifier` for change notifications. ## Functions ### `clear`([*self*](/API/builtins/self.md)) {#clear} Deletes all lines & automation. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.PatternTrack`](/API/renoise.PatternTrack.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.PatternTrack`](/API/renoise/renoise.PatternTrack.md)) {#copy_from} Copy contents from other pattern tracks, including automation when possible. -### `create_automation`([*self*](/API/builtins/self.md), parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)) {#create_automation} -`->`[`renoise.PatternTrackAutomation`](/API/renoise.PatternTrackAutomation.md) +### `create_automation`([*self*](/API/builtins/self.md), parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)) {#create_automation} +`->`[`renoise.PatternTrackAutomation`](/API/renoise/renoise.PatternTrackAutomation.md) Creates a new automation for the given device parameter. Fires an error when an automation for the given parameter already exists. Returns the newly created automation. Passed parameter must be automatable, which can be tested with 'parameter.is_automatable'. -### `delete_automation`([*self*](/API/builtins/self.md), parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)) {#delete_automation} +### `delete_automation`([*self*](/API/builtins/self.md), parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)) {#delete_automation} Remove an existing automation the given device parameter. Automation must exist. -### `find_automation`([*self*](/API/builtins/self.md), parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)) {#find_automation} -`->`[`renoise.PatternTrackAutomation`](/API/renoise.PatternTrackAutomation.md)[`?`](/API/builtins/nil.md) +### `find_automation`([*self*](/API/builtins/self.md), parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)) {#find_automation} +`->`[`renoise.PatternTrackAutomation`](/API/renoise/renoise.PatternTrackAutomation.md)[`?`](/API/builtins/nil.md) Returns the automation for the given device parameter or nil when there is none. ### `line`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#line} -`->`[`renoise.PatternLine`](/API/renoise.PatternLine.md) +`->`[`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md) Access to a single line by index. Line must be in Range: (1 - MAX_NUMBER_OF_LINES). This is a !lot! more efficient than calling the property: lines[index] to randomly access lines. ### `lines_in_range`([*self*](/API/builtins/self.md), index_from : [`integer`](/API/builtins/integer.md), index_to : [`integer`](/API/builtins/integer.md)) {#lines_in_range} -`->`[`renoise.PatternLine`](/API/renoise.PatternLine.md)`[]` +`->`[`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)`[]` Get a specific line range. Index must be Range: (1 - Pattern.MAX_NUMBER_OF_LINES) diff --git a/docs/API/renoise.PatternTrackAutomation.md b/docs/API/renoise/renoise.PatternTrackAutomation.md similarity index 84% rename from docs/API/renoise.PatternTrackAutomation.md rename to docs/API/renoise/renoise.PatternTrackAutomation.md index febb2a77..87bd8ae6 100644 --- a/docs/API/renoise.PatternTrackAutomation.md +++ b/docs/API/renoise/renoise.PatternTrackAutomation.md @@ -18,11 +18,11 @@ For example a time of 1.5 means: line 1 with a note column delay of 128 --- ## Properties -### dest_device : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md) {#dest_device} +### dest_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) {#dest_device} Destination device. Can in some rare circumstances be nil, i.e. when a device or track is about to be deleted. -### dest_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#dest_parameter} +### dest_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#dest_parameter} Destination device's parameter. Can in some rare circumstances be nil, i.e. when a device or track is about to be deleted. @@ -32,7 +32,7 @@ Range: (1 - NUM_LINES_IN_PATTERN) ### playmode : [`renoise.PatternTrackAutomation.Playmode`](renoise.PatternTrackAutomation.md#Playmode) {#playmode} play-mode (interpolation mode). -### playmode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#playmode_observable} +### playmode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#playmode_observable} ### points : [`EnvelopePoint`](/API/structs/EnvelopePoint.md)`[]` {#points} Get all points of the automation. When setting a new list of points, items may be unsorted by time, but there may not be multiple points @@ -40,21 +40,21 @@ for the same time. Returns a copy of the list, so changing `points[1].value` will not do anything. Instead, change them via `points = { modified_points }`. -### points_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#points_observable} +### points_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#points_observable} ### selection_end : [`integer`](/API/builtins/integer.md) {#selection_end} Range: (1 - automation.length + 1) -### selection_end_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selection_end_observable} +### selection_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_end_observable} ### selection_range : [`integer`](/API/builtins/integer.md)`[]` {#selection_range} Get or set selection range. when setting an empty table, the existing selection, if any, will be cleared. array of two numbers [] OR Range: (1 - automation.length + 1) -### selection_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selection_range_observable} +### selection_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_range_observable} ### selection_start : [`integer`](/API/builtins/integer.md) {#selection_start} Range: (1 - automation.length + 1) -### selection_start_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selection_start_observable} +### selection_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_start_observable} --- @@ -69,7 +69,7 @@ anything at all. ### `clear_range`([*self*](/API/builtins/self.md), from_time : [`integer`](/API/builtins/integer.md), to_time : [`integer`](/API/builtins/integer.md)) {#clear_range} Remove all existing points in the given [from, to) time range from the automation. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.PatternTrackAutomation`](/API/renoise.PatternTrackAutomation.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.PatternTrackAutomation`](/API/renoise/renoise.PatternTrackAutomation.md)) {#copy_from} Copy all points and playback settings from another track automation. ### `has_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md)) {#has_point_at} `->`[`boolean`](/API/builtins/boolean.md) diff --git a/docs/API/renoise.Sample.md b/docs/API/renoise/renoise.Sample.md similarity index 78% rename from docs/API/renoise.Sample.md rename to docs/API/renoise/renoise.Sample.md index 109cd7bc..b8f96e2b 100644 --- a/docs/API/renoise.Sample.md +++ b/docs/API/renoise/renoise.Sample.md @@ -1,11 +1,11 @@ # renoise.Sample ## Constants -### BeatSyncMode {#BeatSyncMode} +### NewNoteActionMode {#NewNoteActionMode} ```lua { - BEAT_SYNC_REPITCH: integer = 1, - BEAT_SYNC_PERCUSSION: integer = 2, - BEAT_SYNC_TEXTURE: integer = 3, + NEW_NOTE_ACTION_NOTE_CUT: integer = 1, + NEW_NOTE_ACTION_NOTE_OFF: integer = 2, + NEW_NOTE_ACTION_SUSTAIN: integer = 3, } ``` ### LoopMode {#LoopMode} @@ -17,14 +17,6 @@ LOOP_MODE_PING_PONG: integer = 4, } ``` -### NewNoteActionMode {#NewNoteActionMode} -```lua -{ - NEW_NOTE_ACTION_NOTE_CUT: integer = 1, - NEW_NOTE_ACTION_NOTE_OFF: integer = 2, - NEW_NOTE_ACTION_SUSTAIN: integer = 3, -} -``` ### InterpolationMode {#InterpolationMode} ```lua { @@ -34,37 +26,45 @@ INTERPOLATE_SINC: integer = 4, } ``` +### BeatSyncMode {#BeatSyncMode} +```lua +{ + BEAT_SYNC_REPITCH: integer = 1, + BEAT_SYNC_PERCUSSION: integer = 2, + BEAT_SYNC_TEXTURE: integer = 3, +} +``` --- ## Properties ### autofade : [`boolean`](/API/builtins/boolean.md) {#autofade} -### autofade_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#autofade_observable} +### autofade_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#autofade_observable} ### autoseek : [`boolean`](/API/builtins/boolean.md) {#autoseek} -### autoseek_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#autoseek_observable} +### autoseek_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#autoseek_observable} ### beat_sync_enabled : [`boolean`](/API/builtins/boolean.md) {#beat_sync_enabled} Beat sync. -### beat_sync_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#beat_sync_enabled_observable} +### beat_sync_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#beat_sync_enabled_observable} ### beat_sync_lines : [`integer`](/API/builtins/integer.md) {#beat_sync_lines} Range: (1 - 512) -### beat_sync_lines_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#beat_sync_lines_observable} +### beat_sync_lines_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#beat_sync_lines_observable} ### beat_sync_mode : [`renoise.Sample.BeatSyncMode`](renoise.Sample.md#BeatSyncMode) {#beat_sync_mode} -### beat_sync_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#beat_sync_mode_observable} +### beat_sync_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#beat_sync_mode_observable} ### device_chain_index : [`integer`](/API/builtins/integer.md) {#device_chain_index} The linked instrument device chain. 0 when disable, else a valid index for the renoise.Instrument.sample_device_chain table -### device_chain_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#device_chain_index_observable} +### device_chain_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#device_chain_index_observable} ### fine_tune : [`integer`](/API/builtins/integer.md) {#fine_tune} Range: (-127 - 127) -### fine_tune_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#fine_tune_observable} +### fine_tune_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#fine_tune_observable} ### interpolation_mode : [`renoise.Sample.InterpolationMode`](renoise.Sample.md#InterpolationMode) {#interpolation_mode} Interpolation, new note action, oneshot, mute_group, autoseek, autofade. -### interpolation_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#interpolation_mode_observable} +### interpolation_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#interpolation_mode_observable} ### is_slice_alias : [`boolean`](/API/builtins/boolean.md) {#is_slice_alias} **READ-ONLY** True, when the sample slot is an alias to a sliced master sample. Such sample slots are read-only and automatically managed with the master samples @@ -73,45 +73,45 @@ slice list. ### loop_end : [`integer`](/API/builtins/integer.md) {#loop_end} Range: (1 - num_sample_frames) -### loop_end_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_end_observable} ### loop_mode : [`renoise.Sample.LoopMode`](renoise.Sample.md#LoopMode) {#loop_mode} Loops. -### loop_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_mode_observable} +### loop_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_mode_observable} ### loop_release : [`boolean`](/API/builtins/boolean.md) {#loop_release} -### loop_release_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_release_observable} +### loop_release_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_release_observable} ### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} Range: (1 - num_sample_frames) -### loop_start_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_start_observable} ### modulation_set_index : [`integer`](/API/builtins/integer.md) {#modulation_set_index} The linked modulation set. 0 when disable, else a valid index for the renoise.Instrument.sample_modulation_sets table -### modulation_set_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#modulation_set_index_observable} +### modulation_set_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#modulation_set_index_observable} ### mute_group : [`integer`](/API/builtins/integer.md) {#mute_group} Range: (0 - 15) where 0 means no group -### mute_group_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#mute_group_observable} +### mute_group_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#mute_group_observable} ### name : [`string`](/API/builtins/string.md) {#name} Name. -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### new_note_action : [`renoise.Sample.NewNoteActionMode`](renoise.Sample.md#NewNoteActionMode) {#new_note_action} -### new_note_action_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#new_note_action_observable} +### new_note_action_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#new_note_action_observable} ### oneshot : [`boolean`](/API/builtins/boolean.md) {#oneshot} -### oneshot_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#oneshot_observable} +### oneshot_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#oneshot_observable} ### oversample_enabled : [`boolean`](/API/builtins/boolean.md) {#oversample_enabled} -### oversample_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#oversample_enabled_observable} +### oversample_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#oversample_enabled_observable} ### panning : [`number`](/API/builtins/number.md) {#panning} Range: (0.0 - 1.0) -### panning_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#panning_observable} -### sample_buffer : [`renoise.SampleBuffer`](/API/renoise.SampleBuffer.md) {#sample_buffer} +### panning_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_observable} +### sample_buffer : [`renoise.SampleBuffer`](/API/renoise/renoise.SampleBuffer.md) {#sample_buffer} **READ-ONLY** -### sample_buffer_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#sample_buffer_observable} -### sample_mapping : [`renoise.SampleMapping`](/API/renoise.SampleMapping.md) {#sample_mapping} +### sample_buffer_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sample_buffer_observable} +### sample_mapping : [`renoise.SampleMapping`](/API/renoise/renoise.SampleMapping.md) {#sample_mapping} **READ-ONLY** Keyboard Note/velocity mapping ### slice_markers : [`integer`](/API/builtins/integer.md)`[]` {#slice_markers} @@ -121,22 +121,22 @@ will NOT be remapped (unlike its done with the insert/remove/move_slice_marker functions). See function insert_slice_marker for info about marker limitations and preconditions. -### slice_markers_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#slice_markers_observable} +### slice_markers_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#slice_markers_observable} ### transpose : [`integer`](/API/builtins/integer.md) {#transpose} Range: (-120 - 120) -### transpose_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#transpose_observable} +### transpose_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#transpose_observable} ### volume : [`number`](/API/builtins/number.md) {#volume} Range: (0.0 - 4.0) -### volume_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#volume_observable} +### volume_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_observable} --- ## Functions ### `clear`([*self*](/API/builtins/self.md)) {#clear} Reset, clear all sample settings and sample data. -### `copy_from`([*self*](/API/builtins/self.md), sample : [`renoise.Sample`](/API/renoise.Sample.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), sample : [`renoise.Sample`](/API/renoise/renoise.Sample.md)) {#copy_from} Copy all settings, including sample data from another sample. ### `delete_slice_marker`([*self*](/API/builtins/self.md), marker_sample_pos : [`integer`](/API/builtins/integer.md)) {#delete_slice_marker} Delete an existing slice marker. marker_sample_pos must point to an existing diff --git a/docs/API/renoise.SampleAhdrsModulationDevice.md b/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md similarity index 69% rename from docs/API/renoise.SampleAhdrsModulationDevice.md rename to docs/API/renoise/renoise.SampleAhdrsModulationDevice.md index 501ce28c..6e374aab 100644 --- a/docs/API/renoise.SampleAhdrsModulationDevice.md +++ b/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md @@ -2,7 +2,7 @@ --- ## Properties -### attack : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#attack} +### attack : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#attack} with range (0-1) ### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} @@ -10,47 +10,47 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} -### duration : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#duration} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### duration : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#duration} with range (0-1) ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} -### hold : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#hold} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### hold : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#hold} with range (0-1) ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Fixed name of the device. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### release : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#release} +### release : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#release} with range (0-1) ### short_name : [`string`](/API/builtins/string.md) {#short_name} **READ-ONLY** -### sustain : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#sustain} +### sustain : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#sustain} with range (0-1) ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} @@ -67,18 +67,18 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)) {#copy_from} Copy a device's state from another device. 'other_device' must be of the same type. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the device to its default state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.SampleBuffer.md b/docs/API/renoise/renoise.SampleBuffer.md similarity index 87% rename from docs/API/renoise.SampleBuffer.md rename to docs/API/renoise/renoise.SampleBuffer.md index 4aadf8cf..5c70b23f 100644 --- a/docs/API/renoise.SampleBuffer.md +++ b/docs/API/renoise/renoise.SampleBuffer.md @@ -20,15 +20,15 @@ NOTE: All properties are invalid when no sample data is present, ### display_length : [`integer`](/API/builtins/integer.md) {#display_length} Range: (1 - number_of_frames) -### display_length_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_length_observable} +### display_length_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_length_observable} ### display_range : [`integer`](/API/builtins/integer.md)`[]` {#display_range} Range: (1 - number_of_frames) -### display_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_range_observable} +### display_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_range_observable} ### display_start : [`integer`](/API/builtins/integer.md) {#display_start} Range: (1 - number_of_frames) -### display_start_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_start_observable} +### display_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_start_observable} ### has_sample_data : [`boolean`](/API/builtins/boolean.md) {#has_sample_data} **READ-ONLY** Check this before accessing properties @@ -49,23 +49,23 @@ buffers, modify the sliced master sample buffer instead. ### selected_channel : [`renoise.SampleBuffer.Channel`](renoise.SampleBuffer.md#Channel) {#selected_channel} The selected channel. -### selected_channel_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_channel_observable} +### selected_channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_channel_observable} ### selection_end : [`integer`](/API/builtins/integer.md) {#selection_end} Range: (1 - number_of_frames) -### selection_end_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selection_end_observable} +### selection_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_end_observable} ### selection_range : [`integer`](/API/builtins/integer.md)`[]` {#selection_range} Range: (1 - number_of_frames) -### selection_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selection_range_observable} +### selection_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_range_observable} ### selection_start : [`integer`](/API/builtins/integer.md) {#selection_start} Range: (1 - number_of_frames) -### selection_start_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selection_start_observable} +### selection_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_start_observable} ### vertical_zoom_factor : [`number`](/API/builtins/number.md) {#vertical_zoom_factor} Range(0.0-1.0) -### vertical_zoom_factor_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#vertical_zoom_factor_observable} +### vertical_zoom_factor_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#vertical_zoom_factor_observable} --- @@ -99,7 +99,7 @@ This will prepare undo/redo data for the whole sample. See also `->`values : [`number`](/API/builtins/number.md)`[]` Read access to samples in a sample data buffer. -### `save_as`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md), format : [`SampleBuffer.ExportType`](/API/aliases/SampleBuffer.ExportType.md)) {#save_as} +### `save_as`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md), format : [`SampleBuffer.ExportType`](#SampleBuffer.ExportType)) {#save_as} `->`success : [`boolean`](/API/builtins/boolean.md) Export sample data to a file. Possible errors are shown to the user, @@ -119,3 +119,15 @@ IMPORTANT: before modifying buffers, call 'prepare_sample_data_changes'. When you are done, call 'finalize_sample_data_changes' to generate undo/redo data for your changes and update sample overview caches! + + +--- +## Aliases +# alias SampleBuffer.ExportType {#SampleBuffer.ExportType} +`"flac"` | `"wav"` +```lua +SampleBuffer.ExportType: + | "wav" + | "flac" +``` + diff --git a/docs/API/renoise.SampleDeviceChain.md b/docs/API/renoise/renoise.SampleDeviceChain.md similarity index 82% rename from docs/API/renoise.SampleDeviceChain.md rename to docs/API/renoise/renoise.SampleDeviceChain.md index 0486892b..2c690fb5 100644 --- a/docs/API/renoise.SampleDeviceChain.md +++ b/docs/API/renoise/renoise.SampleDeviceChain.md @@ -12,18 +12,18 @@ the devices. ### available_output_routings : [`string`](/API/builtins/string.md)`[]` {#available_output_routings} **READ-ONLY** Output routing. -### devices : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md)`[]` {#devices} +### devices : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md)`[]` {#devices} **READ-ONLY** Device access. -### devices_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#devices_observable} +### devices_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#devices_observable} ### name : [`string`](/API/builtins/string.md) {#name} Name of the audio effect chain. -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### output_routing : [`string`](/API/builtins/string.md) {#output_routing} One of 'available_output_routings' -### output_routing_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#output_routing_observable} +### output_routing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_routing_observable} --- @@ -32,11 +32,11 @@ One of 'available_output_routings' Delete an existing device from a chain. The mixer device at index 1 can not be deleted. ### `device`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#device} -`->`[`renoise.AudioDevice`](/API/renoise.AudioDevice.md) +`->`[`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) Access to a single device in the chain. ### `insert_device_at`([*self*](/API/builtins/self.md), device_path : [`string`](/API/builtins/string.md), index : [`integer`](/API/builtins/integer.md)) {#insert_device_at} -`->`new_device : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md) +`->`new_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) Insert a new device at the given position. "device_path" must be an available device See: [renoise.SampleDeviceChain.available_devices](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/song/instrument/sample_device_chain.lua#24#10) diff --git a/docs/API/renoise.SampleEnvelopeModulationDevice.md b/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md similarity index 80% rename from docs/API/renoise.SampleEnvelopeModulationDevice.md rename to docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md index b338b07d..d46712ec 100644 --- a/docs/API/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, +} +``` --- @@ -28,13 +28,13 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} ### external_editor_visible : [`boolean`](/API/builtins/boolean.md) {#external_editor_visible} External editor visibility. set to true to show the editor, false to close it @@ -42,48 +42,48 @@ External editor visibility. ### fade_amount : [`integer`](/API/builtins/integer.md) {#fade_amount} Range: (0 - 4095) -### fade_amount_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#fade_amount_observable} +### fade_amount_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#fade_amount_observable} ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### length : [`integer`](/API/builtins/integer.md) {#length} Range: (6 - 1000) -### length_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#length_observable} +### length_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#length_observable} ### loop_end : [`integer`](/API/builtins/integer.md) {#loop_end} Range: (1 - envelope.length) -### loop_end_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_end_observable} ### loop_mode : [`renoise.SampleEnvelopeModulationDevice.LoopMode`](renoise.SampleEnvelopeModulationDevice.md#LoopMode) {#loop_mode} Loop. -### loop_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_mode_observable} +### loop_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_mode_observable} ### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} Range: (1 - envelope.length) -### loop_start_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_start_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Fixed name of the device. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### play_mode : [`renoise.SampleEnvelopeModulationDevice.PlayMode`](renoise.SampleEnvelopeModulationDevice.md#PlayMode) {#play_mode} Play mode (interpolation mode). -### play_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#play_mode_observable} +### play_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#play_mode_observable} ### points : [`SampleEnvelopeModulationDevice.Point`](/API/structs/SampleEnvelopeModulationDevice.Point.md)`[]` {#points} Get all points of the envelope. When setting a new list of points, items may be unsorted by time, but there may not be multiple points @@ -91,18 +91,18 @@ for the same time. Returns a copy of the list, so changing `points[1].value` will not do anything. Instead, change them via `points = { something }` instead. -### points_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#points_observable} +### points_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#points_observable} ### short_name : [`string`](/API/builtins/string.md) {#short_name} **READ-ONLY** ### sustain_enabled : [`boolean`](/API/builtins/boolean.md) {#sustain_enabled} Sustain. -### sustain_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#sustain_enabled_observable} +### sustain_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sustain_enabled_observable} ### sustain_position : [`integer`](/API/builtins/integer.md) {#sustain_position} Range: (1 - envelope.length) -### sustain_position_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#sustain_position_observable} +### sustain_position_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sustain_position_observable} ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). @@ -117,7 +117,7 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} --- @@ -128,9 +128,9 @@ Add a new point value (or replace any existing value) at time. Remove all points from the envelope. ### `clear_points_in_range`([*self*](/API/builtins/self.md), from_time : [`integer`](/API/builtins/integer.md), to_time : [`integer`](/API/builtins/integer.md)) {#clear_points_in_range} Remove points in the given [from, to) time range from the envelope. -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleEnvelopeModulationDevice`](/API/renoise.SampleEnvelopeModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleEnvelopeModulationDevice`](/API/renoise/renoise.SampleEnvelopeModulationDevice.md)) {#copy_from} Copy all properties from another SampleEnvelopeModulation object. -### `copy_points_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleEnvelopeModulationDevice`](/API/renoise.SampleEnvelopeModulationDevice.md)) {#copy_points_from} +### `copy_points_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleEnvelopeModulationDevice`](/API/renoise/renoise.SampleEnvelopeModulationDevice.md)) {#copy_points_from} Copy all points from another SampleEnvelopeModulation object. ### `has_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md)) {#has_point_at} `->`[`boolean`](/API/builtins/boolean.md) @@ -139,7 +139,7 @@ Test if a point exists at the given time. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the envelope back to its default initial state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.SampleFaderModulationDevice.md b/docs/API/renoise/renoise.SampleFaderModulationDevice.md similarity index 72% rename from docs/API/renoise.SampleFaderModulationDevice.md rename to docs/API/renoise/renoise.SampleFaderModulationDevice.md index 7339e987..c12ad1bc 100644 --- a/docs/API/renoise.SampleFaderModulationDevice.md +++ b/docs/API/renoise/renoise.SampleFaderModulationDevice.md @@ -19,47 +19,47 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} -### delay : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#delay} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} +### delay : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#delay} Delay. ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} -### duration : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#duration} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### duration : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#duration} Duration. ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} -### from : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#from} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### from : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#from} Start value. ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Fixed name of the device. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### scaling : [`renoise.SampleFaderModulationDevice.ScalingType`](renoise.SampleFaderModulationDevice.md#ScalingType) {#scaling} Scaling mode. -### scaling_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#scaling_observable} +### scaling_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#scaling_observable} ### short_name : [`string`](/API/builtins/string.md) {#short_name} **READ-ONLY** @@ -77,21 +77,21 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} -### to : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#to} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} +### to : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#to} Target value. --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)) {#copy_from} Copy a device's state from another device. 'other_device' must be of the same type. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the device to its default state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.SampleKeyTrackingModulationDevice.md b/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md similarity index 74% rename from docs/API/renoise.SampleKeyTrackingModulationDevice.md rename to docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md index b75ac942..a81963a4 100644 --- a/docs/API/renoise.SampleKeyTrackingModulationDevice.md +++ b/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md @@ -7,28 +7,28 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} -### max : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#max} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### max : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#max} with range (0-119) -### min : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#min} +### min : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#min} with range (0-119) ### name : [`string`](/API/builtins/string.md) {#name} @@ -37,8 +37,8 @@ with range (0-119) ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### short_name : [`string`](/API/builtins/string.md) {#short_name} @@ -58,18 +58,18 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)) {#copy_from} Copy a device's state from another device. 'other_device' must be of the same type. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the device to its default state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.SampleLfoModulationDevice.md b/docs/API/renoise/renoise.SampleLfoModulationDevice.md similarity index 72% rename from docs/API/renoise.SampleLfoModulationDevice.md rename to docs/API/renoise/renoise.SampleLfoModulationDevice.md index 2bf5b48d..83453d9f 100644 --- a/docs/API/renoise.SampleLfoModulationDevice.md +++ b/docs/API/renoise/renoise.SampleLfoModulationDevice.md @@ -13,7 +13,7 @@ --- ## Properties -### amount : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#amount} +### amount : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#amount} with range (0-1) ### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} @@ -21,30 +21,30 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} -### delay : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#delay} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} +### delay : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#delay} Delay. ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} -### frequency : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#frequency} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### frequency : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#frequency} with range (0-1) ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### mode : [`renoise.SampleLfoModulationDevice.Mode`](renoise.SampleLfoModulationDevice.md#Mode) {#mode} LFO mode. @@ -54,11 +54,11 @@ LFO mode. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### phase : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#phase} +### phase : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#phase} with range (0-360) ### short_name : [`string`](/API/builtins/string.md) {#short_name} @@ -78,18 +78,18 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)) {#copy_from} Copy a device's state from another device. 'other_device' must be of the same type. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the device to its default state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.SampleMapping.md b/docs/API/renoise/renoise.SampleMapping.md similarity index 73% rename from docs/API/renoise.SampleMapping.md rename to docs/API/renoise/renoise.SampleMapping.md index 4e42f903..a650e764 100644 --- a/docs/API/renoise.SampleMapping.md +++ b/docs/API/renoise/renoise.SampleMapping.md @@ -7,31 +7,31 @@ modified. See `sample_mappings[].read_only` ### base_note : [`integer`](/API/builtins/integer.md) {#base_note} (0-119, c-4=48)] -### base_note_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#base_note_observable} +### base_note_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#base_note_observable} ### layer : [`renoise.Instrument.Layer`](renoise.Instrument.md#Layer) {#layer} Mapping's layer (triggered via Note-Ons or Note-Offs?). -### layer_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#layer_observable} +### layer_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#layer_observable} ### map_key_to_pitch : [`boolean`](/API/builtins/boolean.md) {#map_key_to_pitch} -### map_key_to_pitch_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#map_key_to_pitch_observable} +### map_key_to_pitch_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#map_key_to_pitch_observable} ### map_velocity_to_volume : [`boolean`](/API/builtins/boolean.md) {#map_velocity_to_volume} Mappings velocity->volume and key->pitch options. -### map_velocity_to_volume_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#map_velocity_to_volume_observable} +### map_velocity_to_volume_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#map_velocity_to_volume_observable} ### note_range : [`integer`](/API/builtins/integer.md)`[]` {#note_range} Range: (0 - 119) where C-4 is 48 -### note_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#note_range_observable} +### note_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#note_range_observable} ### read_only : [`boolean`](/API/builtins/boolean.md) {#read_only} **READ-ONLY** True for sliced instruments. No sample mapping properties are allowed to be modified, but can be read. -### sample : [`renoise.Sample`](/API/renoise.Sample.md) {#sample} +### sample : [`renoise.Sample`](/API/renoise/renoise.Sample.md) {#sample} Linked sample. ### velocity_range : [`integer`](/API/builtins/integer.md)`[]` {#velocity_range} Range: (0 - 127) -### velocity_range_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#velocity_range_observable} +### velocity_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#velocity_range_observable} diff --git a/docs/API/renoise.SampleModulationDevice.md b/docs/API/renoise/renoise.SampleModulationDevice.md similarity index 80% rename from docs/API/renoise.SampleModulationDevice.md rename to docs/API/renoise/renoise.SampleModulationDevice.md index b8770301..ae17f9be 100644 --- a/docs/API/renoise.SampleModulationDevice.md +++ b/docs/API/renoise/renoise.SampleModulationDevice.md @@ -29,32 +29,32 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Fixed name of the device. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### short_name : [`string`](/API/builtins/string.md) {#short_name} @@ -74,18 +74,18 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)) {#copy_from} Copy a device's state from another device. 'other_device' must be of the same type. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the device to its default state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise/renoise.SampleModulationSet.md b/docs/API/renoise/renoise.SampleModulationSet.md new file mode 100644 index 00000000..05ff550d --- /dev/null +++ b/docs/API/renoise/renoise.SampleModulationSet.md @@ -0,0 +1,150 @@ +# renoise.SampleModulationSet + +--- +## Properties +### available_devices : [`string`](/API/builtins/string.md)`[]` {#available_devices} +**READ-ONLY** All available devices, to be used in 'insert_device_at'. + +### available_filter_types : [`FilterTypes`](#FilterTypes)`[]` {#available_filter_types} +**READ-ONLY** List of available filter types depending on the filter_version. + +### cutoff_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#cutoff_input} +Input value for the cutoff domain + +### devices : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)`[]` {#devices} +**READ-ONLY** Device list access. + +### devices_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#devices_observable} +### drive_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#drive_input} +Input value for the drive domain + +### filter_type : [`FilterTypes`](#FilterTypes) {#filter_type} +The type of the filter selected for the modulation set. +Songs made with previous versions of Renoise may use old filter types. + +### filter_type_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#filter_type_observable} +### filter_version : `1` | `2` | `3` {#filter_version} +**READ-ONLY** Filter version, 3 is the latest. + +### filter_version_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#filter_version_observable} +### name : [`string`](/API/builtins/string.md) {#name} +Name of the modulation set. + +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### panning_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#panning_input} +Input value for the panning domain + +### pitch_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#pitch_input} +Input value for the pitch domain + +### pitch_range : [`integer`](/API/builtins/integer.md) {#pitch_range} +Range: (1 - 96) + +### pitch_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#pitch_range_observable} +### resonance_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#resonance_input} +Input value for the resonance domain + +### volume_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#volume_input} +Input value for the volume domain + + + +--- +## Functions +### `copy_from`([*self*](/API/builtins/self.md), other_set : [`renoise.SampleModulationSet`](/API/renoise/renoise.SampleModulationSet.md)) {#copy_from} +Copy all devices from another SampleModulationSet object. +### `delete_device_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_device_at} +Delete a device at the given index. +### `device`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#device} +`->`[`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md) + +Access a single device by index. +### `init`([*self*](/API/builtins/self.md)) {#init} +Reset all chain back to default initial state. Removing all devices too. +### `insert_device_at`([*self*](/API/builtins/self.md), device_path : [`string`](/API/builtins/string.md), target_type : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType), index : [`integer`](/API/builtins/integer.md)) {#insert_device_at} +`->`new_sample_modulation_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md) + +Insert a new device at the given position. "device_path" must be one of +renoise.song().instruments[].sample_modulation_sets[].available_devices. +### `upgrade_filter_version`([*self*](/API/builtins/self.md)) {#upgrade_filter_version} +Upgrade filter to the latest version. Tries to find a somewhat matching +filter in the new version, but things quite likely won't sound the same. + + + +--- +## Aliases +# alias FilterTypes {#FilterTypes} +[`FilterTypes1`](#FilterTypes1) | [`FilterTypes2`](#FilterTypes2) | [`FilterTypes3`](#FilterTypes3) +```lua +-- Available filter types when filter_version = 3 +-- Available filter types when filter_version = 3 +-- Available filter types when filter_version = 2 +-- Available filter types when filter_version = 1 +FilterTypes: + | "None" + | "LP Clean" + | "LP K35" + | "LP Moog" + | "LP Diode" + | "HP Clean" + | "HP K35" + | "HP Moog" + | "BP Clean" + | "BP K35" + | "BP Moog" + | "BandPass" + | "BandStop" + | "Vowel" + | "Comb" + | "Decimator" + | "Dist Shape" + | "Dist Fold" + | "AM Sine" + | "AM Triangle" + | "AM Saw" + | "AM Pulse" + | "None" + | "LP 2x2 Pole" + | "LP 2 Pole" + | "LP Biquad" + | "LP Moog" + | "LP Single" + | "HP 2x2 Pole" + | "HP 2 Pole" + | "HP Moog" + | "Band Reject" + | "Band Pass" + | "EQ -15 dB" + | "EQ -6 dB" + | "EQ +6 dB" + | "EQ +15 dB" + | "EQ Peaking" + | "Dist. Low" + | "Dist. Mid" + | "Dist. High" + | "Dist." + | "RingMod" + | "None" + | "LP -12 dB" + | "LP -24 dB" + | "LP -48 dB" + | "Moog LP" + | "Single Pole" + | "HP -12 dB" + | "HP -24 dB" + | "Moog HP" + | "Band Reject" + | "Band Pass" + | "EQ -15 dB" + | "EQ -6 dB" + | "EQ +6 dB" + | "EQ +15 dB" + | "Peaking EQ" + | "Dist. Low" + | "Dist. Mid" + | "Dist. High" + | "Dist." + | "AMod" +``` + diff --git a/docs/API/renoise.SampleOperandModulationDevice.md b/docs/API/renoise/renoise.SampleOperandModulationDevice.md similarity index 76% rename from docs/API/renoise.SampleOperandModulationDevice.md rename to docs/API/renoise/renoise.SampleOperandModulationDevice.md index 962eeb1e..3a18c885 100644 --- a/docs/API/renoise.SampleOperandModulationDevice.md +++ b/docs/API/renoise/renoise.SampleOperandModulationDevice.md @@ -7,32 +7,32 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Fixed name of the device. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### short_name : [`string`](/API/builtins/string.md) {#short_name} @@ -52,21 +52,21 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} -### value : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#value} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} +### value : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#value} Operand value. --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)) {#copy_from} Copy a device's state from another device. 'other_device' must be of the same type. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the device to its default state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.SampleStepperModulationDevice.md b/docs/API/renoise/renoise.SampleStepperModulationDevice.md similarity index 82% rename from docs/API/renoise.SampleStepperModulationDevice.md rename to docs/API/renoise/renoise.SampleStepperModulationDevice.md index 6170d967..90ff9db2 100644 --- a/docs/API/renoise.SampleStepperModulationDevice.md +++ b/docs/API/renoise/renoise.SampleStepperModulationDevice.md @@ -19,13 +19,13 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} ### external_editor_visible : [`boolean`](/API/builtins/boolean.md) {#external_editor_visible} External editor visibility. set to true to show the editor, false to close it @@ -33,36 +33,36 @@ set to true to show the editor, false to close it ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} ### length : [`integer`](/API/builtins/integer.md) {#length} Range: (1 - 256) -### length_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#length_observable} +### length_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#length_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Fixed name of the device. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### play_mode : [`renoise.SampleStepperModulationDevice.PlayMode`](renoise.SampleStepperModulationDevice.md#PlayMode) {#play_mode} Play mode (interpolation mode). -### play_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#play_mode_observable} +### play_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#play_mode_observable} ### play_step : [`integer`](/API/builtins/integer.md) {#play_step} Range: (-1 - 16) -### play_step_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#play_step_observable} +### play_step_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#play_step_observable} ### points : [`SampleStepperModulationDevice.Point`](/API/structs/SampleStepperModulationDevice.Point.md)`[]` {#points} Get all points of the envelope. When setting a new list of points, items may be unsorted by time, but there may not be multiple points @@ -70,7 +70,7 @@ for the same time. Returns a copy of the list, so changing `points[1].value` will not do anything. Instead, change them via `points = { something }`. -### points_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#points_observable} +### points_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#points_observable} ### short_name : [`string`](/API/builtins/string.md) {#short_name} **READ-ONLY** @@ -88,7 +88,7 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} --- @@ -99,9 +99,9 @@ Add a new point value (or replace any existing value) at time. Remove all points from the envelope. ### `clear_points_in_range`([*self*](/API/builtins/self.md), from_time : [`integer`](/API/builtins/integer.md), to_time : [`integer`](/API/builtins/integer.md)) {#clear_points_in_range} Remove points in the given [from, to) time range from the envelope. -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleStepperModulationDevice`](/API/renoise.SampleStepperModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleStepperModulationDevice`](/API/renoise/renoise.SampleStepperModulationDevice.md)) {#copy_from} Copy all properties from another SampleStepperModulation object. -### `copy_points_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleStepperModulationDevice`](/API/renoise.SampleStepperModulationDevice.md)) {#copy_points_from} +### `copy_points_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleStepperModulationDevice`](/API/renoise/renoise.SampleStepperModulationDevice.md)) {#copy_points_from} Copy all points from another SampleStepperModulation object. ### `has_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md)) {#has_point_at} `->`[`boolean`](/API/builtins/boolean.md) @@ -110,7 +110,7 @@ Test if a point exists at the given time. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the envelope back to its default initial state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.SampleVelocityTrackingModulationDevice.md b/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md similarity index 75% rename from docs/API/renoise.SampleVelocityTrackingModulationDevice.md rename to docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md index 5441a2d6..9a62e88e 100644 --- a/docs/API/renoise.SampleVelocityTrackingModulationDevice.md +++ b/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md @@ -16,42 +16,42 @@ Modulation polarity: when bipolar, the device applies it's values in a -1 to 1 range, when unipolar in a 0 to 1 range. -### bipolar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bipolar_observable} ### display_name : [`string`](/API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} ### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#enabled_observable} +### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} ### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_active_observable} -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** Generic access to all parameters of this device. ### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#is_maximized_observable} -### max : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#max} +### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### max : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#max} with range (0-127) -### min : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#min} +### min : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#min} with range (0-127) ### mode : [`renoise.SampleVelocityTrackingModulationDevice.Mode`](renoise.SampleVelocityTrackingModulationDevice.md#Mode) {#mode} Mode. -### mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#mode_observable} +### mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#mode_observable} ### name : [`string`](/API/builtins/string.md) {#name} **READ-ONLY** Fixed name of the device. ### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) {#operator} Modulation operator: how the device applies. -### operator_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#operator_observable} -### parameters : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md)`[]` {#parameters} +### operator_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#operator_observable} +### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** ### short_name : [`string`](/API/builtins/string.md) {#short_name} @@ -71,18 +71,18 @@ When true and the device supports sync switching the device operates in wall-clock (ms) instead of beat times. see also property 'tempo_sync_switching_allowed' -### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise.SampleModulationDevice.md)) {#copy_from} +### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/renoise.SampleModulationDevice.md)) {#copy_from} Copy a device's state from another device. 'other_device' must be of the same type. ### `init`([*self*](/API/builtins/self.md)) {#init} Reset the device to its default state. ### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) +`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) Access to a single parameter by index. Use properties 'parameters' to iterate over all parameters and to query the parameter count. diff --git a/docs/API/renoise.ScriptingTool.MidiMessage.md b/docs/API/renoise/renoise.ScriptingTool.MidiMessage.md similarity index 100% rename from docs/API/renoise.ScriptingTool.MidiMessage.md rename to docs/API/renoise/renoise.ScriptingTool.MidiMessage.md diff --git a/docs/API/renoise.ScriptingTool.md b/docs/API/renoise/renoise.ScriptingTool.md similarity index 83% rename from docs/API/renoise.ScriptingTool.md rename to docs/API/renoise/renoise.ScriptingTool.md index 47bada1e..4c093f39 100644 --- a/docs/API/renoise.ScriptingTool.md +++ b/docs/API/renoise/renoise.ScriptingTool.md @@ -8,12 +8,12 @@ attaching it to some common tool related notifiers. ### MidiMessage : [`table`](/API/builtins/table.md) {#MidiMessage} MIDI message as passed to the `invoke` callback in tool midi_mappings. -### app_became_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#app_became_active_observable} +### app_became_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#app_became_active_observable} Invoked as soon as the application becomes the foreground window. For example, when you ATL-TAB to it, or activate it with the mouse from another app to Renoise. -### app_idle_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#app_idle_observable} +### app_idle_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#app_idle_observable} Invoked periodically in the background, more often when the work load is low, less often when Renoise's work load is high. The exact interval is undefined and can not be relied on, but will be @@ -21,30 +21,30 @@ around 10 times per sec. You can do stuff in the background without blocking the application here. Be gentle and don't do CPU heavy stuff please! -### app_new_document_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#app_new_document_observable} +### app_new_document_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#app_new_document_observable} Invoked each time a new document (song) is created or loaded. In other words: each time the result of renoise.song() is changed. Also called when the script gets reloaded (only happens with the auto_reload debugging tools), in order to connect the new script instance to the already running document. -### app_release_document_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#app_release_document_observable} +### app_release_document_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#app_release_document_observable} Invoked each time before a new document gets created or loaded: this is the last time renoise.song() still points to the old song before a new one arrives. You can explicitly release notifiers to the old document here, or do your own housekeeping. Also called right before the application exits. -### app_resigned_active_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#app_resigned_active_observable} +### app_resigned_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#app_resigned_active_observable} Invoked as soon as the application looses focus and another app becomes the foreground window. -### app_saved_document_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#app_saved_document_observable} +### app_saved_document_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#app_saved_document_observable} Invoked each time the app's document (song) is successfully saved. renoise.song().file_name will point to the filename that it was saved to. ### bundle_path : [`string`](/API/builtins/string.md) {#bundle_path} **READ_ONLY** Full absolute path and name to your tool's bundle directory. -### preferences : [`renoise.Document.DocumentNode`](/API/renoise.Document.DocumentNode.md) {#preferences} +### preferences : [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) {#preferences} Get or set an optional renoise.Document.DocumentNode object, which will be used as set of persistent "options" or preferences for your tool. By default nil. When set, the assigned document object will automatically be @@ -80,14 +80,14 @@ renoise.tool().preferences = my_options -- 'my_options' will be loaded/saved automatically with the tool now ``` -### tool_finished_loading_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tool_finished_loading_observable} +### tool_finished_loading_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tool_finished_loading_observable} Invoked when the tool finished loading/initializing and no errors happened. When the tool has preferences, they are loaded here as well when the notification fires, but 'renoise.song()' may not yet be available. See also 'renoise.tool().app_new_document_observable'. -### tool_will_unload_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tool_will_unload_observable} +### tool_will_unload_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tool_will_unload_observable} Invoked right before a tool gets unloaded: either because it got disabled, reloaded or the application exists. You can cleanup resources or connections to other devices here if necessary. @@ -104,7 +104,7 @@ Register key bindings somewhere in Renoise's existing set of bindings. Add a new menu entry. ### `add_midi_mapping`([*self*](/API/builtins/self.md), midi_mapping : [`ToolMidiMappingEntry`](/API/structs/ToolMidiMappingEntry.md)) {#add_midi_mapping} Add a new midi_mapping entry. -### `add_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](/API/aliases/TimerFunction.md), interval_in_ms : [`number`](/API/builtins/number.md)) {#add_timer} +### `add_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction), interval_in_ms : [`number`](/API/builtins/number.md)) {#add_timer} Register a timer function or table with a function and context (a method) that periodically gets called by the `app_idle_observable` for your tool. @@ -114,7 +114,7 @@ simply call remove_timer at the end of your timer function. `interval_in_ms` must be > 0. The exact interval your function is called will vary a bit, depending on workload; e.g. when enough CPU time is available the rounding error will be around +/- 5 ms. -### `has_file_import_hook`([*self*](/API/builtins/self.md), category : [`FileHookCategory`](/API/aliases/FileHookCategory.md), extensions_table : [`string`](/API/builtins/string.md)`[]`) {#has_file_import_hook} +### `has_file_import_hook`([*self*](/API/builtins/self.md), category : [`FileHookCategory`](#FileHookCategory), extensions_table : [`string`](/API/builtins/string.md)`[]`) {#has_file_import_hook} `->`[`boolean`](/API/builtins/boolean.md) Returns true when the given hook already exists, otherwise false. @@ -142,11 +142,11 @@ Returns true if the given entry already exists, otherwise false. `->`[`boolean`](/API/builtins/boolean.md) Returns true when the given mapping already exists, otherwise false. -### `has_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](/API/aliases/TimerFunction.md)) {#has_timer} +### `has_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction)) {#has_timer} `->`[`boolean`](/API/builtins/boolean.md) Returns true when the given function or method was registered as a timer. -### `remove_file_import_hook`([*self*](/API/builtins/self.md), category : [`FileHookCategory`](/API/aliases/FileHookCategory.md), extensions_table : [`string`](/API/builtins/string.md)`[]`) {#remove_file_import_hook} +### `remove_file_import_hook`([*self*](/API/builtins/self.md), category : [`FileHookCategory`](#FileHookCategory), extensions_table : [`string`](/API/builtins/string.md)`[]`) {#remove_file_import_hook} Remove a previously added file import hook by specifying its category and extension(s) @@ -167,6 +167,27 @@ Remove a previously added key binding by specifying its name and path. Remove a previously added menu entry by specifying its full name. ### `remove_midi_mapping`([*self*](/API/builtins/self.md), midi_mapping_name : [`string`](/API/builtins/string.md)) {#remove_midi_mapping} Remove a previously added midi mapping by specifying its name. -### `remove_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](/API/aliases/TimerFunction.md)) {#remove_timer} +### `remove_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction)) {#remove_timer} Remove a previously registered timer. + + +--- +## Aliases +# alias FileHookCategory {#FileHookCategory} +`"effect chain"` | `"effect preset"` | `"instrument"` | `"modulation set"` | `"phrase"` | `"sample"` | `"song"` | `"theme"` +```lua +FileHookCategory: + | "song" + | "instrument" + | "effect chain" + | "effect preset" + | "modulation set" + | "phrase" + | "sample" + | "theme" +``` +# alias TimerFunction {#TimerFunction} +fun() + + diff --git a/docs/API/renoise.Socket.SocketBase.md b/docs/API/renoise/renoise.Socket.SocketBase.md similarity index 100% rename from docs/API/renoise.Socket.SocketBase.md rename to docs/API/renoise/renoise.Socket.SocketBase.md diff --git a/docs/API/renoise.Socket.SocketClient.md b/docs/API/renoise/renoise.Socket.SocketClient.md similarity index 94% rename from docs/API/renoise.Socket.SocketClient.md rename to docs/API/renoise/renoise.Socket.SocketClient.md index e0ae4123..762ae42e 100644 --- a/docs/API/renoise.Socket.SocketClient.md +++ b/docs/API/renoise/renoise.Socket.SocketClient.md @@ -45,7 +45,7 @@ the socket useless, so any properties, calls to the socket will result in errors. Can be useful to explicitly release a connection without waiting for the dead object to be garbage collected, or if you want to actively refuse a connection. -### `receive`([*self*](/API/builtins/self.md), mode : [`SocketReceiveMode`](/API/aliases/SocketReceiveMode.md), timeout_ms : [`number`](/API/builtins/number.md)) {#receive} +### `receive`([*self*](/API/builtins/self.md), mode : [`SocketReceiveMode`](#SocketReceiveMode), timeout_ms : [`number`](/API/builtins/number.md)) {#receive} `->`success : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) Receive a message string from the the connected server with the given @@ -96,3 +96,15 @@ NB: when using TCP instead of UDP as protocol for OSC messages, !no! SLIP encoding and no size prefixing of the passed OSC data will be done here. So, when necessary, do this manually by your own please. + + +--- +## Aliases +# alias SocketReceiveMode {#SocketReceiveMode} +[`integer`](/API/builtins/integer.md) | `"*all"` | `"*line"` +```lua +SocketReceiveMode: + | "*line" + | "*all" +``` + diff --git a/docs/API/renoise.Socket.SocketServer.md b/docs/API/renoise/renoise.Socket.SocketServer.md similarity index 100% rename from docs/API/renoise.Socket.SocketServer.md rename to docs/API/renoise/renoise.Socket.SocketServer.md diff --git a/docs/API/renoise.Socket.md b/docs/API/renoise/renoise.Socket.md similarity index 79% rename from docs/API/renoise.Socket.md rename to docs/API/renoise/renoise.Socket.md index b769bfee..632e1306 100644 --- a/docs/API/renoise.Socket.md +++ b/docs/API/renoise/renoise.Socket.md @@ -3,7 +3,7 @@ --- ## Functions ### `create_client`(server_address : [`string`](/API/builtins/string.md), server_port : [`integer`](/API/builtins/integer.md), protocol : [`renoise.Socket.Protocol`](renoise.Socket.md#Protocol)[`?`](/API/builtins/nil.md), timeout : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md)) {#create_client} -`->`client : [`renoise.Socket.SocketClient`](/API/renoise.Socket.SocketClient.md)[`?`](/API/builtins/nil.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +`->`client : [`renoise.Socket.SocketClient`](/API/renoise/renoise.Socket.SocketClient.md)[`?`](/API/builtins/nil.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) Create a connected UPD or TCP client. `protocol` can be `renoise.Socket.PROTOCOL_TCP` or @@ -12,7 +12,7 @@ Create a connected UPD or TCP client. (1000 ms by default). When instantiation and connection succeed, a valid client object is returned, otherwise "error" is set and the client object is nil ### `create_server`(server_address : [`string`](/API/builtins/string.md), server_port : [`integer`](/API/builtins/integer.md), protocol : [`renoise.Socket.Protocol`](renoise.Socket.md#Protocol)[`?`](/API/builtins/nil.md)) {#create_server} -`->`[`renoise.Socket.SocketServer`](/API/renoise.Socket.SocketServer.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Socket.SocketServer`](/API/renoise/renoise.Socket.SocketServer.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) Creates a connected UPD or TCP server object. Use "localhost" to use your system's default network address. Protocol can be `renoise.Socket.PROTOCOL_TCP` diff --git a/docs/API/renoise.Song.md b/docs/API/renoise/renoise.Song.md similarity index 80% rename from docs/API/renoise.Song.md rename to docs/API/renoise/renoise.Song.md index aab8c39a..3f3053ac 100644 --- a/docs/API/renoise.Song.md +++ b/docs/API/renoise/renoise.Song.md @@ -23,132 +23,132 @@ Renoise's main document - the song. ### artist : [`string`](/API/builtins/string.md) {#artist} Song Comments -### artist_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#artist_observable} +### artist_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#artist_observable} ### comments : [`string`](/API/builtins/string.md)`[]` {#comments} Note: All property tables of basic types in the API are temporary copies. In other words `comments = { "Hello", "World" }` will work, `comments[1] = "Hello"; renoise.song().comments[2] = "World"` will *not* work. -### comments_assignment_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#comments_assignment_observable} +### comments_assignment_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#comments_assignment_observable} **READ-ONLY** Notifier is called as soon as any paragraph in the comments change. -### comments_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#comments_observable} +### comments_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#comments_observable} ### file_name : [`string`](/API/builtins/string.md) {#file_name} **READ-ONLY** When the song is loaded from or saved to a file, the absolute path and name to the XRNS file, otherwise an empty string. -### instruments : [`renoise.Instrument`](/API/renoise.Instrument.md)`[]` {#instruments} +### instruments : [`renoise.Instrument`](/API/renoise/renoise.Instrument.md)`[]` {#instruments} **READ-ONLY** Instrument, Pattern, and Track arrays -### instruments_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#instruments_observable} +### instruments_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#instruments_observable} ### name : [`string`](/API/builtins/string.md) {#name} -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} -### pattern_iterator : [`renoise.PatternIterator`](/API/renoise.PatternIterator.md) {#pattern_iterator} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### pattern_iterator : [`renoise.PatternIterator`](/API/renoise/renoise.PatternIterator.md) {#pattern_iterator} **READ-ONLY** -### patterns : [`renoise.Pattern`](/API/renoise.Pattern.md)`[]` {#patterns} -### patterns_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#patterns_observable} +### patterns : [`renoise.Pattern`](/API/renoise/renoise.Pattern.md)`[]` {#patterns} +### patterns_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#patterns_observable} ### rendering : [`boolean`](/API/builtins/boolean.md) {#rendering} **READ-ONLY** True while rendering is in progress. ### rendering_progress : [`number`](/API/builtins/number.md) {#rendering_progress} Range: (0.0 - 1.0) -### selected_automation_device : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md) {#selected_automation_device} +### selected_automation_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) {#selected_automation_device} **READ-ONLY** parent device of 'selected_automation_parameter'. not settable. -### selected_automation_device_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_automation_device_observable} -### selected_automation_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#selected_automation_parameter} +### selected_automation_device_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_automation_device_observable} +### selected_automation_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#selected_automation_parameter} Selected parameter in the automation editor. When setting a new parameter, parameter must be automateable and must be one of the currently selected track device chain. -### selected_automation_parameter_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_automation_parameter_observable} -### selected_device : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md) {#selected_device} +### selected_automation_parameter_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_automation_parameter_observable} +### selected_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) {#selected_device} ### selected_device_index : [`integer`](/API/builtins/integer.md) {#selected_device_index} -### selected_device_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_device_observable} -### selected_effect_column : [`renoise.EffectColumn`](/API/renoise.EffectColumn.md) {#selected_effect_column} +### selected_device_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_device_observable} +### selected_effect_column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md) {#selected_effect_column} **READ-ONLY** The currently edited column in the selected line in the edited sequence/pattern. Nil when a note column is selected. ### selected_effect_column_index : [`integer`](/API/builtins/integer.md) {#selected_effect_column_index} -### selected_instrument : [`renoise.Instrument`](/API/renoise.Instrument.md) {#selected_instrument} +### selected_instrument : [`renoise.Instrument`](/API/renoise/renoise.Instrument.md) {#selected_instrument} **READ-ONLY** Selected in the instrument box. ### selected_instrument_index : [`integer`](/API/builtins/integer.md) {#selected_instrument_index} -### selected_instrument_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_instrument_index_observable} -### selected_instrument_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_instrument_observable} -### selected_line : [`renoise.PatternLine`](/API/renoise.PatternLine.md) {#selected_line} +### selected_instrument_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_instrument_index_observable} +### selected_instrument_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_instrument_observable} +### selected_line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md) {#selected_line} **READ-ONLY** The currently edited line in the edited pattern. ### selected_line_index : [`integer`](/API/builtins/integer.md) {#selected_line_index} -### selected_note_column : [`renoise.NoteColumn`](/API/renoise.NoteColumn.md) {#selected_note_column} +### selected_note_column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md) {#selected_note_column} **READ-ONLY** The currently edited column in the selected line in the edited sequence/pattern. Nil when an effect column is selected. ### selected_note_column_index : [`integer`](/API/builtins/integer.md) {#selected_note_column_index} -### selected_parameter : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#selected_parameter} -### selected_parameter_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_parameter_observable} -### selected_pattern : [`renoise.Pattern`](/API/renoise.Pattern.md) {#selected_pattern} +### selected_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#selected_parameter} +### selected_parameter_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_parameter_observable} +### selected_pattern : [`renoise.Pattern`](/API/renoise/renoise.Pattern.md) {#selected_pattern} **READ-ONLY** The currently edited pattern. ### selected_pattern_index : [`integer`](/API/builtins/integer.md) {#selected_pattern_index} **READ-ONLY** The currently edited pattern index. -### selected_pattern_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_pattern_index_observable} -### selected_pattern_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_pattern_observable} -### selected_pattern_track : [`renoise.PatternTrack`](/API/renoise.PatternTrack.md) {#selected_pattern_track} +### selected_pattern_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_pattern_index_observable} +### selected_pattern_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_pattern_observable} +### selected_pattern_track : [`renoise.PatternTrack`](/API/renoise/renoise.PatternTrack.md) {#selected_pattern_track} **READ-ONLY** The currently edited pattern track object. and selected_track_observable for notifications. -### selected_pattern_track_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_pattern_track_observable} -### selected_phrase : [`renoise.InstrumentPhrase`](/API/renoise.InstrumentPhrase.md) {#selected_phrase} +### selected_pattern_track_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_pattern_track_observable} +### selected_phrase : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md) {#selected_phrase} **READ-ONLY** Currently selected phrase the instrument's phrase map piano view. ### selected_phrase_index : [`integer`](/API/builtins/integer.md) {#selected_phrase_index} -### selected_phrase_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_phrase_observable} -### selected_sample : [`renoise.Sample`](/API/renoise.Sample.md) {#selected_sample} +### selected_phrase_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_phrase_observable} +### selected_sample : [`renoise.Sample`](/API/renoise/renoise.Sample.md) {#selected_sample} **READ-ONLY** Selected in the instrument's sample list. Only nil when no samples are present in the selected instrument. -### selected_sample_device : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md) {#selected_sample_device} +### selected_sample_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) {#selected_sample_device} **READ-ONLY** Selected in the sample effect mixer. -### selected_sample_device_chain : [`renoise.SampleDeviceChain`](/API/renoise.SampleDeviceChain.md) {#selected_sample_device_chain} +### selected_sample_device_chain : [`renoise.SampleDeviceChain`](/API/renoise/renoise.SampleDeviceChain.md) {#selected_sample_device_chain} **READ-ONLY** Selected in the instrument's effects view. ### selected_sample_device_chain_index : [`integer`](/API/builtins/integer.md) {#selected_sample_device_chain_index} -### selected_sample_device_chain_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_sample_device_chain_observable} +### selected_sample_device_chain_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_sample_device_chain_observable} ### selected_sample_device_index : [`integer`](/API/builtins/integer.md) {#selected_sample_device_index} -### selected_sample_device_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_sample_device_observable} +### selected_sample_device_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_sample_device_observable} ### selected_sample_index : [`integer`](/API/builtins/integer.md) {#selected_sample_index} -### selected_sample_modulation_set : [`renoise.SampleModulationSet`](/API/renoise.SampleModulationSet.md) {#selected_sample_modulation_set} +### selected_sample_modulation_set : [`renoise.SampleModulationSet`](/API/renoise/renoise.SampleModulationSet.md) {#selected_sample_modulation_set} **READ-ONLY** Selected in the instrument's modulation view. ### selected_sample_modulation_set_index : [`integer`](/API/builtins/integer.md) {#selected_sample_modulation_set_index} -### selected_sample_modulation_set_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_sample_modulation_set_observable} -### selected_sample_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_sample_observable} +### selected_sample_modulation_set_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_sample_modulation_set_observable} +### selected_sample_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_sample_observable} ### selected_sequence_index : [`integer`](/API/builtins/integer.md) {#selected_sequence_index} The currently edited sequence position. -### selected_sequence_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_sequence_index_observable} +### selected_sequence_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_sequence_index_observable} ### selected_sub_column_type : [`renoise.Song.SubColumnType`](renoise.Song.md#SubColumnType) {#selected_sub_column_type} **READ-ONLY** The currently edited sub column type within the selected note/effect column. -### selected_track : [`renoise.Track`](/API/renoise.Track.md) {#selected_track} +### selected_track : [`renoise.Track`](/API/renoise/renoise.Track.md) {#selected_track} **READ-ONLY** Selected in the pattern editor or mixer. -### selected_track_device : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md) {#selected_track_device} +### selected_track_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) {#selected_track_device} **READ-ONLY** Selected in the track DSP chain editor. ### selected_track_device_index : [`integer`](/API/builtins/integer.md) {#selected_track_device_index} -### selected_track_device_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_track_device_observable} +### selected_track_device_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_track_device_observable} ### selected_track_index : [`integer`](/API/builtins/integer.md) {#selected_track_index} -### selected_track_index_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_track_index_observable} -### selected_track_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#selected_track_observable} +### selected_track_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_track_index_observable} +### selected_track_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_track_observable} ### selection_in_pattern : [`PatternSelection`](/API/structs/PatternSelection.md)[`?`](/API/builtins/nil.md) {#selection_in_pattern} Read/write access to the selection in the pattern editor. @@ -178,7 +178,7 @@ Same as `selection_in_pattern` but for the currently selected phrase (if any). ### send_track_count : [`integer`](/API/builtins/integer.md) {#send_track_count} -**READ-ONLY** number of send tracks in song. -### sequencer : [`renoise.PatternSequencer`](/API/renoise.PatternSequencer.md) {#sequencer} +### sequencer : [`renoise.PatternSequencer`](/API/renoise/renoise.PatternSequencer.md) {#sequencer} **READ-ONLY** ### sequencer_track_count : [`integer`](/API/builtins/integer.md) {#sequencer_track_count} @@ -187,7 +187,7 @@ Same as `selection_in_pattern` but for the currently selected phrase (if any). ### show_comments_after_loading : [`boolean`](/API/builtins/boolean.md) {#show_comments_after_loading} Set this to true to show the comments dialog after loading a song -### show_comments_after_loading_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#show_comments_after_loading_observable} +### show_comments_after_loading_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#show_comments_after_loading_observable} ### tool_data : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) {#tool_data} Inject/fetch custom XRNX scripting tool data into the song. Can only be called from scripts that are running in Renoise scripting tool bundles; attempts to @@ -201,9 +201,9 @@ If you want to store renoise.Document data in here, you can use the renoise.Document's 'to_string' and 'from_string' functions to serialize the data. Alternatively, write your own serializers for your custom data. -### tracks : [`renoise.Track`](/API/renoise.Track.md)`[]` {#tracks} -### tracks_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#tracks_observable} -### transport : [`renoise.Transport`](/API/renoise.Transport.md) {#transport} +### tracks : [`renoise.Track`](/API/renoise/renoise.Track.md)`[]` {#tracks} +### tracks_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#tracks_observable} +### transport : [`renoise.Transport`](/API/renoise/renoise.Transport.md) {#transport} **READ-ONLY** @@ -261,24 +261,24 @@ If those auto-generated names do not work for you, or you want to use something more descriptive, you can (!before changing anything in the song!) give your changes a custom undo description (like: "Generate Synth Sample") ### `insert_group_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#insert_group_at} -`->`[`renoise.GroupTrack`](/API/renoise.GroupTrack.md) +`->`[`renoise.GroupTrack`](/API/renoise/renoise.GroupTrack.md) Insert a new group track at the given index. Group tracks can only be inserted before the Master track. ### `insert_instrument_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#insert_instrument_at} -`->`[`renoise.Instrument`](/API/renoise.Instrument.md) +`->`[`renoise.Instrument`](/API/renoise/renoise.Instrument.md) Insert a new instrument at the given index. This will remap all existing notes in all patterns, if needed, and also update all other instrument links in the song. Can't have more than MAX_NUMBER_OF_INSTRUMENTS in a song. ### `insert_track_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#insert_track_at} -`->`[`renoise.Track`](/API/renoise.Track.md) +`->`[`renoise.Track`](/API/renoise/renoise.Track.md) Insert a new track at the given index. Inserting a track behind or at the Master Track's index will create a Send Track. Otherwise, a regular track is created. ### `instrument`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#instrument} -`->`[`renoise.Instrument`](/API/renoise.Instrument.md) +`->`[`renoise.Instrument`](/API/renoise/renoise.Instrument.md) Access to a single instrument by index. Use properties 'instruments' to iterate over all instruments and to query the instrument count. @@ -288,7 +288,7 @@ over all instruments and to query the instrument count. Load all global MIDI mappings in the song into a XRNM file. Returns true when loading/saving succeeded, else false and the error message. ### `pattern`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#pattern} -`->`[`renoise.Pattern`](/API/renoise.Pattern.md) +`->`[`renoise.Pattern`](/API/renoise/renoise.Pattern.md) Access to a single pattern by index. Use properties 'patterns' to iterate over all patterns and to query the pattern count. @@ -343,7 +343,7 @@ Swap the positions of two tracks. A Send can only be swapped with a Send track and a regular track can only be swapped with another regular track. The Master can not be swapped at all. ### `track`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#track} -`->`[`renoise.Track`](/API/renoise.Track.md) +`->`[`renoise.Track`](/API/renoise/renoise.Track.md) Access to a single track by index. Use properties 'tracks' to iterate over all tracks and to query the track count. diff --git a/docs/API/renoise.SongPos.md b/docs/API/renoise/renoise.SongPos.md similarity index 100% rename from docs/API/renoise.SongPos.md rename to docs/API/renoise/renoise.SongPos.md diff --git a/docs/API/renoise.Track.md b/docs/API/renoise/renoise.Track.md similarity index 73% rename from docs/API/renoise.Track.md rename to docs/API/renoise/renoise.Track.md index 9141ae2f..b3554cbf 100644 --- a/docs/API/renoise.Track.md +++ b/docs/API/renoise/renoise.Track.md @@ -34,8 +34,8 @@ Track component of a Renoise song. ### collapsed : [`boolean`](/API/builtins/boolean.md) {#collapsed} Collapsed/expanded visual appearance. -### collapsed_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#collapsed_observable} -### color : [`RGBColor`](/API/aliases/RGBColor.md) {#color} +### collapsed_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#collapsed_observable} +### color : [`RGBColor`](#RGBColor) {#color} 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 @@ -44,15 +44,15 @@ representing the red, green and blue channels of a color. ### color_blend : [`integer`](/API/builtins/integer.md) {#color_blend} Range: (0 - 100) Color blend in percent -### color_blend_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#color_blend_observable} -### color_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#color_observable} +### color_blend_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_blend_observable} +### color_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_observable} ### delay_column_visible : [`boolean`](/API/builtins/boolean.md) {#delay_column_visible} -### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#delay_column_visible_observable} -### devices : [`renoise.AudioDevice`](/API/renoise.AudioDevice.md)`[]` {#devices} +### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} +### devices : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md)`[]` {#devices} **READ-ONLY** List of audio DSP FX. -### devices_observable : [`renoise.Document.ObservableList`](/API/renoise.Document.ObservableList.md) {#devices_observable} -### group_parent : [`renoise.GroupTrack`](/API/renoise.GroupTrack.md) {#group_parent} +### devices_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#devices_observable} +### group_parent : [`renoise.GroupTrack`](/API/renoise/renoise.GroupTrack.md) {#group_parent} **READ-ONLY** ### max_effect_columns : [`integer`](/API/builtins/integer.md) {#max_effect_columns} @@ -70,53 +70,53 @@ Range: (0 - 100) Color blend in percent ### mute_state : [`renoise.Track.MuteState`](renoise.Track.md#MuteState) {#mute_state} Mute and solo states. Not available for the master track. -### mute_state_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#mute_state_observable} +### mute_state_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#mute_state_observable} ### name : [`string`](/API/builtins/string.md) {#name} Name, as visible in track headers -### name_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} ### output_delay : [`number`](/API/builtins/number.md) {#output_delay} Range: (-100.0-100.0) in ms -### output_delay_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#output_delay_observable} +### output_delay_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_delay_observable} ### output_routing : [`string`](/API/builtins/string.md) {#output_routing} One of `available_output_routings` -### output_routing_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#output_routing_observable} +### output_routing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_routing_observable} ### panning_column_visible : [`boolean`](/API/builtins/boolean.md) {#panning_column_visible} -### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#panning_column_visible_observable} -### postfx_panning : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#postfx_panning} +### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} +### postfx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_panning} **READ-ONLY** -### postfx_volume : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#postfx_volume} +### postfx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_volume} **READ-ONLY** -### prefx_panning : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#prefx_panning} +### prefx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_panning} **READ-ONLY** -### prefx_volume : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#prefx_volume} +### prefx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_volume} **READ-ONLY** -### prefx_width : [`renoise.DeviceParameter`](/API/renoise.DeviceParameter.md) {#prefx_width} +### prefx_width : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_width} **READ-ONLY** ### sample_effects_column_visible : [`boolean`](/API/builtins/boolean.md) {#sample_effects_column_visible} -### sample_effects_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} +### sample_effects_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} ### solo_state : [`boolean`](/API/builtins/boolean.md) {#solo_state} -### solo_state_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#solo_state_observable} +### solo_state_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#solo_state_observable} ### type : [`renoise.Track.TrackType`](renoise.Track.md#TrackType) {#type} **READ-ONLY** ### visible_effect_columns : [`integer`](/API/builtins/integer.md) {#visible_effect_columns} 1-8 OR 0-8, depending on the track type -### visible_effect_columns_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#visible_effect_columns_observable} +### visible_effect_columns_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#visible_effect_columns_observable} ### visible_note_columns : [`integer`](/API/builtins/integer.md) {#visible_note_columns} 0 OR 1-12, depending on the track type -### visible_note_columns_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#visible_note_columns_observable} +### visible_note_columns_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#visible_note_columns_observable} ### volume_column_visible : [`boolean`](/API/builtins/boolean.md) {#volume_column_visible} -### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#volume_column_visible_observable} +### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} --- @@ -126,20 +126,20 @@ One of `available_output_routings` Note column mutes. Only valid within (1-track.max_note_columns) ### `column_is_muted_observable`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_is_muted_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) ### `column_name`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_name} `->`[`string`](/API/builtins/string.md) Note column names. Only valid within (1-track.max_note_columns) ### `column_name_observable`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_name_observable} -`->`[`renoise.Document.Observable`](/API/renoise.Document.Observable.md) +`->`[`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) ### `delete_device_at`([*self*](/API/builtins/self.md), device_index : [`any`](/API/builtins/any.md)) {#delete_device_at} Delete an existing device in a track. The mixer device at index 1 can not be deleted from any track. ### `insert_device_at`([*self*](/API/builtins/self.md), device_path : [`string`](/API/builtins/string.md), device_index : [`integer`](/API/builtins/integer.md)) {#insert_device_at} -`->`[`renoise.AudioDevice`](/API/renoise.AudioDevice.md) +`->`[`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) Insert a new device at the given position. `device_path` must be one of `renoise.Track.available_devices`. @@ -156,3 +156,14 @@ index 1 can not be swapped or moved. Swap the positions of two note or effect columns within a track. ### `unmute`([*self*](/API/builtins/self.md)) {#unmute} + + +--- +## Aliases +# alias RGBColor {#RGBColor} +{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +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.Transport.md b/docs/API/renoise/renoise.Transport.md similarity index 77% rename from docs/API/renoise.Transport.md rename to docs/API/renoise/renoise.Transport.md index f0d75a67..add78acf 100644 --- a/docs/API/renoise.Transport.md +++ b/docs/API/renoise/renoise.Transport.md @@ -1,13 +1,6 @@ # renoise.Transport Transport component of the Renoise song. ## Constants -### PlayMode {#PlayMode} -```lua -{ - PLAYMODE_RESTART_PATTERN: integer = 1, - PLAYMODE_CONTINUE_PATTERN: integer = 2, -} -``` ### RecordParameterMode {#RecordParameterMode} ```lua { @@ -22,6 +15,13 @@ Transport component of the Renoise song. TIMING_MODEL_LPB: integer = 2, } ``` +### PlayMode {#PlayMode} +```lua +{ + PLAYMODE_RESTART_PATTERN: integer = 1, + PLAYMODE_CONTINUE_PATTERN: integer = 2, +} +``` --- @@ -29,12 +29,12 @@ Transport component of the Renoise song. ### bpm : [`number`](/API/builtins/number.md) {#bpm} Range: (32 - 999) Beats per Minute -### bpm_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#bpm_observable} +### bpm_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bpm_observable} ### edit_mode : [`boolean`](/API/builtins/boolean.md) {#edit_mode} Edit modes -### edit_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#edit_mode_observable} -### edit_pos : [`renoise.SongPos`](/API/renoise.SongPos.md) {#edit_pos} +### edit_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#edit_mode_observable} +### edit_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#edit_pos} Edit position ### edit_pos_beats : [`number`](/API/builtins/number.md) {#edit_pos_beats} @@ -43,39 +43,39 @@ Range: (0 - song_end_beats) Song position in beats ### edit_step : [`integer`](/API/builtins/integer.md) {#edit_step} Range: (0 - 64) -### edit_step_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#edit_step_observable} +### edit_step_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#edit_step_observable} ### follow_player : [`boolean`](/API/builtins/boolean.md) {#follow_player} Follow, wrapped pattern, single track modes -### follow_player_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#follow_player_observable} +### follow_player_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#follow_player_observable} ### groove_amounts : [`number`](/API/builtins/number.md)`[]` {#groove_amounts} table with 4 numbers in Range: (0 - 1) -### groove_assignment_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#groove_assignment_observable} +### groove_assignment_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#groove_assignment_observable} Attach notifiers that will be called as soon as any groove value changed. ### groove_enabled : [`boolean`](/API/builtins/boolean.md) {#groove_enabled} Groove. (aka Shuffle) -### groove_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#groove_enabled_observable} +### groove_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#groove_enabled_observable} ### keyboard_velocity : [`integer`](/API/builtins/integer.md) {#keyboard_velocity} Range: (0 - 127) ### keyboard_velocity_enabled : [`boolean`](/API/builtins/boolean.md) {#keyboard_velocity_enabled} Computer Keyboard Velocity. -### keyboard_velocity_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#keyboard_velocity_enabled_observable} -### keyboard_velocity_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#keyboard_velocity_observable} +### keyboard_velocity_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#keyboard_velocity_enabled_observable} +### keyboard_velocity_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#keyboard_velocity_observable} ### loop_block_enabled : [`boolean`](/API/builtins/boolean.md) {#loop_block_enabled} Block Loop On/Off ### loop_block_range_coeff : [`integer`](/API/builtins/integer.md) {#loop_block_range_coeff} Range: (2 - 16) -### loop_block_start_pos : [`renoise.SongPos`](/API/renoise.SongPos.md) {#loop_block_start_pos} +### loop_block_start_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#loop_block_start_pos} Start of block loop -### loop_end : [`renoise.SongPos`](/API/renoise.SongPos.md) {#loop_end} +### loop_end : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#loop_end} **READ-ONLY** ### loop_end_beats : [`number`](/API/builtins/number.md) {#loop_end_beats} @@ -84,8 +84,8 @@ Start of block loop ### loop_pattern : [`boolean`](/API/builtins/boolean.md) {#loop_pattern} Pattern Loop On/Off -### loop_pattern_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#loop_pattern_observable} -### loop_range : [`renoise.SongPos`](/API/renoise.SongPos.md)`[]` {#loop_range} +### loop_pattern_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_pattern_observable} +### loop_range : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md)`[]` {#loop_range} {loop start, loop end} ### loop_range_beats : [`number`](/API/builtins/number.md)`[]` {#loop_range_beats} @@ -100,7 +100,7 @@ Pattern Loop On/Off ### loop_sequence_start : [`integer`](/API/builtins/integer.md) {#loop_sequence_start} **READ-ONLY** 0 or Range: (1 - sequence length) -### loop_start : [`renoise.SongPos`](/API/renoise.SongPos.md) {#loop_start} +### loop_start : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#loop_start} **READ-ONLY** ### loop_start_beats : [`number`](/API/builtins/number.md) {#loop_start_beats} @@ -109,32 +109,32 @@ Pattern Loop On/Off ### lpb : [`integer`](/API/builtins/integer.md) {#lpb} Range: (1 - 256) Lines per Beat -### lpb_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#lpb_observable} +### lpb_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#lpb_observable} ### metronome_beats_per_bar : [`integer`](/API/builtins/integer.md) {#metronome_beats_per_bar} Range: (1 - 16) -### metronome_beats_per_bar_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#metronome_beats_per_bar_observable} +### metronome_beats_per_bar_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#metronome_beats_per_bar_observable} ### metronome_enabled : [`boolean`](/API/builtins/boolean.md) {#metronome_enabled} Metronome -### metronome_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#metronome_enabled_observable} +### metronome_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#metronome_enabled_observable} ### metronome_lines_per_beat : [`integer`](/API/builtins/integer.md) {#metronome_lines_per_beat} Range: (1 - 256) or 0 = songs current LPB -### metronome_lines_per_beat_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#metronome_lines_per_beat_observable} +### metronome_lines_per_beat_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#metronome_lines_per_beat_observable} ### metronome_precount_bars : [`integer`](/API/builtins/integer.md) {#metronome_precount_bars} Range: (1 - 4) -### metronome_precount_bars_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#metronome_precount_bars_observable} +### metronome_precount_bars_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#metronome_precount_bars_observable} ### metronome_precount_enabled : [`boolean`](/API/builtins/boolean.md) {#metronome_precount_enabled} Metronome precount -### metronome_precount_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#metronome_precount_enabled_observable} +### metronome_precount_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#metronome_precount_enabled_observable} ### octave : [`integer`](/API/builtins/integer.md) {#octave} Range: (0 - 8) -### octave_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#octave_observable} -### playback_pos : [`renoise.SongPos`](/API/renoise.SongPos.md) {#playback_pos} +### octave_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#octave_observable} +### playback_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#playback_pos} Playback position ### playback_pos_beats : [`number`](/API/builtins/number.md) {#playback_pos_beats} @@ -143,22 +143,22 @@ Range: (0 - song_end_beats) Song position in beats ### playing : [`boolean`](/API/builtins/boolean.md) {#playing} Playing -### playing_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#playing_observable} +### playing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#playing_observable} ### record_parameter_mode : [`renoise.Transport.RecordParameterMode`](renoise.Transport.md#RecordParameterMode) {#record_parameter_mode} Record parameter -### record_parameter_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#record_parameter_mode_observable} +### record_parameter_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#record_parameter_mode_observable} ### record_quantize_enabled : [`boolean`](/API/builtins/boolean.md) {#record_quantize_enabled} Quantize -### record_quantize_enabled_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#record_quantize_enabled_observable} +### record_quantize_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#record_quantize_enabled_observable} ### record_quantize_lines : [`integer`](/API/builtins/integer.md) {#record_quantize_lines} Range: (1 - 32) -### record_quantize_lines_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#record_quantize_lines_observable} +### record_quantize_lines_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#record_quantize_lines_observable} ### single_track_edit_mode : [`boolean`](/API/builtins/boolean.md) {#single_track_edit_mode} -### single_track_edit_mode_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#single_track_edit_mode_observable} -### song_length : [`renoise.SongPos`](/API/renoise.SongPos.md) {#song_length} +### single_track_edit_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#single_track_edit_mode_observable} +### song_length : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#song_length} **READ-ONLY** ### song_length_beats : [`number`](/API/builtins/number.md) {#song_length_beats} @@ -173,13 +173,13 @@ only and lpb defines relationship between pattern lines and beats. ### tpl : [`integer`](/API/builtins/integer.md) {#tpl} Range: (1 - 16) Ticks per Line -### tpl_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#tpl_observable} +### tpl_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tpl_observable} ### track_headroom : [`number`](/API/builtins/number.md) {#track_headroom} Range: (math.db2lin(-12) - math.db2lin(0)) -### track_headroom_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#track_headroom_observable} +### track_headroom_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#track_headroom_observable} ### wrapped_pattern_edit : [`boolean`](/API/builtins/boolean.md) {#wrapped_pattern_edit} -### wrapped_pattern_edit_observable : [`renoise.Document.Observable`](/API/renoise.Document.Observable.md) {#wrapped_pattern_edit_observable} +### wrapped_pattern_edit_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#wrapped_pattern_edit_observable} --- @@ -202,7 +202,7 @@ Replace the scheduled sequence list with the given sequence. Start playing in song or pattern mode. ### `start_at`([*self*](/API/builtins/self.md), line : [`integer`](/API/builtins/integer.md)) {#start_at} Start playing the currently edited pattern at the given line offset -### `start_at`([*self*](/API/builtins/self.md), song_pos : [`renoise.SongPos`](/API/renoise.SongPos.md)) {#start_at} +### `start_at`([*self*](/API/builtins/self.md), song_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md)) {#start_at} Start playing a the given renoise.SongPos (sequence pos and line) ### `start_stop_sample_recording`([*self*](/API/builtins/self.md)) {#start_stop_sample_recording} Start a new sample recording when the sample dialog is visible, diff --git a/docs/API/renoise.ViewBuilder.md b/docs/API/renoise/renoise.ViewBuilder.md similarity index 100% rename from docs/API/renoise.ViewBuilder.md rename to docs/API/renoise/renoise.ViewBuilder.md diff --git a/docs/API/renoise/renoise.Views.Aligner.md b/docs/API/renoise/renoise.Views.Aligner.md new file mode 100644 index 00000000..6809df6e --- /dev/null +++ b/docs/API/renoise/renoise.Views.Aligner.md @@ -0,0 +1,45 @@ +# renoise.Views.Aligner +Just like a Rack, the Aligner shows no content on its own. It just aligns +child views vertically or horizontally. As soon as children are added, the +Aligner will expand itself to make sure that all children are visible +(including spacing & margins). +To make use of modes like "center", you manually have to setup a size that +is bigger than the sum of the child sizes. + + +--- +## Properties +### margin : [`RackMargin`](#RackMargin) {#margin} +### mode : [`AlignerMode`](#AlignerMode) {#mode} +* Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) + +### spacing : [`RackSpacing`](#RackSpacing) {#spacing} + + + + +--- +## Aliases +# alias AlignerMode {#AlignerMode} +`"bottom"` | `"center"` | `"distribute"` | `"justify"` | `"left"` | `"right"` | `"top"` +```lua +-- * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) +AlignerMode: + | "left" -- align from left to right (for horizontal_aligner only) + | "right" -- align from right to left (for horizontal_aligner only) + | "top" -- align from top to bottom (for vertical_aligner only) + | "bottom" -- align from bottom to top (for vertical_aligner only) + | "center" -- center all views + | "justify" -- keep outer views at the borders, distribute the rest + | "distribute" -- equally distributes views over the aligners width/height +``` +# alias RackMargin {#RackMargin} +[`integer`](/API/builtins/integer.md) +Set the "borders" of a rack (left, right, top and bottom inclusively) +* Default: 0 (no borders) +# alias RackSpacing {#RackSpacing} +[`integer`](/API/builtins/integer.md) +Set the amount stacked child views are separated by (horizontally in +rows, vertically in columns). +* Default: 0 (no spacing) + diff --git a/docs/API/renoise/renoise.Views.Bitmap.md b/docs/API/renoise/renoise.Views.Bitmap.md new file mode 100644 index 00000000..d140a454 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Bitmap.md @@ -0,0 +1,76 @@ +# renoise.Views.Bitmap +Draws a bitmap, or a draws a bitmap which acts like a button (as soon as a +notifier is specified). The notifier is called when clicking the mouse +somewhere on the bitmap. When using a re-colorable style (see 'mode'), the +bitmap is automatically recolored to match the current theme's colors. Mouse +hover is also enabled when notifiers are present, to show that the bitmap can +be clicked. +```text + * + *** + + * + / \ + +---+ + | O | o + +---+ | + |||||||||||| +``` + +--- +## Properties +### bitmap : [`BitmapPath`](#BitmapPath) {#bitmap} +Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). + +### mode : [`BitmapMode`](#BitmapMode) {#mode} +Setup how the bitmap should be drawn, recolored. Available modes are: + + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} +Add mouse click notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#remove_notifier} +Remove mouse click notifier + + + +--- +## Aliases +# alias BitmapImagePath {#BitmapImagePath} +[`string`](/API/builtins/string.md) +You can load an image from your tool's directory, +or use one from Renoise's built-in icons. +* For the built-in icons, use "Icons/ArrowRight.bmp" +* For custom images, use a path relative to your tool's root folder. + +For example "Images/MyBitmap.bmp" will load the image from +"com.me.MyTool.xrnx/Images/MyBitmap.bmp". +If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), +your image will be loaded instead of the one from Renoise. + +If you want to support high DPI UI scaling with your bitmaps like the built-in Icons, +include high resolution versions with their filenames ending with "@4x" +The following rules will be used when loading bitmaps +* When UI scaling is 100%, only the base bitmaps are used. +* When UI scaling is 125%, the base bitmaps are used, except if there is a `BitmapName@x1.25.bmp` variant. +* For all other UI scaling > 125% the "@4x" variants are used and downscaled as needed, +except when there is an exact match for the current UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) +# alias BitmapMode {#BitmapMode} +`"body_color"` | `"button_color"` | `"main_color"` | `"plain"` | `"transparent"` +```lua +-- Setup how the bitmap should be drawn, recolored. Available modes are: +BitmapMode: + | "plain" -- bitmap is drawn as is, no recoloring is done (Default) + | "transparent" -- same as plain, but black pixels will be fully transparent + | "button_color" -- recolor the bitmap, using the theme's button color + | "body_color" -- same as 'button_back' but with body text/back color + | "main_color" -- same as 'button_back' but with main text/back colors +``` +# alias BitmapPath {#BitmapPath} +[`BitmapImagePath`](#BitmapImagePath) +Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). +# alias NotifierFunction {#NotifierFunction} +fun() + + diff --git a/docs/API/renoise/renoise.Views.Button.md b/docs/API/renoise/renoise.Views.Button.md new file mode 100644 index 00000000..b1742617 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Button.md @@ -0,0 +1,96 @@ +# renoise.Views.Button +A simple button that calls a custom notifier function when clicked. +Supports text or bitmap labels. +```text + +--------+ + | Button | + +--------+ +``` + +--- +## Properties +### bitmap : [`ButtonBitmapPath`](#ButtonBitmapPath) {#bitmap} +If set, existing text is removed and the loaded image is displayed instead. +Supported bitmap file formats are ".bmp", ".png" and ".tiff". +Colors in bitmaps will be overridden by the button's theme color, using black +as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. +All other colors are mapped to the theme color according to their grey value, +so plain white is the target theme color, and all other colors blend into the +button's background color of the theme. + +### color : [`ButtonColor`](#ButtonColor) {#color} +When set, the unpressed button's background will be drawn in the specified color. +A text color is automatically selected unless explicitly set, to make sure it's +always visible. +Set color {0,0,0} to enable the theme colors for the button again. + +### text : [`ButtonLabel`](#ButtonLabel) {#text} +The text label of the button +* Default: "" + + + +--- +## Functions +### `add_pressed_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_pressed_notifier} +Add/remove button hit/release notifier functions. +When a "pressed" notifier is set, the release notifier is guaranteed to be +called as soon as the mouse is released, either over your button or anywhere +else. When a "release" notifier is set, it is only called when the mouse +button is pressed !and! released over your button. +### `add_released_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_released_notifier} +### `remove_pressed_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#remove_pressed_notifier} +### `remove_released_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#remove_released_notifier} + + + +--- +## Aliases +# alias BitmapImagePath {#BitmapImagePath} +[`string`](/API/builtins/string.md) +You can load an image from your tool's directory, +or use one from Renoise's built-in icons. +* For the built-in icons, use "Icons/ArrowRight.bmp" +* For custom images, use a path relative to your tool's root folder. + +For example "Images/MyBitmap.bmp" will load the image from +"com.me.MyTool.xrnx/Images/MyBitmap.bmp". +If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), +your image will be loaded instead of the one from Renoise. + +If you want to support high DPI UI scaling with your bitmaps like the built-in Icons, +include high resolution versions with their filenames ending with "@4x" +The following rules will be used when loading bitmaps +* When UI scaling is 100%, only the base bitmaps are used. +* When UI scaling is 125%, the base bitmaps are used, except if there is a `BitmapName@x1.25.bmp` variant. +* For all other UI scaling > 125% the "@4x" variants are used and downscaled as needed, +except when there is an exact match for the current UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) +# alias ButtonBitmapPath {#ButtonBitmapPath} +[`BitmapImagePath`](#BitmapImagePath) +If set, existing text is removed and the loaded image is displayed instead. +Supported bitmap file formats are ".bmp", ".png" and ".tiff". +Colors in bitmaps will be overridden by the button's theme color, using black +as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. +All other colors are mapped to the theme color according to their grey value, +so plain white is the target theme color, and all other colors blend into the +button's background color of the theme. +# alias ButtonColor {#ButtonColor} +[`RGBColor`](#RGBColor) +When set, the unpressed button's background will be drawn in the specified color. +A text color is automatically selected unless explicitly set, to make sure it's +always visible. +Set color {0,0,0} to enable the theme colors for the button again. +# alias ButtonLabel {#ButtonLabel} +[`string`](/API/builtins/string.md) +The text label of the button +* Default: "" +# alias NotifierFunction {#NotifierFunction} +fun() + +# alias RGBColor {#RGBColor} +{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +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.Views.CheckBox.md b/docs/API/renoise/renoise.Views.CheckBox.md new file mode 100644 index 00000000..399f00bf --- /dev/null +++ b/docs/API/renoise/renoise.Views.CheckBox.md @@ -0,0 +1,36 @@ +# renoise.Views.CheckBox +A single button with a checkbox bitmap, which can be used to toggle +something on/off. +```text + +----+ + | _/ | + +----+ +``` + +--- +## Properties +### value : [`CheckBoxBoolean`](#CheckBoxBoolean) {#value} +The current state of the checkbox, expressed as boolean. +* Default: false + + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) {#add_notifier} +Add value change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) {#remove_notifier} +Remove value change notifier + + + +--- +## Aliases +# alias BooleanValueNotifierFunction {#BooleanValueNotifierFunction} +(value : [`boolean`](/API/builtins/boolean.md)) + +# alias CheckBoxBoolean {#CheckBoxBoolean} +[`boolean`](/API/builtins/boolean.md) +The current state of the checkbox, expressed as boolean. +* Default: false + diff --git a/docs/API/renoise/renoise.Views.Chooser.md b/docs/API/renoise/renoise.Views.Chooser.md new file mode 100644 index 00000000..cc515657 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Chooser.md @@ -0,0 +1,36 @@ +# renoise.Views.Chooser +A radio button like set of vertically stacked items. Only one value can be +selected at a time. +```text + . Item A + o Item B + . Item C +``` + +--- +## Properties +### items : [`ItemLabels`](#ItemLabels) {#items} +### value : [`SelectedItem`](#SelectedItem) {#value} + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} +Add index change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} +Remove index change notifier + + + +--- +## Aliases +# alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} +(value : [`integer`](/API/builtins/integer.md)) + +# alias ItemLabels {#ItemLabels} +[`string`](/API/builtins/string.md)`[]` +A list of buttons labels to show in order. Must have more than one item. +# alias SelectedItem {#SelectedItem} +[`integer`](/API/builtins/integer.md) +The currently selected item's index + diff --git a/docs/API/renoise/renoise.Views.Control.md b/docs/API/renoise/renoise.Views.Control.md new file mode 100644 index 00000000..5fa47b4f --- /dev/null +++ b/docs/API/renoise/renoise.Views.Control.md @@ -0,0 +1,41 @@ +# renoise.Views.Control +Control is the base class for all views which let the user change a value or +some "state" from the UI. + +--- +## Properties +### active : [`ControlActive`](#ControlActive) {#active} +Instead of making a control invisible, you can also make it inactive. +Deactivated controls will still be shown, and will still show their +currently assigned values, but will not allow changes. Most controls will +display as "grayed out" to visualize the deactivated state. + +### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) {#midi_mapping} +When set, the control will be highlighted when Renoise's MIDI mapping dialog +is open. When clicked, it selects the specified string as a MIDI mapping +target action. This target acton can either be one of the globally available +mappings in Renoise, or those that were created by the tool itself. +Target strings are not verified. When they point to nothing, the mapped MIDI +message will do nothing and no error is fired. + + + + + +--- +## Aliases +# alias ControlActive {#ControlActive} +[`boolean`](/API/builtins/boolean.md) +Instead of making a control invisible, you can also make it inactive. +Deactivated controls will still be shown, and will still show their +currently assigned values, but will not allow changes. Most controls will +display as "grayed out" to visualize the deactivated state. +# alias ControlMidiMappingString {#ControlMidiMappingString} +[`string`](/API/builtins/string.md) +When set, the control will be highlighted when Renoise's MIDI mapping dialog +is open. When clicked, it selects the specified string as a MIDI mapping +target action. This target acton can either be one of the globally available +mappings in Renoise, or those that were created by the tool itself. +Target strings are not verified. When they point to nothing, the mapped MIDI +message will do nothing and no error is fired. + diff --git a/docs/API/renoise/renoise.Views.MiniSlider.md b/docs/API/renoise/renoise.Views.MiniSlider.md new file mode 100644 index 00000000..d64788d3 --- /dev/null +++ b/docs/API/renoise/renoise.Views.MiniSlider.md @@ -0,0 +1,45 @@ +# renoise.Views.MiniSlider +Same as a slider, but without arrow buttons and a really tiny height. Just +like the slider, a mini slider can be horizontal or vertical. It will flip +its orientation according to the set width and height. By default horizontal. +```text + --------[] +``` + +--- +## Properties +### default : [`SliderDefaultValue`](#SliderDefaultValue) {#default} +### max : [`SliderMaxValue`](#SliderMaxValue) {#max} +### min : [`SliderMinValue`](#SliderMinValue) {#min} +### value : [`SliderNumberValue`](#SliderNumberValue) {#value} + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +Add value change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +Remove value change notifier + + + +--- +## Aliases +# alias NumberValueNotifierFunction {#NumberValueNotifierFunction} +(value : [`number`](/API/builtins/number.md)) + +# alias SliderDefaultValue {#SliderDefaultValue} +[`number`](/API/builtins/number.md) +The default value that will be re-applied on double-click +# alias SliderMaxValue {#SliderMaxValue} +[`number`](/API/builtins/number.md) +The maximum value that can be set using the view +* Default: 1.0 +# alias SliderMinValue {#SliderMinValue} +[`number`](/API/builtins/number.md) +The minimum value that can be set using the view +* Default: 0 +# alias SliderNumberValue {#SliderNumberValue} +[`number`](/API/builtins/number.md) +The current value of the view + diff --git a/docs/API/renoise.Views.MultiLineText.md b/docs/API/renoise/renoise.Views.MultiLineText.md similarity index 50% rename from docs/API/renoise.Views.MultiLineText.md rename to docs/API/renoise/renoise.Views.MultiLineText.md index 9120f5e6..17e159b6 100644 --- a/docs/API/renoise.Views.MultiLineText.md +++ b/docs/API/renoise/renoise.Views.MultiLineText.md @@ -15,16 +15,16 @@ by the user. --- ## Properties -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md) {#font} -### paragraphs : [`TextParagraphs`](/API/aliases/TextParagraphs.md) {#paragraphs} +### font : [`TextFontStyle`](#TextFontStyle) {#font} +### paragraphs : [`TextParagraphs`](#TextParagraphs) {#paragraphs} A table of text lines to be used instead of specifying a single text line with newline characters like "text" * Default: [] -### style : [`TextBackgroundStyle`](/API/aliases/TextBackgroundStyle.md) {#style} +### style : [`TextBackgroundStyle`](#TextBackgroundStyle) {#style} Default: "body" -### text : [`TextMultilineString`](/API/aliases/TextMultilineString.md) {#text} +### text : [`TextMultilineString`](#TextMultilineString) {#text} The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs. @@ -43,3 +43,38 @@ When a scroll bar is visible, scroll the text to show the first line. ### `scroll_to_last_line`([*self*](/API/builtins/self.md)) {#scroll_to_last_line} When a scroll bar is visible (needed), scroll the text to show the last line. + + +--- +## Aliases +# alias TextBackgroundStyle {#TextBackgroundStyle} +`"body"` | `"border"` | `"strong"` +```lua +-- Setup the text view's background: +TextBackgroundStyle: + | "body" -- simple text color with no background + | "strong" -- stronger text color with no background + | "border" -- text on a bordered background +``` +# alias TextFontStyle {#TextFontStyle} +`"big"` | `"bold"` | `"italic"` | `"mono"` | `"normal"` +```lua +-- The style that the text should be displayed with. +TextFontStyle: + | "normal" -- (Default) + | "big" -- big text + | "bold" -- bold font + | "italic" -- italic font + | "mono" -- monospace font +``` +# alias TextMultilineString {#TextMultilineString} +[`string`](/API/builtins/string.md) +The text that should be displayed. +Newlines (Windows, Mac or Unix styled) in the text can be used to create +paragraphs. +# alias TextParagraphs {#TextParagraphs} +[`string`](/API/builtins/string.md)`[]` +A table of text lines to be used instead of specifying a single text +line with newline characters like "text" +* Default: [] + diff --git a/docs/API/renoise/renoise.Views.MultiLineTextField.md b/docs/API/renoise/renoise.Views.MultiLineTextField.md new file mode 100644 index 00000000..76587618 --- /dev/null +++ b/docs/API/renoise/renoise.Views.MultiLineTextField.md @@ -0,0 +1,92 @@ +# renoise.Views.MultiLineTextField +Shows multiple text lines of text, auto-wrapping paragraphs into lines. The +text can be edited by the user. +```text + +--------------------------+-+ + | Editable Te|xt. |+| + | | | + | With multiple paragraphs | | + | and auto-wrapping |+| + +--------------------------+-+ +``` + +--- +## Properties +### active : [`TextActive`](#TextActive) {#active} +### edit_mode : [`TextEditMode`](#TextEditMode) {#edit_mode} +### font : [`TextFontStyle`](#TextFontStyle) {#font} +### paragraphs : [`TextParagraphs`](#TextParagraphs) {#paragraphs} +### style : [`TextBackgroundStyle`](#TextBackgroundStyle) {#style} +Default: "border" + +### text : [`TextValueAlias`](#TextValueAlias) {#text} +### value : [`TextMultilineString`](#TextMultilineString) {#value} + + +--- +## Functions +### `add_line`([*self*](/API/builtins/self.md), text : [`string`](/API/builtins/string.md)) {#add_line} +Append a new text to the existing text. Newline characters in the string will +create new paragraphs, otherwise a single paragraph is appended. +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#add_notifier} +Add value change (text change) notifier +### `clear`([*self*](/API/builtins/self.md)) {#clear} +Clear the whole text. +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#remove_notifier} +Remove value change (text change) notifier +### `scroll_to_first_line`([*self*](/API/builtins/self.md)) {#scroll_to_first_line} +When a scroll bar is visible, scroll the text to show the first line. +### `scroll_to_last_line`([*self*](/API/builtins/self.md)) {#scroll_to_last_line} +When a scroll bar is visible, scroll the text to show the last line. + + + +--- +## Aliases +# alias StringValueNotifierFunction {#StringValueNotifierFunction} +(value : [`string`](/API/builtins/string.md)) + +# alias TextActive {#TextActive} +[`boolean`](/API/builtins/boolean.md) +When false, text is displayed but can not be entered/modified by the user. +* Default: true +# alias TextBackgroundStyle {#TextBackgroundStyle} +`"body"` | `"border"` | `"strong"` +```lua +-- Setup the text view's background: +TextBackgroundStyle: + | "body" -- simple text color with no background + | "strong" -- stronger text color with no background + | "border" -- text on a bordered background +``` +# alias TextEditMode {#TextEditMode} +[`boolean`](/API/builtins/boolean.md) +True when the text field is focused. setting it at run-time programmatically +will focus the text field or remove the focus (focus the dialog) accordingly. +* Default: false +# alias TextFontStyle {#TextFontStyle} +`"big"` | `"bold"` | `"italic"` | `"mono"` | `"normal"` +```lua +-- The style that the text should be displayed with. +TextFontStyle: + | "normal" -- (Default) + | "big" -- big text + | "bold" -- bold font + | "italic" -- italic font + | "mono" -- monospace font +``` +# alias TextMultilineString {#TextMultilineString} +[`string`](/API/builtins/string.md) +The text that should be displayed. +Newlines (Windows, Mac or Unix styled) in the text can be used to create +paragraphs. +# alias TextParagraphs {#TextParagraphs} +[`string`](/API/builtins/string.md)`[]` +A table of text lines to be used instead of specifying a single text +line with newline characters like "text" +* Default: [] +# alias TextValueAlias {#TextValueAlias} +[`string`](/API/builtins/string.md) +Exactly the same as "value"; provided for consistency. +* Default: "" + diff --git a/docs/API/renoise/renoise.Views.Popup.md b/docs/API/renoise/renoise.Views.Popup.md new file mode 100644 index 00000000..70ba98d2 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Popup.md @@ -0,0 +1,40 @@ +# renoise.Views.Popup +A drop-down menu which shows the currently selected value when closed. +When clicked, it pops up a list of all available items. +```text + +--------------++---+ + | Current Item || ^ | + +--------------++---+ +``` + +--- +## Properties +### items : [`PopupItemLabels`](#PopupItemLabels) {#items} +A list of buttons labels to show in order +The list can be empty, then "None" is displayed and the value won't change. + +### value : [`SelectedItem`](#SelectedItem) {#value} + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} +Add index change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} +Remove index change notifier + + + +--- +## Aliases +# alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} +(value : [`integer`](/API/builtins/integer.md)) + +# alias PopupItemLabels {#PopupItemLabels} +[`string`](/API/builtins/string.md)`[]` +A list of buttons labels to show in order +The list can be empty, then "None" is displayed and the value won't change. +# alias SelectedItem {#SelectedItem} +[`integer`](/API/builtins/integer.md) +The currently selected item's index + diff --git a/docs/API/renoise/renoise.Views.Rack.md b/docs/API/renoise/renoise.Views.Rack.md new file mode 100644 index 00000000..6725a959 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Rack.md @@ -0,0 +1,61 @@ +# renoise.Views.Rack +A Rack has no content on its own. It only stacks child views. Either +vertically (ViewBuilder.column) or horizontally (ViewBuilder.row). It allows +you to create view layouts. + +--- +## Properties +### margin : [`RackMargin`](#RackMargin) {#margin} +Set the "borders" of a rack (left, right, top and bottom inclusively) +* Default: 0 (no borders) + +### spacing : [`RackSpacing`](#RackSpacing) {#spacing} +Set the amount stacked child views are separated by (horizontally in +rows, vertically in columns). +* Default: 0 (no spacing) + +### style : [`ViewBackgroundStyle`](#ViewBackgroundStyle) {#style} +### uniform : [`RackUniformity`](#RackUniformity) {#uniform} +When set to true, all child views in the rack are automatically resized to +the max size of all child views (width in ViewBuilder.column, height in +ViewBuilder.row). This can be useful to automatically align all sub +columns/panels to the same size. Resizing is done automatically, as soon +as a child view size changes or new children are added. +* Default: false + + + + + +--- +## Aliases +# alias RackMargin {#RackMargin} +[`integer`](/API/builtins/integer.md) +Set the "borders" of a rack (left, right, top and bottom inclusively) +* Default: 0 (no borders) +# alias RackSpacing {#RackSpacing} +[`integer`](/API/builtins/integer.md) +Set the amount stacked child views are separated by (horizontally in +rows, vertically in columns). +* Default: 0 (no spacing) +# alias RackUniformity {#RackUniformity} +[`boolean`](/API/builtins/boolean.md) +When set to true, all child views in the rack are automatically resized to +the max size of all child views (width in ViewBuilder.column, height in +ViewBuilder.row). This can be useful to automatically align all sub +columns/panels to the same size. Resizing is done automatically, as soon +as a child view size changes or new children are added. +* Default: false +# alias ViewBackgroundStyle {#ViewBackgroundStyle} +`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` +```lua +-- Setup a background style for the view. +ViewBackgroundStyle: + | "invisible" -- no background (Default) + | "plain" -- undecorated, single coloured background + | "border" -- same as plain, but with a bold nested border + | "body" -- main "background" style, as used in dialog backgrounds + | "panel" -- alternative "background" style, beveled + | "group" -- background for "nested" groups within body +``` + diff --git a/docs/API/renoise/renoise.Views.RotaryEncoder.md b/docs/API/renoise/renoise.Views.RotaryEncoder.md new file mode 100644 index 00000000..68263df5 --- /dev/null +++ b/docs/API/renoise/renoise.Views.RotaryEncoder.md @@ -0,0 +1,50 @@ +# renoise.Views.RotaryEncoder +A slider which looks like a potentiometer. +Note: when changing the size, the minimum of either width or height will be +used to draw and control the rotary, therefore you should always set both +equally when possible. +```text + +-+ + / \ \ + | o | + \ | / + +-+ +``` + +--- +## Properties +### default : [`SliderDefaultValue`](#SliderDefaultValue) {#default} +### max : [`SliderMaxValue`](#SliderMaxValue) {#max} +### min : [`SliderMinValue`](#SliderMinValue) {#min} +### value : [`SliderNumberValue`](#SliderNumberValue) {#value} + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +Add value change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +Remove value change notifier + + + +--- +## Aliases +# alias NumberValueNotifierFunction {#NumberValueNotifierFunction} +(value : [`number`](/API/builtins/number.md)) + +# alias SliderDefaultValue {#SliderDefaultValue} +[`number`](/API/builtins/number.md) +The default value that will be re-applied on double-click +# alias SliderMaxValue {#SliderMaxValue} +[`number`](/API/builtins/number.md) +The maximum value that can be set using the view +* Default: 1.0 +# alias SliderMinValue {#SliderMinValue} +[`number`](/API/builtins/number.md) +The minimum value that can be set using the view +* Default: 0 +# alias SliderNumberValue {#SliderNumberValue} +[`number`](/API/builtins/number.md) +The current value of the view + diff --git a/docs/API/renoise/renoise.Views.Slider.md b/docs/API/renoise/renoise.Views.Slider.md new file mode 100644 index 00000000..81b20ba9 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Slider.md @@ -0,0 +1,69 @@ +# renoise.Views.Slider +A slider with arrow buttons, which shows and allows editing of values in a +custom range. A slider can be horizontal or vertical; will flip its +orientation according to the set width and height. By default horizontal. +```text + +---+---------------+ + |<|>| --------[] | + +---+---------------+ +``` + +--- +## Properties +### default : [`SliderDefaultValue`](#SliderDefaultValue) {#default} +The default value that will be re-applied on double-click + +### max : [`SliderMaxValue`](#SliderMaxValue) {#max} +The maximum value that can be set using the view +* Default: 1.0 + +### min : [`SliderMinValue`](#SliderMinValue) {#min} +The minimum value that can be set using the view +* Default: 0 + +### steps : [`SliderStepAmounts`](#SliderStepAmounts) {#steps} +A table containing two numbers representing the step amounts for incrementing +and decrementing by clicking the <> buttons. +The first value is the small step (applied on left clicks) +second value is the big step (applied on right clicks) + +### value : [`SliderNumberValue`](#SliderNumberValue) {#value} +The current value of the view + + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +Add value change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +Remove value change notifier + + + +--- +## Aliases +# alias NumberValueNotifierFunction {#NumberValueNotifierFunction} +(value : [`number`](/API/builtins/number.md)) + +# alias SliderDefaultValue {#SliderDefaultValue} +[`number`](/API/builtins/number.md) +The default value that will be re-applied on double-click +# alias SliderMaxValue {#SliderMaxValue} +[`number`](/API/builtins/number.md) +The maximum value that can be set using the view +* Default: 1.0 +# alias SliderMinValue {#SliderMinValue} +[`number`](/API/builtins/number.md) +The minimum value that can be set using the view +* Default: 0 +# alias SliderNumberValue {#SliderNumberValue} +[`number`](/API/builtins/number.md) +The current value of the view +# alias SliderStepAmounts {#SliderStepAmounts} +{ 1 : [`number`](/API/builtins/number.md), 2 : [`number`](/API/builtins/number.md) } +A table containing two numbers representing the step amounts for incrementing +and decrementing by clicking the <> buttons. +The first value is the small step (applied on left clicks) +second value is the big step (applied on right clicks) + diff --git a/docs/API/renoise/renoise.Views.Switch.md b/docs/API/renoise/renoise.Views.Switch.md new file mode 100644 index 00000000..e812d588 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Switch.md @@ -0,0 +1,40 @@ +# renoise.Views.Switch +A set of horizontally aligned buttons, where only one button can be enabled +at the same time. Select one of multiple choices, indices. +```text + +-----------+------------+----------+ + | Button A | +Button+B+ | Button C | + +-----------+------------+----------+ +``` + +--- +## Properties +### items : [`ItemLabels`](#ItemLabels) {#items} +A list of buttons labels to show in order. Must have more than one item. + +### value : [`SelectedItem`](#SelectedItem) {#value} +The currently selected item's index + + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} +Add index change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} +Remove index change notifier + + + +--- +## Aliases +# alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} +(value : [`integer`](/API/builtins/integer.md)) + +# alias ItemLabels {#ItemLabels} +[`string`](/API/builtins/string.md)`[]` +A list of buttons labels to show in order. Must have more than one item. +# alias SelectedItem {#SelectedItem} +[`integer`](/API/builtins/integer.md) +The currently selected item's index + diff --git a/docs/API/renoise/renoise.Views.Text.md b/docs/API/renoise/renoise.Views.Text.md new file mode 100644 index 00000000..befbdaf1 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Text.md @@ -0,0 +1,68 @@ +# renoise.Views.Text +Shows a "static" text string. Static just means that its not linked, bound +to some value and has no notifiers. The text can not be edited by the user. +Nevertheless you can of course change the text at run-time with the "text" +property. +```text + Text, Bla 1 +``` + +--- +## Properties +### align : [`TextAlignment`](#TextAlignment) {#align} +Setup the text's alignment. Applies only when the view's size is larger than +the needed size to draw the text + +### font : [`TextFontStyle`](#TextFontStyle) {#font} +The style that the text should be displayed with. + +### style : [`TextStyle`](#TextStyle) {#style} +Get/set the color style the text should be displayed with. + +### text : [`TextSingleLineString`](#TextSingleLineString) {#text} +The text that should be displayed. Setting a new text will resize +the view in order to make the text fully visible (expanding only). +* Default: "" + + + + + +--- +## Aliases +# alias TextAlignment {#TextAlignment} +`"center"` | `"left"` | `"right"` +```lua +-- Setup the text's alignment. Applies only when the view's size is larger than +-- the needed size to draw the text +TextAlignment: + | "left" -- (Default) + | "right" -- aligned to the right + | "center" -- center text +``` +# alias TextFontStyle {#TextFontStyle} +`"big"` | `"bold"` | `"italic"` | `"mono"` | `"normal"` +```lua +-- The style that the text should be displayed with. +TextFontStyle: + | "normal" -- (Default) + | "big" -- big text + | "bold" -- bold font + | "italic" -- italic font + | "mono" -- monospace font +``` +# alias TextSingleLineString {#TextSingleLineString} +[`string`](/API/builtins/string.md) +The text that should be displayed. Setting a new text will resize +the view in order to make the text fully visible (expanding only). +* Default: "" +# alias TextStyle {#TextStyle} +`"disabled"` | `"normal"` | `"strong"` +```lua +-- Get/set the color style the text should be displayed with. +TextStyle: + | "normal" -- (Default) + | "strong" -- highlighted color + | "disabled" -- greyed out color +``` + diff --git a/docs/API/renoise/renoise.Views.TextField.md b/docs/API/renoise/renoise.Views.TextField.md new file mode 100644 index 00000000..11d84901 --- /dev/null +++ b/docs/API/renoise/renoise.Views.TextField.md @@ -0,0 +1,76 @@ +# renoise.Views.TextField +Shows a text string that can be clicked and edited by the user. +```text + +----------------+ + | Editable Te|xt | + +----------------+ +``` + +--- +## Properties +### active : [`TextActive`](#TextActive) {#active} +When false, text is displayed but can not be entered/modified by the user. +* Default: true + +### align : [`TextAlignment`](#TextAlignment) {#align} +Only used when not editing. + +### edit_mode : [`TextEditMode`](#TextEditMode) {#edit_mode} +True when the text field is focused. setting it at run-time programmatically +will focus the text field or remove the focus (focus the dialog) accordingly. +* Default: false + +### text : [`TextValueAlias`](#TextValueAlias) {#text} +Exactly the same as "value"; provided for consistency. +* Default: "" + +### value : [`TextValue`](#TextValue) {#value} +The currently shown text. The text will not be updated when editing, +rather only after editing is complete (return is pressed, or focus is lost). +* Default: "" + + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#add_notifier} +Add value change (text change) notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#remove_notifier} +Remove value change (text change) notifier + + + +--- +## Aliases +# alias StringValueNotifierFunction {#StringValueNotifierFunction} +(value : [`string`](/API/builtins/string.md)) + +# alias TextActive {#TextActive} +[`boolean`](/API/builtins/boolean.md) +When false, text is displayed but can not be entered/modified by the user. +* Default: true +# alias TextAlignment {#TextAlignment} +`"center"` | `"left"` | `"right"` +```lua +-- Setup the text's alignment. Applies only when the view's size is larger than +-- the needed size to draw the text +TextAlignment: + | "left" -- (Default) + | "right" -- aligned to the right + | "center" -- center text +``` +# alias TextEditMode {#TextEditMode} +[`boolean`](/API/builtins/boolean.md) +True when the text field is focused. setting it at run-time programmatically +will focus the text field or remove the focus (focus the dialog) accordingly. +* Default: false +# alias TextValue {#TextValue} +[`string`](/API/builtins/string.md) +The currently shown text. The text will not be updated when editing, +rather only after editing is complete (return is pressed, or focus is lost). +* Default: "" +# alias TextValueAlias {#TextValueAlias} +[`string`](/API/builtins/string.md) +Exactly the same as "value"; provided for consistency. +* Default: "" + diff --git a/docs/API/renoise/renoise.Views.Value.md b/docs/API/renoise/renoise.Views.Value.md new file mode 100644 index 00000000..42ecb123 --- /dev/null +++ b/docs/API/renoise/renoise.Views.Value.md @@ -0,0 +1,55 @@ +# renoise.Views.Value +A static text view. Shows a string representation of a number and +allows custom "number to string" conversion. +```text + +---+-------+ + | 12.1 dB | + +---+-------+ +``` + +--- +## Properties +### align : [`TextAlignment`](#TextAlignment) {#align} +### font : [`TextFontStyle`](#TextFontStyle) {#font} +### value : [`SliderNumberValue`](#SliderNumberValue) {#value} + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +Add value change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +Remove value change notifier + + + +--- +## Aliases +# alias NumberValueNotifierFunction {#NumberValueNotifierFunction} +(value : [`number`](/API/builtins/number.md)) + +# alias SliderNumberValue {#SliderNumberValue} +[`number`](/API/builtins/number.md) +The current value of the view +# alias TextAlignment {#TextAlignment} +`"center"` | `"left"` | `"right"` +```lua +-- Setup the text's alignment. Applies only when the view's size is larger than +-- the needed size to draw the text +TextAlignment: + | "left" -- (Default) + | "right" -- aligned to the right + | "center" -- center text +``` +# alias TextFontStyle {#TextFontStyle} +`"big"` | `"bold"` | `"italic"` | `"mono"` | `"normal"` +```lua +-- The style that the text should be displayed with. +TextFontStyle: + | "normal" -- (Default) + | "big" -- big text + | "bold" -- bold font + | "italic" -- italic font + | "mono" -- monospace font +``` + diff --git a/docs/API/renoise/renoise.Views.ValueBox.md b/docs/API/renoise/renoise.Views.ValueBox.md new file mode 100644 index 00000000..6c2cdd72 --- /dev/null +++ b/docs/API/renoise/renoise.Views.ValueBox.md @@ -0,0 +1,55 @@ +# renoise.Views.ValueBox +A box with arrow buttons and a text field that can be edited by the user. +Allows showing and editing natural numbers in a custom range. +```text + +---+-------+ + |<|>| 12 | + +---+-------+ +``` + +--- +## Properties +### max : [`ValueBoxMaxValue`](#ValueBoxMaxValue) {#max} +The maximum value that can be set using the view +* Default: 100 + +### min : [`ValueBoxMinValue`](#ValueBoxMinValue) {#min} +The minimum value that can be set using the view +* Default: 0 + +### steps : [`SliderStepAmounts`](#SliderStepAmounts) {#steps} +### value : [`SliderNumberValue`](#SliderNumberValue) {#value} + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +Add value change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +Remove value change notifier + + + +--- +## Aliases +# alias NumberValueNotifierFunction {#NumberValueNotifierFunction} +(value : [`number`](/API/builtins/number.md)) + +# alias SliderNumberValue {#SliderNumberValue} +[`number`](/API/builtins/number.md) +The current value of the view +# alias SliderStepAmounts {#SliderStepAmounts} +{ 1 : [`number`](/API/builtins/number.md), 2 : [`number`](/API/builtins/number.md) } +A table containing two numbers representing the step amounts for incrementing +and decrementing by clicking the <> buttons. +The first value is the small step (applied on left clicks) +second value is the big step (applied on right clicks) +# alias ValueBoxMaxValue {#ValueBoxMaxValue} +[`number`](/API/builtins/number.md) +The maximum value that can be set using the view +* Default: 100 +# alias ValueBoxMinValue {#ValueBoxMinValue} +[`number`](/API/builtins/number.md) +The minimum value that can be set using the view +* Default: 0 + diff --git a/docs/API/renoise/renoise.Views.ValueField.md b/docs/API/renoise/renoise.Views.ValueField.md new file mode 100644 index 00000000..f72e5394 --- /dev/null +++ b/docs/API/renoise/renoise.Views.ValueField.md @@ -0,0 +1,54 @@ +# renoise.Views.ValueField +A text view, which shows a string representation of a number and allows +custom "number to string" conversion. The value's text can be edited by the +user. +```lua + +---+-------+ + | 12.1 dB | + +---+-------+ +``` + +--- +## Properties +### align : [`TextAlignment`](#TextAlignment) {#align} +### max : [`SliderMaxValue`](#SliderMaxValue) {#max} +### min : [`SliderMinValue`](#SliderMinValue) {#min} +### value : [`SliderNumberValue`](#SliderNumberValue) {#value} + + +--- +## Functions +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +Add value change notifier +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +Remove value change notifier + + + +--- +## Aliases +# alias NumberValueNotifierFunction {#NumberValueNotifierFunction} +(value : [`number`](/API/builtins/number.md)) + +# alias SliderMaxValue {#SliderMaxValue} +[`number`](/API/builtins/number.md) +The maximum value that can be set using the view +* Default: 1.0 +# alias SliderMinValue {#SliderMinValue} +[`number`](/API/builtins/number.md) +The minimum value that can be set using the view +* Default: 0 +# alias SliderNumberValue {#SliderNumberValue} +[`number`](/API/builtins/number.md) +The current value of the view +# alias TextAlignment {#TextAlignment} +`"center"` | `"left"` | `"right"` +```lua +-- Setup the text's alignment. Applies only when the view's size is larger than +-- the needed size to draw the text +TextAlignment: + | "left" -- (Default) + | "right" -- aligned to the right + | "center" -- center text +``` + diff --git a/docs/API/renoise.Views.View.md b/docs/API/renoise/renoise.Views.View.md similarity index 50% rename from docs/API/renoise.Views.View.md rename to docs/API/renoise/renoise.Views.View.md index e66f191a..b8b06e81 100644 --- a/docs/API/renoise.Views.View.md +++ b/docs/API/renoise/renoise.Views.View.md @@ -4,27 +4,27 @@ applied to any of the following specialized views. --- ## Properties -### height : [`ViewDimension`](/API/aliases/ViewDimension.md) {#height} +### height : [`ViewDimension`](#ViewDimension) {#height} The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example `vb:text { width = "80%"}`. The percentage values are relative to the view's parent size and will automatically update on size changes. -### tooltip : [`ViewTooltip`](/API/aliases/ViewTooltip.md) {#tooltip} +### tooltip : [`ViewTooltip`](#ViewTooltip) {#tooltip} A tooltip text that should be shown for this view on mouse hover. * Default: "" (no tip will be shown) -### views : [`renoise.Views.View`](/API/renoise.Views.View.md)`[]` {#views} +### views : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md)`[]` {#views} **READ-ONLY** Empty for all controls, for layout views this contains the layout child views in the order they got added -### visible : [`ViewVisibility`](/API/aliases/ViewVisibility.md) {#visible} +### visible : [`ViewVisibility`](#ViewVisibility) {#visible} Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible). * Default: true -### width : [`ViewDimension`](/API/aliases/ViewDimension.md) {#width} +### width : [`ViewDimension`](#ViewDimension) {#width} The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example `vb:text { width = "80%"}`. The percentage values are @@ -34,8 +34,29 @@ relative to the view's parent size and will automatically update on size changes --- ## Functions -### `add_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise.Views.View.md)) {#add_child} +### `add_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md)) {#add_child} Add a new child view to this view. -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise.Views.View.md)) {#remove_child} +### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md)) {#remove_child} Remove a child view from this view. + + +--- +## Aliases +# alias ViewDimension {#ViewDimension} +[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +The dimensions of a view has to be larger than 0. +For nested views you can also specify relative size +for example `vb:text { width = "80%"}`. The percentage values are +relative to the view's parent size and will automatically update on size changes. +# alias ViewTooltip {#ViewTooltip} +[`string`](/API/builtins/string.md) +A tooltip text that should be shown for this view on mouse hover. +* Default: "" (no tip will be shown) +# alias ViewVisibility {#ViewVisibility} +[`boolean`](/API/builtins/boolean.md) +Set visible to false to hide a view (make it invisible without removing +it). Please note that view.visible will also return false when any of its +parents are invisible (when its implicitly invisible). +* Default: true + diff --git a/docs/API/renoise.Views.XYPad.md b/docs/API/renoise/renoise.Views.XYPad.md similarity index 53% rename from docs/API/renoise.Views.XYPad.md rename to docs/API/renoise/renoise.Views.XYPad.md index ea949785..9bc26e61 100644 --- a/docs/API/renoise.Views.XYPad.md +++ b/docs/API/renoise/renoise.Views.XYPad.md @@ -16,30 +16,49 @@ table with the fields `{x = xvalue, y = yvalue}` is expected, returned. --- ## Properties -### max : [`XYPadMaxValues`](/API/aliases/XYPadMaxValues.md) {#max} +### max : [`XYPadMaxValues`](#XYPadMaxValues) {#max} A table of allowed maximum values for each axis * Default: {x: 1.0, y: 1.0} -### min : [`XYPadMinValues`](/API/aliases/XYPadMinValues.md) {#min} +### min : [`XYPadMinValues`](#XYPadMinValues) {#min} A table of allowed minimum values for each axis * Default: {x: 0.0, y: 0.0} -### snapback : [`XYPadSnapbackValues`](/API/aliases/XYPadSnapbackValues.md)[`?`](/API/builtins/nil.md) {#snapback} +### snapback : [`XYPadSnapbackValues`](#XYPadSnapbackValues)[`?`](/API/builtins/nil.md) {#snapback} A table of snapback values for each axis When snapback is enabled, the pad will revert its values to the specified snapback values as soon as the mouse button is released in the pad. When disabled, releasing the mouse button will not change the value. You can disable snapback at runtime by setting it to nil or an empty table. -### value : [`XYPadValues`](/API/aliases/XYPadValues.md) {#value} +### value : [`XYPadValues`](#XYPadValues) {#value} A table of the XYPad's current values on each axis --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`XYValueNotifierFunction`](/API/aliases/XYValueNotifierFunction.md)) {#add_notifier} +### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`XYValueNotifierFunction`](/API/aliases/XYValueNotifierFunction.md)) {#remove_notifier} +### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) {#remove_notifier} Remove value change notifier + + +--- +## Aliases +# alias XYPadMaxValues {#XYPadMaxValues} +{ x : [`SliderMaxValue`](#SliderMaxValue), y : [`SliderMaxValue`](#SliderMaxValue) } +A table of allowed maximum values for each axis +* Default: {x: 1.0, y: 1.0} +# alias XYPadMinValues {#XYPadMinValues} +{ x : [`SliderMinValue`](#SliderMinValue), y : [`SliderMinValue`](#SliderMinValue) } +A table of allowed minimum values for each axis +* Default: {x: 0.0, y: 0.0} +# alias XYPadValues {#XYPadValues} +{ x : [`SliderNumberValue`](#SliderNumberValue), y : [`SliderNumberValue`](#SliderNumberValue) } +A table of the XYPad's current values on each axis +# alias XYValueNotifierFunction {#XYValueNotifierFunction} +(value : [`XYPadValues`](#XYPadValues)) + + diff --git a/docs/API/renoise.Views.md b/docs/API/renoise/renoise.Views.md similarity index 100% rename from docs/API/renoise.Views.md rename to docs/API/renoise/renoise.Views.md diff --git a/docs/API/structs/AlignerViewProperties.md b/docs/API/structs/AlignerViewProperties.md index 6dd7ecfd..7d3d3dd5 100644 --- a/docs/API/structs/AlignerViewProperties.md +++ b/docs/API/structs/AlignerViewProperties.md @@ -2,10 +2,10 @@ --- ## Properties -### margin : [`RackMargin`](/API/aliases/RackMargin.md)[`?`](/API/builtins/nil.md) {#margin} -### mode : [`AlignerMode`](/API/aliases/AlignerMode.md)[`?`](/API/builtins/nil.md) {#mode} +### margin : [`RackMargin`](#RackMargin)[`?`](/API/builtins/nil.md) {#margin} +### mode : [`AlignerMode`](#AlignerMode)[`?`](/API/builtins/nil.md) {#mode} * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) -### spacing : [`RackSpacing`](/API/aliases/RackSpacing.md)[`?`](/API/builtins/nil.md) {#spacing} +### spacing : [`RackSpacing`](#RackSpacing)[`?`](/API/builtins/nil.md) {#spacing} diff --git a/docs/API/structs/BitmapViewProperties.md b/docs/API/structs/BitmapViewProperties.md index fa286b99..61f4d5bc 100644 --- a/docs/API/structs/BitmapViewProperties.md +++ b/docs/API/structs/BitmapViewProperties.md @@ -2,13 +2,13 @@ --- ## Properties -### bitmap : [`BitmapPath`](/API/aliases/BitmapPath.md)[`?`](/API/builtins/nil.md) {#bitmap} +### bitmap : [`BitmapPath`](#BitmapPath)[`?`](/API/builtins/nil.md) {#bitmap} Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). -### mode : [`BitmapMode`](/API/aliases/BitmapMode.md)[`?`](/API/builtins/nil.md) {#mode} +### mode : [`BitmapMode`](#BitmapMode)[`?`](/API/builtins/nil.md) {#mode} Setup how the bitmap should be drawn, recolored. Available modes are: -### notifier : [`ButtonNotifier`](/API/aliases/ButtonNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#notifier} A click notifier diff --git a/docs/API/structs/ButtonProperties.md b/docs/API/structs/ButtonProperties.md index 0c341c25..cca53125 100644 --- a/docs/API/structs/ButtonProperties.md +++ b/docs/API/structs/ButtonProperties.md @@ -2,7 +2,7 @@ --- ## Properties -### bitmap : [`ButtonBitmapPath`](/API/aliases/ButtonBitmapPath.md)[`?`](/API/builtins/nil.md) {#bitmap} +### bitmap : [`ButtonBitmapPath`](#ButtonBitmapPath)[`?`](/API/builtins/nil.md) {#bitmap} If set, existing text is removed and the loaded image is displayed instead. Supported bitmap file formats are ".bmp", ".png" and ".tiff". Colors in bitmaps will be overridden by the button's theme color, using black @@ -11,16 +11,16 @@ All other colors are mapped to the theme color according to their grey value, so plain white is the target theme color, and all other colors blend into the button's background color of the theme. -### color : [`ButtonColor`](/API/aliases/ButtonColor.md)[`?`](/API/builtins/nil.md) {#color} +### color : [`ButtonColor`](#ButtonColor)[`?`](/API/builtins/nil.md) {#color} When set, the unpressed button's background will be drawn in the specified color. A text color is automatically selected unless explicitly set, to make sure it's always visible. Set color {0,0,0} to enable the theme colors for the button again. -### notifier : [`ButtonNotifier`](/API/aliases/ButtonNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### pressed : [`ButtonNotifier`](/API/aliases/ButtonNotifier.md)[`?`](/API/builtins/nil.md) {#pressed} -### released : [`ButtonNotifier`](/API/aliases/ButtonNotifier.md)[`?`](/API/builtins/nil.md) {#released} -### text : [`ButtonLabel`](/API/aliases/ButtonLabel.md)[`?`](/API/builtins/nil.md) {#text} +### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### pressed : [`ButtonNotifier`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#pressed} +### released : [`ButtonNotifier`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#released} +### text : [`ButtonLabel`](#ButtonLabel)[`?`](/API/builtins/nil.md) {#text} The text label of the button * Default: "" diff --git a/docs/API/structs/ButtonSwitchProperties.md b/docs/API/structs/ButtonSwitchProperties.md index ada222f5..adb36905 100644 --- a/docs/API/structs/ButtonSwitchProperties.md +++ b/docs/API/structs/ButtonSwitchProperties.md @@ -2,14 +2,14 @@ --- ## Properties -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### items : [`ItemLabels`](/API/aliases/ItemLabels.md)[`?`](/API/builtins/nil.md) {#items} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### items : [`ItemLabels`](#ItemLabels)[`?`](/API/builtins/nil.md) {#items} A list of buttons labels to show in order. Must have more than one item. -### notifier : [`IntegerNotifier`](/API/aliases/IntegerNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](/API/builtins/nil.md) {#notifier} Set up a notifier that will be called whenever a new item is picked -### value : [`SelectedItem`](/API/aliases/SelectedItem.md)[`?`](/API/builtins/nil.md) {#value} +### value : [`SelectedItem`](#SelectedItem)[`?`](/API/builtins/nil.md) {#value} The currently selected item's index diff --git a/docs/API/structs/CheckBoxProperties.md b/docs/API/structs/CheckBoxProperties.md index 55669732..aeb43c67 100644 --- a/docs/API/structs/CheckBoxProperties.md +++ b/docs/API/structs/CheckBoxProperties.md @@ -2,11 +2,11 @@ --- ## Properties -### bind : [`ViewBooleanObservable`](/API/aliases/ViewBooleanObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### notifier : [`CheckBoxBooleanNotifier`](/API/aliases/CheckBoxBooleanNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} +### bind : [`ViewBooleanObservable`](#ViewBooleanObservable)[`?`](/API/builtins/nil.md) {#bind} +### notifier : [`CheckBoxBooleanNotifier`](#CheckBoxBooleanNotifier)[`?`](/API/builtins/nil.md) {#notifier} A notifier for when the checkbox is toggled -### value : [`CheckBoxBoolean`](/API/aliases/CheckBoxBoolean.md)[`?`](/API/builtins/nil.md) {#value} +### value : [`CheckBoxBoolean`](#CheckBoxBoolean)[`?`](/API/builtins/nil.md) {#value} The current state of the checkbox, expressed as boolean. * Default: false diff --git a/docs/API/structs/ChooserProperties.md b/docs/API/structs/ChooserProperties.md index fb463d9f..01069eb0 100644 --- a/docs/API/structs/ChooserProperties.md +++ b/docs/API/structs/ChooserProperties.md @@ -2,9 +2,9 @@ --- ## Properties -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### items : [`ItemLabels`](/API/aliases/ItemLabels.md)[`?`](/API/builtins/nil.md) {#items} -### notifier : [`IntegerNotifier`](/API/aliases/IntegerNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### value : [`SelectedItem`](/API/aliases/SelectedItem.md)[`?`](/API/builtins/nil.md) {#value} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### items : [`ItemLabels`](#ItemLabels)[`?`](/API/builtins/nil.md) {#items} +### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### value : [`SelectedItem`](#SelectedItem)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/ControlProperties.md b/docs/API/structs/ControlProperties.md index ac6642fc..69ed0c19 100644 --- a/docs/API/structs/ControlProperties.md +++ b/docs/API/structs/ControlProperties.md @@ -2,13 +2,13 @@ --- ## Properties -### active : [`ControlActive`](/API/aliases/ControlActive.md)[`?`](/API/builtins/nil.md) {#active} +### active : [`ControlActive`](#ControlActive)[`?`](/API/builtins/nil.md) {#active} Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state. -### midi_mapping : [`ControlMidiMappingString`](/API/aliases/ControlMidiMappingString.md)[`?`](/API/builtins/nil.md) {#midi_mapping} +### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/API/builtins/nil.md) {#midi_mapping} When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available diff --git a/docs/API/structs/KeyEvent.md b/docs/API/structs/KeyEvent.md index 9df44fe6..692897e8 100644 --- a/docs/API/structs/KeyEvent.md +++ b/docs/API/structs/KeyEvent.md @@ -5,7 +5,7 @@ ### character : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) {#character} possible character representation of the key -### modifiers : [`ModifierStates`](/API/aliases/ModifierStates.md) {#modifiers} +### modifiers : [`ModifierStates`](#ModifierStates) {#modifiers} the held down modifiers as a string ### name : [`string`](/API/builtins/string.md) {#name} @@ -22,3 +22,20 @@ 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 +" + " +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/structs/MiniSliderProperties.md b/docs/API/structs/MiniSliderProperties.md index 7bc6bd71..56403da9 100644 --- a/docs/API/structs/MiniSliderProperties.md +++ b/docs/API/structs/MiniSliderProperties.md @@ -2,11 +2,11 @@ --- ## Properties -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### default : [`SliderDefaultValue`](/API/aliases/SliderDefaultValue.md)[`?`](/API/builtins/nil.md) {#default} -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md)[`?`](/API/builtins/nil.md) {#max} -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md)[`?`](/API/builtins/nil.md) {#min} -### notifier : [`NumberValueNotifier`](/API/aliases/NumberValueNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md)[`?`](/API/builtins/nil.md) {#value} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](/API/builtins/nil.md) {#default} +### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/API/builtins/nil.md) {#max} +### min : [`SliderMinValue`](#SliderMinValue)[`?`](/API/builtins/nil.md) {#min} +### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/MultilineTextFieldProperties.md b/docs/API/structs/MultilineTextFieldProperties.md index b2462ba3..e8523407 100644 --- a/docs/API/structs/MultilineTextFieldProperties.md +++ b/docs/API/structs/MultilineTextFieldProperties.md @@ -2,14 +2,14 @@ --- ## Properties -### active : [`TextActive`](/API/aliases/TextActive.md)[`?`](/API/builtins/nil.md) {#active} -### bind : [`ViewStringListObservable`](/API/aliases/ViewStringListObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### edit_mode : [`TextEditMode`](/API/aliases/TextEditMode.md)[`?`](/API/builtins/nil.md) {#edit_mode} -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md)[`?`](/API/builtins/nil.md) {#font} -### notifier : [`StringChangeNotifier`](/API/aliases/StringChangeNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### paragraphs : [`TextParagraphs`](/API/aliases/TextParagraphs.md)[`?`](/API/builtins/nil.md) {#paragraphs} -### style : [`TextBackgroundStyle`](/API/aliases/TextBackgroundStyle.md)[`?`](/API/builtins/nil.md) {#style} -### text : [`TextValueAlias`](/API/aliases/TextValueAlias.md)[`?`](/API/builtins/nil.md) {#text} -### value : [`TextMultilineString`](/API/aliases/TextMultilineString.md)[`?`](/API/builtins/nil.md) {#value} +### active : [`TextActive`](#TextActive)[`?`](/API/builtins/nil.md) {#active} +### bind : [`ViewStringListObservable`](#ViewStringListObservable)[`?`](/API/builtins/nil.md) {#bind} +### edit_mode : [`TextEditMode`](#TextEditMode)[`?`](/API/builtins/nil.md) {#edit_mode} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} +### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### paragraphs : [`TextParagraphs`](#TextParagraphs)[`?`](/API/builtins/nil.md) {#paragraphs} +### style : [`TextBackgroundStyle`](#TextBackgroundStyle)[`?`](/API/builtins/nil.md) {#style} +### text : [`TextValueAlias`](#TextValueAlias)[`?`](/API/builtins/nil.md) {#text} +### value : [`TextMultilineString`](#TextMultilineString)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/MultilineTextViewProperties.md b/docs/API/structs/MultilineTextViewProperties.md index 3b53610d..f6dd249a 100644 --- a/docs/API/structs/MultilineTextViewProperties.md +++ b/docs/API/structs/MultilineTextViewProperties.md @@ -2,16 +2,16 @@ --- ## Properties -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md)[`?`](/API/builtins/nil.md) {#font} -### paragraphs : [`TextParagraphs`](/API/aliases/TextParagraphs.md)[`?`](/API/builtins/nil.md) {#paragraphs} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} +### paragraphs : [`TextParagraphs`](#TextParagraphs)[`?`](/API/builtins/nil.md) {#paragraphs} A table of text lines to be used instead of specifying a single text line with newline characters like "text" * Default: [] -### style : [`TextBackgroundStyle`](/API/aliases/TextBackgroundStyle.md)[`?`](/API/builtins/nil.md) {#style} +### style : [`TextBackgroundStyle`](#TextBackgroundStyle)[`?`](/API/builtins/nil.md) {#style} Setup the text view's background: -### text : [`TextMultilineString`](/API/aliases/TextMultilineString.md)[`?`](/API/builtins/nil.md) {#text} +### text : [`TextMultilineString`](#TextMultilineString)[`?`](/API/builtins/nil.md) {#text} The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs. diff --git a/docs/API/structs/NotifierClass.md b/docs/API/structs/NotifierClass.md index cc304701..ef2c5d40 100644 --- a/docs/API/structs/NotifierClass.md +++ b/docs/API/structs/NotifierClass.md @@ -24,8 +24,8 @@ end --- ## Properties -### socket_accepted : (self : [`any`](/API/builtins/any.md), socket : [`renoise.Socket.SocketClient`](/API/renoise.Socket.SocketClient.md))[`?`](/API/builtins/nil.md) {#socket_accepted} +### socket_accepted : (self : [`any`](/API/builtins/any.md), socket : [`renoise.Socket.SocketClient`](/API/renoise/renoise.Socket.SocketClient.md))[`?`](/API/builtins/nil.md) {#socket_accepted} ### socket_error : (self : [`any`](/API/builtins/any.md), error_message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_error} -### socket_message : (self : [`any`](/API/builtins/any.md), socket : [`renoise.Socket.SocketClient`](/API/renoise.Socket.SocketClient.md), message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_message} +### socket_message : (self : [`any`](/API/builtins/any.md), socket : [`renoise.Socket.SocketClient`](/API/renoise/renoise.Socket.SocketClient.md), message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_message} diff --git a/docs/API/structs/NotifierTable.md b/docs/API/structs/NotifierTable.md index 44541bbe..f3b310aa 100644 --- a/docs/API/structs/NotifierTable.md +++ b/docs/API/structs/NotifierTable.md @@ -21,7 +21,7 @@ All callback properties are optional. So you can, for example, skip specifying --- ## Properties -### socket_accepted : (client : [`renoise.Socket.SocketClient`](/API/renoise.Socket.SocketClient.md))[`?`](/API/builtins/nil.md) {#socket_accepted} +### socket_accepted : (client : [`renoise.Socket.SocketClient`](/API/renoise/renoise.Socket.SocketClient.md))[`?`](/API/builtins/nil.md) {#socket_accepted} FOR TCP CONNECTIONS ONLY: called as soon as a new client connected to your server. The passed socket is a ready to use socket object, representing a connection to the new socket. @@ -29,7 +29,7 @@ object, representing a connection to the new socket. ### socket_error : (error_message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_error} An error happened in the servers background thread. -### socket_message : (client : [`renoise.Socket.SocketClient`](/API/renoise.Socket.SocketClient.md), message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_message} +### socket_message : (client : [`renoise.Socket.SocketClient`](/API/renoise/renoise.Socket.SocketClient.md), message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_message} A message was received from a client: The passed socket is a ready to use connection for TCP connections. For UDP, a "dummy" socket is passed, which can only be used to query the peer address and port diff --git a/docs/API/structs/OscValue.md b/docs/API/structs/OscValue.md index 1d048512..5765b6e5 100644 --- a/docs/API/structs/OscValue.md +++ b/docs/API/structs/OscValue.md @@ -8,7 +8,32 @@ specified. For more info, see: http://opensoundcontrol.org/spec-1_0 --- ## Properties -### tag : [`OscTag`](/API/aliases/OscTag.md) {#tag} +### 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/structs/PopUpMenuProperties.md b/docs/API/structs/PopUpMenuProperties.md index 69936065..3020c560 100644 --- a/docs/API/structs/PopUpMenuProperties.md +++ b/docs/API/structs/PopUpMenuProperties.md @@ -2,12 +2,12 @@ --- ## Properties -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### items : [`PopupItemLabels`](/API/aliases/PopupItemLabels.md)[`?`](/API/builtins/nil.md) {#items} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### items : [`PopupItemLabels`](#PopupItemLabels)[`?`](/API/builtins/nil.md) {#items} A list of buttons labels to show in order The list can be empty, then "None" is displayed and the value won't change. -### notifier : [`IntegerNotifier`](/API/aliases/IntegerNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### value : [`SelectedItem`](/API/aliases/SelectedItem.md)[`?`](/API/builtins/nil.md) {#value} +### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### value : [`SelectedItem`](#SelectedItem)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/RackViewProperties.md b/docs/API/structs/RackViewProperties.md index ac207bb7..63ed5ab8 100644 --- a/docs/API/structs/RackViewProperties.md +++ b/docs/API/structs/RackViewProperties.md @@ -2,17 +2,17 @@ --- ## Properties -### margin : [`RackMargin`](/API/aliases/RackMargin.md)[`?`](/API/builtins/nil.md) {#margin} +### margin : [`RackMargin`](#RackMargin)[`?`](/API/builtins/nil.md) {#margin} Set the "borders" of a rack (left, right, top and bottom inclusively) * Default: 0 (no borders) -### spacing : [`RackSpacing`](/API/aliases/RackSpacing.md)[`?`](/API/builtins/nil.md) {#spacing} +### spacing : [`RackSpacing`](#RackSpacing)[`?`](/API/builtins/nil.md) {#spacing} Set the amount stacked child views are separated by (horizontally in rows, vertically in columns). * Default: 0 (no spacing) -### style : [`ViewBackgroundStyle`](/API/aliases/ViewBackgroundStyle.md)[`?`](/API/builtins/nil.md) {#style} -### uniform : [`RackUniformity`](/API/aliases/RackUniformity.md)[`?`](/API/builtins/nil.md) {#uniform} +### style : [`ViewBackgroundStyle`](#ViewBackgroundStyle)[`?`](/API/builtins/nil.md) {#style} +### uniform : [`RackUniformity`](#RackUniformity)[`?`](/API/builtins/nil.md) {#uniform} When set to true, all child views in the rack are automatically resized to the max size of all child views (width in ViewBuilder.column, height in ViewBuilder.row). This can be useful to automatically align all sub diff --git a/docs/API/structs/RenderOptions.md b/docs/API/structs/RenderOptions.md index c9559e3f..f2b7ba10 100644 --- a/docs/API/structs/RenderOptions.md +++ b/docs/API/structs/RenderOptions.md @@ -5,7 +5,7 @@ ### bit_depth : `16` | `24` | `32` {#bit_depth} by default 32. -### end_pos : [`renoise.SongPos`](/API/renoise.SongPos.md) {#end_pos} +### end_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#end_pos} by default the song end. ### interpolation : `"default"` | `"precise"` {#interpolation} @@ -17,7 +17,7 @@ by default "high". ### sample_rate : `192000` | `22050` | `44100` | `48000` | `88200` | `96000` {#sample_rate} by default the players current rate. -### start_pos : [`renoise.SongPos`](/API/renoise.SongPos.md) {#start_pos} +### start_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#start_pos} by default the song start. diff --git a/docs/API/structs/RotaryEncoderProperties.md b/docs/API/structs/RotaryEncoderProperties.md index d9041fbe..4648b88a 100644 --- a/docs/API/structs/RotaryEncoderProperties.md +++ b/docs/API/structs/RotaryEncoderProperties.md @@ -2,11 +2,11 @@ --- ## Properties -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### default : [`SliderDefaultValue`](/API/aliases/SliderDefaultValue.md)[`?`](/API/builtins/nil.md) {#default} -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md)[`?`](/API/builtins/nil.md) {#max} -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md)[`?`](/API/builtins/nil.md) {#min} -### notifier : [`NumberValueNotifier`](/API/aliases/NumberValueNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md)[`?`](/API/builtins/nil.md) {#value} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](/API/builtins/nil.md) {#default} +### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/API/builtins/nil.md) {#max} +### min : [`SliderMinValue`](#SliderMinValue)[`?`](/API/builtins/nil.md) {#min} +### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/SliderProperties.md b/docs/API/structs/SliderProperties.md index 0658a2d8..4026fe16 100644 --- a/docs/API/structs/SliderProperties.md +++ b/docs/API/structs/SliderProperties.md @@ -2,26 +2,26 @@ --- ## Properties -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### default : [`SliderDefaultValue`](/API/aliases/SliderDefaultValue.md)[`?`](/API/builtins/nil.md) {#default} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](/API/builtins/nil.md) {#default} The default value that will be re-applied on double-click -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md)[`?`](/API/builtins/nil.md) {#max} +### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/API/builtins/nil.md) {#max} The maximum value that can be set using the view * Default: 1.0 -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md)[`?`](/API/builtins/nil.md) {#min} +### min : [`SliderMinValue`](#SliderMinValue)[`?`](/API/builtins/nil.md) {#min} The minimum value that can be set using the view * Default: 0 -### notifier : [`NumberValueNotifier`](/API/aliases/NumberValueNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### steps : [`SliderStepAmounts`](/API/aliases/SliderStepAmounts.md)[`?`](/API/builtins/nil.md) {#steps} +### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### steps : [`SliderStepAmounts`](#SliderStepAmounts)[`?`](/API/builtins/nil.md) {#steps} A table containing two numbers representing the step amounts for incrementing and decrementing by clicking the <> buttons. The first value is the small step (applied on left clicks) second value is the big step (applied on right clicks) -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} The current value of the view diff --git a/docs/API/structs/TextFieldProperties.md b/docs/API/structs/TextFieldProperties.md index 28fefacd..3bbb28a3 100644 --- a/docs/API/structs/TextFieldProperties.md +++ b/docs/API/structs/TextFieldProperties.md @@ -2,25 +2,25 @@ --- ## Properties -### active : [`TextActive`](/API/aliases/TextActive.md)[`?`](/API/builtins/nil.md) {#active} +### active : [`TextActive`](#TextActive)[`?`](/API/builtins/nil.md) {#active} When false, text is displayed but can not be entered/modified by the user. * Default: true -### align : [`TextAlignment`](/API/aliases/TextAlignment.md)[`?`](/API/builtins/nil.md) {#align} -### bind : [`ViewStringObservable`](/API/aliases/ViewStringObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### edit_mode : [`TextEditMode`](/API/aliases/TextEditMode.md)[`?`](/API/builtins/nil.md) {#edit_mode} +### align : [`TextAlignment`](#TextAlignment)[`?`](/API/builtins/nil.md) {#align} +### bind : [`ViewStringObservable`](#ViewStringObservable)[`?`](/API/builtins/nil.md) {#bind} +### edit_mode : [`TextEditMode`](#TextEditMode)[`?`](/API/builtins/nil.md) {#edit_mode} True when the text field is focused. setting it at run-time programmatically will focus the text field or remove the focus (focus the dialog) accordingly. * Default: false -### notifier : [`StringChangeNotifier`](/API/aliases/StringChangeNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](/API/builtins/nil.md) {#notifier} Set up a notifier for text changes -### text : [`TextValueAlias`](/API/aliases/TextValueAlias.md)[`?`](/API/builtins/nil.md) {#text} +### text : [`TextValueAlias`](#TextValueAlias)[`?`](/API/builtins/nil.md) {#text} Exactly the same as "value"; provided for consistency. * Default: "" -### value : [`TextValue`](/API/aliases/TextValue.md)[`?`](/API/builtins/nil.md) {#value} +### value : [`TextValue`](#TextValue)[`?`](/API/builtins/nil.md) {#value} The currently shown text. The text will not be updated when editing, rather only after editing is complete (return is pressed, or focus is lost). * Default: "" diff --git a/docs/API/structs/TextViewProperties.md b/docs/API/structs/TextViewProperties.md index aa482936..43475a62 100644 --- a/docs/API/structs/TextViewProperties.md +++ b/docs/API/structs/TextViewProperties.md @@ -2,17 +2,17 @@ --- ## Properties -### align : [`TextAlignment`](/API/aliases/TextAlignment.md)[`?`](/API/builtins/nil.md) {#align} +### align : [`TextAlignment`](#TextAlignment)[`?`](/API/builtins/nil.md) {#align} Setup the text's alignment. Applies only when the view's size is larger than the needed size to draw the text -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md)[`?`](/API/builtins/nil.md) {#font} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} The style that the text should be displayed with. -### style : [`TextStyle`](/API/aliases/TextStyle.md)[`?`](/API/builtins/nil.md) {#style} +### style : [`TextStyle`](#TextStyle)[`?`](/API/builtins/nil.md) {#style} Get/set the color style the text should be displayed with. -### text : [`TextSingleLineString`](/API/aliases/TextSingleLineString.md)[`?`](/API/builtins/nil.md) {#text} +### text : [`TextSingleLineString`](#TextSingleLineString)[`?`](/API/builtins/nil.md) {#text} The text that should be displayed. Setting a new text will resize the view in order to make the text fully visible (expanding only). * Default: "" diff --git a/docs/API/structs/ToolFileImportHook.md b/docs/API/structs/ToolFileImportHook.md index 9ae08917..10e939bb 100644 --- a/docs/API/structs/ToolFileImportHook.md +++ b/docs/API/structs/ToolFileImportHook.md @@ -13,7 +13,7 @@ Preloading/prehearing sample files is not supported via tools. --- ## Properties -### category : [`FileHookCategory`](/API/aliases/FileHookCategory.md) {#category} +### category : [`FileHookCategory`](#FileHookCategory) {#category} In which disk browser category the file type shows up. One of @@ -27,3 +27,21 @@ succeeded, else false. + + +--- +## Aliases +# alias FileHookCategory {#FileHookCategory} +`"effect chain"` | `"effect preset"` | `"instrument"` | `"modulation set"` | `"phrase"` | `"sample"` | `"song"` | `"theme"` +```lua +FileHookCategory: + | "song" + | "instrument" + | "effect chain" + | "effect preset" + | "modulation set" + | "phrase" + | "sample" + | "theme" +``` + diff --git a/docs/API/structs/ToolMidiMappingEntry.md b/docs/API/structs/ToolMidiMappingEntry.md index 2e9745dd..7544aa8e 100644 --- a/docs/API/structs/ToolMidiMappingEntry.md +++ b/docs/API/structs/ToolMidiMappingEntry.md @@ -12,7 +12,7 @@ messages. --- ## Properties -### invoke : (message : [`renoise.ScriptingTool.MidiMessage`](/API/renoise.ScriptingTool.MidiMessage.md)) {#invoke} +### invoke : (message : [`renoise.ScriptingTool.MidiMessage`](/API/renoise/renoise.ScriptingTool.MidiMessage.md)) {#invoke} A function that is called to handle a bound MIDI message. ### name : [`string`](/API/builtins/string.md) {#name} diff --git a/docs/API/structs/ValueBoxProperties.md b/docs/API/structs/ValueBoxProperties.md index f390d452..94a72581 100644 --- a/docs/API/structs/ValueBoxProperties.md +++ b/docs/API/structs/ValueBoxProperties.md @@ -2,25 +2,25 @@ --- ## Properties -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### max : [`ValueBoxMaxValue`](/API/aliases/ValueBoxMaxValue.md)[`?`](/API/builtins/nil.md) {#max} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### max : [`ValueBoxMaxValue`](#ValueBoxMaxValue)[`?`](/API/builtins/nil.md) {#max} The maximum value that can be set using the view * Default: 100 -### min : [`ValueBoxMinValue`](/API/aliases/ValueBoxMinValue.md)[`?`](/API/builtins/nil.md) {#min} +### min : [`ValueBoxMinValue`](#ValueBoxMinValue)[`?`](/API/builtins/nil.md) {#min} The minimum value that can be set using the view * Default: 0 -### notifier : [`NumberValueNotifier`](/API/aliases/NumberValueNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](/API/builtins/nil.md) {#notifier} Set up a value notifier that will be called whenever the value changes -### steps : [`SliderStepAmounts`](/API/aliases/SliderStepAmounts.md)[`?`](/API/builtins/nil.md) {#steps} -### tonumber : [`PairedParseStringAsNumber`](/API/aliases/PairedParseStringAsNumber.md)[`?`](/API/builtins/nil.md) {#tonumber} +### steps : [`SliderStepAmounts`](#SliderStepAmounts)[`?`](/API/builtins/nil.md) {#steps} +### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](/API/builtins/nil.md) {#tonumber} Make sure to also set `tostring` if you set this. -### tostring : [`PairedShowNumberAsString`](/API/aliases/PairedShowNumberAsString.md)[`?`](/API/builtins/nil.md) {#tostring} +### tostring : [`PairedShowNumberAsString`](#PairedShowNumberAsString)[`?`](/API/builtins/nil.md) {#tostring} Make sure to also set `tonumber` if you set this. -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/ValueFieldProperties.md b/docs/API/structs/ValueFieldProperties.md index 1c23622b..e2933c1e 100644 --- a/docs/API/structs/ValueFieldProperties.md +++ b/docs/API/structs/ValueFieldProperties.md @@ -2,13 +2,13 @@ --- ## Properties -### align : [`TextAlignment`](/API/aliases/TextAlignment.md)[`?`](/API/builtins/nil.md) {#align} -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### max : [`SliderMaxValue`](/API/aliases/SliderMaxValue.md)[`?`](/API/builtins/nil.md) {#max} -### min : [`SliderMinValue`](/API/aliases/SliderMinValue.md)[`?`](/API/builtins/nil.md) {#min} -### notifier : [`NumberValueNotifier`](/API/aliases/NumberValueNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### tonumber : [`PairedParseStringAsNumber`](/API/aliases/PairedParseStringAsNumber.md)[`?`](/API/builtins/nil.md) {#tonumber} -### tostring : [`PairedShowNumberAsString`](/API/aliases/PairedShowNumberAsString.md)[`?`](/API/builtins/nil.md) {#tostring} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md)[`?`](/API/builtins/nil.md) {#value} +### align : [`TextAlignment`](#TextAlignment)[`?`](/API/builtins/nil.md) {#align} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/API/builtins/nil.md) {#max} +### min : [`SliderMinValue`](#SliderMinValue)[`?`](/API/builtins/nil.md) {#min} +### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](/API/builtins/nil.md) {#tonumber} +### tostring : [`PairedShowNumberAsString`](#PairedShowNumberAsString)[`?`](/API/builtins/nil.md) {#tostring} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/ValueViewProperties.md b/docs/API/structs/ValueViewProperties.md index cfcf8f42..3e74a122 100644 --- a/docs/API/structs/ValueViewProperties.md +++ b/docs/API/structs/ValueViewProperties.md @@ -2,11 +2,11 @@ --- ## Properties -### align : [`TextAlignment`](/API/aliases/TextAlignment.md)[`?`](/API/builtins/nil.md) {#align} -### bind : [`ViewNumberObservable`](/API/aliases/ViewNumberObservable.md)[`?`](/API/builtins/nil.md) {#bind} -### font : [`TextFontStyle`](/API/aliases/TextFontStyle.md)[`?`](/API/builtins/nil.md) {#font} -### notifier : [`NumberValueNotifier`](/API/aliases/NumberValueNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} -### tostring : [`ShowNumberAsString`](/API/aliases/ShowNumberAsString.md)[`?`](/API/builtins/nil.md) {#tostring} -### value : [`SliderNumberValue`](/API/aliases/SliderNumberValue.md)[`?`](/API/builtins/nil.md) {#value} +### align : [`TextAlignment`](#TextAlignment)[`?`](/API/builtins/nil.md) {#align} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} +### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### tostring : [`ShowNumberAsString`](#ShowNumberAsString)[`?`](/API/builtins/nil.md) {#tostring} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} diff --git a/docs/API/structs/ViewBuilderInstance.md b/docs/API/structs/ViewBuilderInstance.md index 42978f99..0caa0957 100644 --- a/docs/API/structs/ViewBuilderInstance.md +++ b/docs/API/structs/ViewBuilderInstance.md @@ -29,7 +29,7 @@ Creates a column view with `margin = 1` and adds two text views to the column. --- ## Properties -### views : table<[`string`](/API/builtins/string.md), [`renoise.Views.View`](/API/renoise.Views.View.md)> {#views} +### views : table<[`string`](/API/builtins/string.md), [`renoise.Views.View`](/API/renoise/renoise.Views.View.md)> {#views} Table of views, which got registered via the "id" property View id is the table key, the table's value is the view's object. @@ -46,19 +46,19 @@ vb.views["my_view"].visible = false --- ## Functions ### `bitmap`([*self*](/API/builtins/self.md), properties : [`BitmapViewProperties`](/API/structs/BitmapViewProperties.md)[`?`](/API/builtins/nil.md)) {#bitmap} -`->`[`renoise.Views.Bitmap`](/API/renoise.Views.Bitmap.md) +`->`[`renoise.Views.Bitmap`](/API/renoise/renoise.Views.Bitmap.md) See: ~renoise.Views.Bitmap~ ### `button`([*self*](/API/builtins/self.md), properties : [`ButtonProperties`](/API/structs/ButtonProperties.md)[`?`](/API/builtins/nil.md)) {#button} -`->`[`renoise.Views.Button`](/API/renoise.Views.Button.md) +`->`[`renoise.Views.Button`](/API/renoise/renoise.Views.Button.md) See: ~renoise.Views.Button~ ### `checkbox`([*self*](/API/builtins/self.md), properties : [`CheckBoxProperties`](/API/structs/CheckBoxProperties.md)[`?`](/API/builtins/nil.md)) {#checkbox} -`->`[`renoise.Views.CheckBox`](/API/renoise.Views.CheckBox.md) +`->`[`renoise.Views.CheckBox`](/API/renoise/renoise.Views.CheckBox.md) See: ~renoise.Views.CheckBox~ ### `chooser`([*self*](/API/builtins/self.md), properties : [`ChooserProperties`](/API/structs/ChooserProperties.md)[`?`](/API/builtins/nil.md)) {#chooser} -`->`[`renoise.Views.Chooser`](/API/renoise.Views.Chooser.md) +`->`[`renoise.Views.Chooser`](/API/renoise/renoise.Views.Chooser.md) See: ~renoise.Views.Chooser~ ### `column`([*self*](/API/builtins/self.md), properties : [`RackViewProperties`](/API/structs/RackViewProperties.md)) {#column} @@ -94,23 +94,23 @@ vb:horizontal_aligner { } ``` ### `minislider`([*self*](/API/builtins/self.md), properties : [`MiniSliderProperties`](/API/structs/MiniSliderProperties.md)[`?`](/API/builtins/nil.md)) {#minislider} -`->`[`renoise.Views.MiniSlider`](/API/renoise.Views.MiniSlider.md) +`->`[`renoise.Views.MiniSlider`](/API/renoise/renoise.Views.MiniSlider.md) See: ~renoise.Views.MiniSlider~ ### `multiline_text`([*self*](/API/builtins/self.md), properties : [`MultilineTextViewProperties`](/API/structs/MultilineTextViewProperties.md)[`?`](/API/builtins/nil.md)) {#multiline_text} -`->`[`renoise.Views.MultiLineText`](/API/renoise.Views.MultiLineText.md) +`->`[`renoise.Views.MultiLineText`](/API/renoise/renoise.Views.MultiLineText.md) See: ~renoise.Views.MultiLineText~ ### `multiline_textfield`([*self*](/API/builtins/self.md), properties : [`MultilineTextFieldProperties`](/API/structs/MultilineTextFieldProperties.md)[`?`](/API/builtins/nil.md)) {#multiline_textfield} -`->`[`renoise.Views.MultiLineTextField`](/API/renoise.Views.MultiLineTextField.md) +`->`[`renoise.Views.MultiLineTextField`](/API/renoise/renoise.Views.MultiLineTextField.md) See: ~renoise.Views.MultiLineTextField~ ### `popup`([*self*](/API/builtins/self.md), properties : [`PopUpMenuProperties`](/API/structs/PopUpMenuProperties.md)[`?`](/API/builtins/nil.md)) {#popup} -`->`[`renoise.Views.Popup`](/API/renoise.Views.Popup.md) +`->`[`renoise.Views.Popup`](/API/renoise/renoise.Views.Popup.md) See: ~renoise.Views.Popup~ ### `rotary`([*self*](/API/builtins/self.md), properties : [`RotaryEncoderProperties`](/API/structs/RotaryEncoderProperties.md)[`?`](/API/builtins/nil.md)) {#rotary} -`->`[`renoise.Views.RotaryEncoder`](/API/renoise.Views.RotaryEncoder.md) +`->`[`renoise.Views.RotaryEncoder`](/API/renoise/renoise.Views.RotaryEncoder.md) See: ~renoise.Views.RotaryEncoder~ ### `row`([*self*](/API/builtins/self.md), properties : [`RackViewProperties`](/API/structs/RackViewProperties.md)) {#row} @@ -130,7 +130,7 @@ vb:column { } ``` ### `slider`([*self*](/API/builtins/self.md), properties : [`SliderProperties`](/API/structs/SliderProperties.md)[`?`](/API/builtins/nil.md)) {#slider} -`->`[`renoise.Views.Slider`](/API/renoise.Views.Slider.md) +`->`[`renoise.Views.Slider`](/API/renoise/renoise.Views.Slider.md) See: ~renoise.Views.Slider~ ### `space`([*self*](/API/builtins/self.md), properties : [`ViewProperties`](/API/structs/ViewProperties.md)) {#space} @@ -152,27 +152,27 @@ vb:row { } ``` ### `switch`([*self*](/API/builtins/self.md), properties : [`ButtonSwitchProperties`](/API/structs/ButtonSwitchProperties.md)[`?`](/API/builtins/nil.md)) {#switch} -`->`[`renoise.Views.Switch`](/API/renoise.Views.Switch.md) +`->`[`renoise.Views.Switch`](/API/renoise/renoise.Views.Switch.md) See: ~renoise.Views.Switch~ ### `text`([*self*](/API/builtins/self.md), properties : [`TextViewProperties`](/API/structs/TextViewProperties.md)[`?`](/API/builtins/nil.md)) {#text} -`->`[`renoise.Views.Text`](/API/renoise.Views.Text.md) +`->`[`renoise.Views.Text`](/API/renoise/renoise.Views.Text.md) See: ~renoise.Views.Text~ ### `textfield`([*self*](/API/builtins/self.md), properties : [`TextFieldProperties`](/API/structs/TextFieldProperties.md)[`?`](/API/builtins/nil.md)) {#textfield} -`->`[`renoise.Views.TextField`](/API/renoise.Views.TextField.md) +`->`[`renoise.Views.TextField`](/API/renoise/renoise.Views.TextField.md) See: ~renoise.Views.TextField~ ### `value`([*self*](/API/builtins/self.md), properties : [`ValueViewProperties`](/API/structs/ValueViewProperties.md)[`?`](/API/builtins/nil.md)) {#value} -`->`[`renoise.Views.Value`](/API/renoise.Views.Value.md) +`->`[`renoise.Views.Value`](/API/renoise/renoise.Views.Value.md) See: ~renoise.Views.Value~ ### `valuebox`([*self*](/API/builtins/self.md), properties : [`ValueBoxProperties`](/API/structs/ValueBoxProperties.md)[`?`](/API/builtins/nil.md)) {#valuebox} -`->`[`renoise.Views.ValueBox`](/API/renoise.Views.ValueBox.md) +`->`[`renoise.Views.ValueBox`](/API/renoise/renoise.Views.ValueBox.md) See: ~renoise.Views.ValueBox~ ### `valuefield`([*self*](/API/builtins/self.md), properties : [`ValueFieldProperties`](/API/structs/ValueFieldProperties.md)[`?`](/API/builtins/nil.md)) {#valuefield} -`->`[`renoise.Views.ValueField`](/API/renoise.Views.ValueField.md) +`->`[`renoise.Views.ValueField`](/API/renoise/renoise.Views.ValueField.md) See: ~renoise.Views.ValueField~ ### `vertical_aligner`([*self*](/API/builtins/self.md), properties : [`AlignerViewProperties`](/API/structs/AlignerViewProperties.md)) {#vertical_aligner} @@ -192,7 +192,7 @@ vb:horizontal_aligner { } ``` ### `xypad`([*self*](/API/builtins/self.md), properties : [`XYPadProperties`](/API/structs/XYPadProperties.md)[`?`](/API/builtins/nil.md)) {#xypad} -`->`[`renoise.Views.XYPad`](/API/renoise.Views.XYPad.md) +`->`[`renoise.Views.XYPad`](/API/renoise/renoise.Views.XYPad.md) See: ~renoise.Views.XYPad~ diff --git a/docs/API/structs/ViewProperties.md b/docs/API/structs/ViewProperties.md index 140d40f5..004119d1 100644 --- a/docs/API/structs/ViewProperties.md +++ b/docs/API/structs/ViewProperties.md @@ -3,28 +3,28 @@ --- ## Properties -### height : [`ViewDimension`](/API/aliases/ViewDimension.md)[`?`](/API/builtins/nil.md) {#height} +### height : [`ViewDimension`](#ViewDimension)[`?`](/API/builtins/nil.md) {#height} The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example `vb:text { width = "80%"}`. The percentage values are relative to the view's parent size and will automatically update on size changes. -### id : [`ViewId`](/API/aliases/ViewId.md)[`?`](/API/builtins/nil.md) {#id} +### id : [`ViewId`](#ViewId)[`?`](/API/builtins/nil.md) {#id} Unique identifier to resolve the view later on in the viewbuilder, e.g. `vb.views.SomeString` or `vb.views["Some String"]` View ids must be unique within a single view builder instance. -### tooltip : [`ViewTooltip`](/API/aliases/ViewTooltip.md)[`?`](/API/builtins/nil.md) {#tooltip} +### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/API/builtins/nil.md) {#tooltip} A tooltip text that should be shown for this view on mouse hover. * Default: "" (no tip will be shown) -### visible : [`ViewVisibility`](/API/aliases/ViewVisibility.md)[`?`](/API/builtins/nil.md) {#visible} +### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/API/builtins/nil.md) {#visible} Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible). * Default: true -### width : [`ViewDimension`](/API/aliases/ViewDimension.md)[`?`](/API/builtins/nil.md) {#width} +### width : [`ViewDimension`](#ViewDimension)[`?`](/API/builtins/nil.md) {#width} The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example `vb:text { width = "80%"}`. The percentage values are diff --git a/docs/API/structs/XYPadProperties.md b/docs/API/structs/XYPadProperties.md index e2575180..d40b96ea 100644 --- a/docs/API/structs/XYPadProperties.md +++ b/docs/API/structs/XYPadProperties.md @@ -2,7 +2,7 @@ --- ## Properties -### bind : [`XYPadObservables`](/API/aliases/XYPadObservables.md)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`XYPadObservables`](#XYPadObservables)[`?`](/API/builtins/nil.md) {#bind} Bind the view's value to a pair of renoise.Document.ObservableNumber objects. Automatically keep both values in sync. Will change the Observables' values as soon as the view's value changes, @@ -12,25 +12,25 @@ Just like in the other XYPad properties, a table with the fields X and Y is expected here and not a single value. So you have to bind two ObservableNumber object to the pad. -### max : [`XYPadMaxValues`](/API/aliases/XYPadMaxValues.md)[`?`](/API/builtins/nil.md) {#max} +### max : [`XYPadMaxValues`](#XYPadMaxValues)[`?`](/API/builtins/nil.md) {#max} A table of allowed maximum values for each axis * Default: {x: 1.0, y: 1.0} -### min : [`XYPadMinValues`](/API/aliases/XYPadMinValues.md)[`?`](/API/builtins/nil.md) {#min} +### min : [`XYPadMinValues`](#XYPadMinValues)[`?`](/API/builtins/nil.md) {#min} A table of allowed minimum values for each axis * Default: {x: 0.0, y: 0.0} -### notifier : [`XYValueNotifier`](/API/aliases/XYValueNotifier.md)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`XYValueNotifier`](#XYValueNotifier)[`?`](/API/builtins/nil.md) {#notifier} Set up a value notifier function that will be used whenever the pad's values change -### snapback : [`XYPadSnapbackValues`](/API/aliases/XYPadSnapbackValues.md)[`?`](/API/builtins/nil.md) {#snapback} +### snapback : [`XYPadSnapbackValues`](#XYPadSnapbackValues)[`?`](/API/builtins/nil.md) {#snapback} A table of snapback values for each axis When snapback is enabled, the pad will revert its values to the specified snapback values as soon as the mouse button is released in the pad. When disabled, releasing the mouse button will not change the value. You can disable snapback at runtime by setting it to nil or an empty table. -### value : [`XYPadValues`](/API/aliases/XYPadValues.md)[`?`](/API/builtins/nil.md) {#value} +### value : [`XYPadValues`](#XYPadValues)[`?`](/API/builtins/nil.md) {#value} A table of the XYPad's current values on each axis diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index bbfc0765..dff9fc3a 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -13,230 +13,99 @@ - [API](API/README.md) - [renoise](API/renoise.md) - - [renoise.Application](API/renoise.Application.md) - - [renoise.ApplicationWindow](API/renoise.ApplicationWindow.md) - - [renoise.AudioDevice](API/renoise.AudioDevice.md) - - [renoise.DeviceParameter](API/renoise.DeviceParameter.md) - - [renoise.Dialog](API/renoise.Dialog.md) - - [renoise.Document](API/renoise.Document.md) - - [renoise.Document.DocumentList](API/renoise.Document.DocumentList.md) - - [renoise.Document.DocumentNode](API/renoise.Document.DocumentNode.md) - - [renoise.Document.Observable](API/renoise.Document.Observable.md) - - [renoise.Document.ObservableBang](API/renoise.Document.ObservableBang.md) - - [renoise.Document.ObservableBoolean](API/renoise.Document.ObservableBoolean.md) - - [renoise.Document.ObservableBooleanList](API/renoise.Document.ObservableBooleanList.md) - - [renoise.Document.ObservableList](API/renoise.Document.ObservableList.md) - - [renoise.Document.ObservableNumber](API/renoise.Document.ObservableNumber.md) - - [renoise.Document.ObservableNumberList](API/renoise.Document.ObservableNumberList.md) - - [renoise.Document.ObservableString](API/renoise.Document.ObservableString.md) - - [renoise.Document.ObservableStringList](API/renoise.Document.ObservableStringList.md) - - [renoise.Document.Serializable](API/renoise.Document.Serializable.md) - - [renoise.EffectColumn](API/renoise.EffectColumn.md) - - [renoise.GroupTrack](API/renoise.GroupTrack.md) - - [renoise.Instrument](API/renoise.Instrument.md) - - [renoise.InstrumentDevice](API/renoise.InstrumentDevice.md) - - [renoise.InstrumentMacro](API/renoise.InstrumentMacro.md) - - [renoise.InstrumentMacroMapping](API/renoise.InstrumentMacroMapping.md) - - [renoise.InstrumentMidiInputProperties](API/renoise.InstrumentMidiInputProperties.md) - - [renoise.InstrumentMidiOutputProperties](API/renoise.InstrumentMidiOutputProperties.md) - - [renoise.InstrumentPhrase](API/renoise.InstrumentPhrase.md) - - [renoise.InstrumentPhraseMapping](API/renoise.InstrumentPhraseMapping.md) - - [renoise.InstrumentPluginDevice](API/renoise.InstrumentPluginDevice.md) - - [renoise.InstrumentPluginProperties](API/renoise.InstrumentPluginProperties.md) - - [renoise.InstrumentTriggerOptions](API/renoise.InstrumentTriggerOptions.md) - - [renoise.Midi](API/renoise.Midi.md) - - [renoise.Midi.MidiDevice](API/renoise.Midi.MidiDevice.md) - - [renoise.Midi.MidiInputDevice](API/renoise.Midi.MidiInputDevice.md) - - [renoise.Midi.MidiOutputDevice](API/renoise.Midi.MidiOutputDevice.md) - - [renoise.NoteColumn](API/renoise.NoteColumn.md) - - [renoise.Osc](API/renoise.Osc.md) - - [renoise.Osc.Bundle](API/renoise.Osc.Bundle.md) - - [renoise.Osc.Message](API/renoise.Osc.Message.md) - - [renoise.Pattern](API/renoise.Pattern.md) - - [renoise.PatternIterator](API/renoise.PatternIterator.md) - - [renoise.PatternLine](API/renoise.PatternLine.md) - - [renoise.PatternSequencer](API/renoise.PatternSequencer.md) - - [renoise.PatternTrack](API/renoise.PatternTrack.md) - - [renoise.PatternTrackAutomation](API/renoise.PatternTrackAutomation.md) - - [renoise.Sample](API/renoise.Sample.md) - - [renoise.SampleAhdrsModulationDevice](API/renoise.SampleAhdrsModulationDevice.md) - - [renoise.SampleBuffer](API/renoise.SampleBuffer.md) - - [renoise.SampleDeviceChain](API/renoise.SampleDeviceChain.md) - - [renoise.SampleEnvelopeModulationDevice](API/renoise.SampleEnvelopeModulationDevice.md) - - [renoise.SampleFaderModulationDevice](API/renoise.SampleFaderModulationDevice.md) - - [renoise.SampleKeyTrackingModulationDevice](API/renoise.SampleKeyTrackingModulationDevice.md) - - [renoise.SampleLfoModulationDevice](API/renoise.SampleLfoModulationDevice.md) - - [renoise.SampleMapping](API/renoise.SampleMapping.md) - - [renoise.SampleModulationDevice](API/renoise.SampleModulationDevice.md) - - [renoise.SampleModulationSet](API/renoise.SampleModulationSet.md) - - [renoise.SampleOperandModulationDevice](API/renoise.SampleOperandModulationDevice.md) - - [renoise.SampleStepperModulationDevice](API/renoise.SampleStepperModulationDevice.md) - - [renoise.SampleVelocityTrackingModulationDevice](API/renoise.SampleVelocityTrackingModulationDevice.md) - - [renoise.ScriptingTool](API/renoise.ScriptingTool.md) - - [renoise.ScriptingTool.MidiMessage](API/renoise.ScriptingTool.MidiMessage.md) - - [renoise.Socket](API/renoise.Socket.md) - - [renoise.Socket.SocketBase](API/renoise.Socket.SocketBase.md) - - [renoise.Socket.SocketClient](API/renoise.Socket.SocketClient.md) - - [renoise.Socket.SocketServer](API/renoise.Socket.SocketServer.md) - - [renoise.Song](API/renoise.Song.md) - - [renoise.SongPos](API/renoise.SongPos.md) - - [renoise.Track](API/renoise.Track.md) - - [renoise.Transport](API/renoise.Transport.md) - - [renoise.ViewBuilder](API/renoise.ViewBuilder.md) - - [renoise.Views](API/renoise.Views.md) - - [renoise.Views.Aligner](API/renoise.Views.Aligner.md) - - [renoise.Views.Bitmap](API/renoise.Views.Bitmap.md) - - [renoise.Views.Button](API/renoise.Views.Button.md) - - [renoise.Views.CheckBox](API/renoise.Views.CheckBox.md) - - [renoise.Views.Chooser](API/renoise.Views.Chooser.md) - - [renoise.Views.Control](API/renoise.Views.Control.md) - - [renoise.Views.MiniSlider](API/renoise.Views.MiniSlider.md) - - [renoise.Views.MultiLineText](API/renoise.Views.MultiLineText.md) - - [renoise.Views.MultiLineTextField](API/renoise.Views.MultiLineTextField.md) - - [renoise.Views.Popup](API/renoise.Views.Popup.md) - - [renoise.Views.Rack](API/renoise.Views.Rack.md) - - [renoise.Views.RotaryEncoder](API/renoise.Views.RotaryEncoder.md) - - [renoise.Views.Slider](API/renoise.Views.Slider.md) - - [renoise.Views.Switch](API/renoise.Views.Switch.md) - - [renoise.Views.Text](API/renoise.Views.Text.md) - - [renoise.Views.TextField](API/renoise.Views.TextField.md) - - [renoise.Views.Value](API/renoise.Views.Value.md) - - [renoise.Views.ValueBox](API/renoise.Views.ValueBox.md) - - [renoise.Views.ValueField](API/renoise.Views.ValueField.md) - - [renoise.Views.View](API/renoise.Views.View.md) - - [renoise.Views.XYPad](API/renoise.Views.XYPad.md) - - [aliases](API/aliases.md) - - [AlignerConstructor](API/aliases/AlignerConstructor.md) - - [AlignerMode](API/aliases/AlignerMode.md) - - [BitmapImagePath](API/aliases/BitmapImagePath.md) - - [BitmapMode](API/aliases/BitmapMode.md) - - [BitmapPath](API/aliases/BitmapPath.md) - - [BooleanValueNotifierFunction](API/aliases/BooleanValueNotifierFunction.md) - - [BooleanValueNotifierMemberFunction](API/aliases/BooleanValueNotifierMemberFunction.md) - - [BooleanValueNotifierMethod1](API/aliases/BooleanValueNotifierMethod1.md) - - [BooleanValueNotifierMethod2](API/aliases/BooleanValueNotifierMethod2.md) - - [ButtonBitmapPath](API/aliases/ButtonBitmapPath.md) - - [ButtonColor](API/aliases/ButtonColor.md) - - [ButtonLabel](API/aliases/ButtonLabel.md) - - [ButtonNotifier](API/aliases/ButtonNotifier.md) - - [CheckBoxBoolean](API/aliases/CheckBoxBoolean.md) - - [CheckBoxBooleanNotifier](API/aliases/CheckBoxBooleanNotifier.md) - - [ControlActive](API/aliases/ControlActive.md) - - [ControlMidiMappingString](API/aliases/ControlMidiMappingString.md) - - [DialogTitle](API/aliases/DialogTitle.md) - - [DocumentMember](API/aliases/DocumentMember.md) - - [FileHookCategory](API/aliases/FileHookCategory.md) - - [FilterTypes](API/aliases/FilterTypes.md) - - [FilterTypes1](API/aliases/FilterTypes1.md) - - [FilterTypes2](API/aliases/FilterTypes2.md) - - [FilterTypes3](API/aliases/FilterTypes3.md) - - [IntegerNotifier](API/aliases/IntegerNotifier.md) - - [IntegerValueNotifierFunction](API/aliases/IntegerValueNotifierFunction.md) - - [IntegerValueNotifierMemberFunction](API/aliases/IntegerValueNotifierMemberFunction.md) - - [IntegerValueNotifierMethod1](API/aliases/IntegerValueNotifierMethod1.md) - - [IntegerValueNotifierMethod2](API/aliases/IntegerValueNotifierMethod2.md) - - [ItemLabels](API/aliases/ItemLabels.md) - - [KeyHandler](API/aliases/KeyHandler.md) - - [KeyHandlerMemberFunction](API/aliases/KeyHandlerMemberFunction.md) - - [KeyHandlerMethod1](API/aliases/KeyHandlerMethod1.md) - - [KeyHandlerMethod2](API/aliases/KeyHandlerMethod2.md) - - [ListElementAdded](API/aliases/ListElementAdded.md) - - [ListElementChange](API/aliases/ListElementChange.md) - - [ListElementRemoved](API/aliases/ListElementRemoved.md) - - [ListElementsSwapped](API/aliases/ListElementsSwapped.md) - - [ListNotifierFunction](API/aliases/ListNotifierFunction.md) - - [ListNotifierMemberContext](API/aliases/ListNotifierMemberContext.md) - - [ListNotifierMemberFunction](API/aliases/ListNotifierMemberFunction.md) - - [ListNotifierMethod1](API/aliases/ListNotifierMethod1.md) - - [ListNotifierMethod2](API/aliases/ListNotifierMethod2.md) - - [MidiMessage](API/aliases/MidiMessage.md) - - [MidiMessageFunction](API/aliases/MidiMessageFunction.md) - - [MidiMessageMemberContext](API/aliases/MidiMessageMemberContext.md) - - [MidiMessageMemberFunction](API/aliases/MidiMessageMemberFunction.md) - - [MidiMessageMethod1](API/aliases/MidiMessageMethod1.md) - - [MidiMessageMethod2](API/aliases/MidiMessageMethod2.md) - - [ModifierStates](API/aliases/ModifierStates.md) - - [NotifierFunction](API/aliases/NotifierFunction.md) - - [NotifierMemberContext](API/aliases/NotifierMemberContext.md) - - [NotifierMemberFunction](API/aliases/NotifierMemberFunction.md) - - [NotifierMethod1](API/aliases/NotifierMethod1.md) - - [NotifierMethod2](API/aliases/NotifierMethod2.md) - - [NumberValueNotifier](API/aliases/NumberValueNotifier.md) - - [NumberValueNotifierFunction](API/aliases/NumberValueNotifierFunction.md) - - [NumberValueNotifierMemberFunction](API/aliases/NumberValueNotifierMemberFunction.md) - - [NumberValueNotifierMethod1](API/aliases/NumberValueNotifierMethod1.md) - - [NumberValueNotifierMethod2](API/aliases/NumberValueNotifierMethod2.md) - - [ObservableProperties](API/aliases/ObservableProperties.md) - - [ObservableTypes](API/aliases/ObservableTypes.md) - - [OscTag](API/aliases/OscTag.md) - - [PairedParseStringAsNumber](API/aliases/PairedParseStringAsNumber.md) - - [PairedShowNumberAsString](API/aliases/PairedShowNumberAsString.md) - - [ParseStringAsNumber](API/aliases/ParseStringAsNumber.md) - - [PatternLineChangeCallback](API/aliases/PatternLineChangeCallback.md) - - [PatternLineChangeCallbackWithContext](API/aliases/PatternLineChangeCallbackWithContext.md) - - [PhraseLineChangeCallback](API/aliases/PhraseLineChangeCallback.md) - - [PhraseLineChangeCallbackWithContext](API/aliases/PhraseLineChangeCallbackWithContext.md) - - [PopupItemLabels](API/aliases/PopupItemLabels.md) - - [RGBColor](API/aliases/RGBColor.md) - - [RackConstructor](API/aliases/RackConstructor.md) - - [RackMargin](API/aliases/RackMargin.md) - - [RackSpacing](API/aliases/RackSpacing.md) - - [RackUniformity](API/aliases/RackUniformity.md) - - [SampleBuffer.ExportType](API/aliases/SampleBuffer.ExportType.md) - - [SelectedItem](API/aliases/SelectedItem.md) - - [ShowNumberAsString](API/aliases/ShowNumberAsString.md) - - [SliderDefaultValue](API/aliases/SliderDefaultValue.md) - - [SliderMaxValue](API/aliases/SliderMaxValue.md) - - [SliderMinValue](API/aliases/SliderMinValue.md) - - [SliderNumberValue](API/aliases/SliderNumberValue.md) - - [SliderStepAmounts](API/aliases/SliderStepAmounts.md) - - [SocketReceiveMode](API/aliases/SocketReceiveMode.md) - - [SpaceConstructor](API/aliases/SpaceConstructor.md) - - [StringChangeNotifier](API/aliases/StringChangeNotifier.md) - - [StringValueNotifierFunction](API/aliases/StringValueNotifierFunction.md) - - [StringValueNotifierMemberFunction](API/aliases/StringValueNotifierMemberFunction.md) - - [StringValueNotifierMethod1](API/aliases/StringValueNotifierMethod1.md) - - [StringValueNotifierMethod2](API/aliases/StringValueNotifierMethod2.md) - - [TextActive](API/aliases/TextActive.md) - - [TextAlignment](API/aliases/TextAlignment.md) - - [TextBackgroundStyle](API/aliases/TextBackgroundStyle.md) - - [TextEditMode](API/aliases/TextEditMode.md) - - [TextFontStyle](API/aliases/TextFontStyle.md) - - [TextMultilineString](API/aliases/TextMultilineString.md) - - [TextParagraphs](API/aliases/TextParagraphs.md) - - [TextSingleLineString](API/aliases/TextSingleLineString.md) - - [TextStyle](API/aliases/TextStyle.md) - - [TextValue](API/aliases/TextValue.md) - - [TextValueAlias](API/aliases/TextValueAlias.md) - - [TimerFunction](API/aliases/TimerFunction.md) - - [TimerMemberContext](API/aliases/TimerMemberContext.md) - - [TimerMemberFunction](API/aliases/TimerMemberFunction.md) - - [TimerMethod1](API/aliases/TimerMethod1.md) - - [TimerMethod2](API/aliases/TimerMethod2.md) - - [ValueBoxMaxValue](API/aliases/ValueBoxMaxValue.md) - - [ValueBoxMinValue](API/aliases/ValueBoxMinValue.md) - - [ViewBackgroundStyle](API/aliases/ViewBackgroundStyle.md) - - [ViewBooleanObservable](API/aliases/ViewBooleanObservable.md) - - [ViewDimension](API/aliases/ViewDimension.md) - - [ViewId](API/aliases/ViewId.md) - - [ViewNumberObservable](API/aliases/ViewNumberObservable.md) - - [ViewStringListObservable](API/aliases/ViewStringListObservable.md) - - [ViewStringObservable](API/aliases/ViewStringObservable.md) - - [ViewTooltip](API/aliases/ViewTooltip.md) - - [ViewVisibility](API/aliases/ViewVisibility.md) - - [XYPadMaxValues](API/aliases/XYPadMaxValues.md) - - [XYPadMinValues](API/aliases/XYPadMinValues.md) - - [XYPadObservables](API/aliases/XYPadObservables.md) - - [XYPadSnapbackValues](API/aliases/XYPadSnapbackValues.md) - - [XYPadValues](API/aliases/XYPadValues.md) - - [XYValueNotifier](API/aliases/XYValueNotifier.md) - - [XYValueNotifierFunction](API/aliases/XYValueNotifierFunction.md) - - [XYValueNotifierMemberFunction](API/aliases/XYValueNotifierMemberFunction.md) - - [XYValueNotifierMethod1](API/aliases/XYValueNotifierMethod1.md) - - [XYValueNotifierMethod2](API/aliases/XYValueNotifierMethod2.md) - - [renoise.PatternTrackLine](API/aliases/renoise.PatternTrackLine.md) - - [renoise.TrackDevice](API/aliases/renoise.TrackDevice.md) - - [builtins](API/builtins.md) + - [Application](API/renoise/renoise.Application.md) + - [ApplicationWindow](API/renoise/renoise.ApplicationWindow.md) + - [AudioDevice](API/renoise/renoise.AudioDevice.md) + - [DeviceParameter](API/renoise/renoise.DeviceParameter.md) + - [Dialog](API/renoise/renoise.Dialog.md) + - [Document](API/renoise/renoise.Document.md) + - [Document.DocumentList](API/renoise/renoise.Document.DocumentList.md) + - [Document.DocumentNode](API/renoise/renoise.Document.DocumentNode.md) + - [Document.Observable](API/renoise/renoise.Document.Observable.md) + - [Document.ObservableBang](API/renoise/renoise.Document.ObservableBang.md) + - [Document.ObservableBoolean](API/renoise/renoise.Document.ObservableBoolean.md) + - [Document.ObservableBooleanList](API/renoise/renoise.Document.ObservableBooleanList.md) + - [Document.ObservableList](API/renoise/renoise.Document.ObservableList.md) + - [Document.ObservableNumber](API/renoise/renoise.Document.ObservableNumber.md) + - [Document.ObservableNumberList](API/renoise/renoise.Document.ObservableNumberList.md) + - [Document.ObservableString](API/renoise/renoise.Document.ObservableString.md) + - [Document.ObservableStringList](API/renoise/renoise.Document.ObservableStringList.md) + - [Document.Serializable](API/renoise/renoise.Document.Serializable.md) + - [EffectColumn](API/renoise/renoise.EffectColumn.md) + - [GroupTrack](API/renoise/renoise.GroupTrack.md) + - [Instrument](API/renoise/renoise.Instrument.md) + - [InstrumentDevice](API/renoise/renoise.InstrumentDevice.md) + - [InstrumentMacro](API/renoise/renoise.InstrumentMacro.md) + - [InstrumentMacroMapping](API/renoise/renoise.InstrumentMacroMapping.md) + - [InstrumentMidiInputProperties](API/renoise/renoise.InstrumentMidiInputProperties.md) + - [InstrumentMidiOutputProperties](API/renoise/renoise.InstrumentMidiOutputProperties.md) + - [InstrumentPhrase](API/renoise/renoise.InstrumentPhrase.md) + - [InstrumentPhraseMapping](API/renoise/renoise.InstrumentPhraseMapping.md) + - [InstrumentPluginDevice](API/renoise/renoise.InstrumentPluginDevice.md) + - [InstrumentPluginProperties](API/renoise/renoise.InstrumentPluginProperties.md) + - [InstrumentTriggerOptions](API/renoise/renoise.InstrumentTriggerOptions.md) + - [Midi](API/renoise/renoise.Midi.md) + - [Midi.MidiDevice](API/renoise/renoise.Midi.MidiDevice.md) + - [Midi.MidiInputDevice](API/renoise/renoise.Midi.MidiInputDevice.md) + - [Midi.MidiOutputDevice](API/renoise/renoise.Midi.MidiOutputDevice.md) + - [NoteColumn](API/renoise/renoise.NoteColumn.md) + - [Osc](API/renoise/renoise.Osc.md) + - [Osc.Bundle](API/renoise/renoise.Osc.Bundle.md) + - [Osc.Message](API/renoise/renoise.Osc.Message.md) + - [Pattern](API/renoise/renoise.Pattern.md) + - [PatternIterator](API/renoise/renoise.PatternIterator.md) + - [PatternLine](API/renoise/renoise.PatternLine.md) + - [PatternSequencer](API/renoise/renoise.PatternSequencer.md) + - [PatternTrack](API/renoise/renoise.PatternTrack.md) + - [PatternTrackAutomation](API/renoise/renoise.PatternTrackAutomation.md) + - [Sample](API/renoise/renoise.Sample.md) + - [SampleAhdrsModulationDevice](API/renoise/renoise.SampleAhdrsModulationDevice.md) + - [SampleBuffer](API/renoise/renoise.SampleBuffer.md) + - [SampleDeviceChain](API/renoise/renoise.SampleDeviceChain.md) + - [SampleEnvelopeModulationDevice](API/renoise/renoise.SampleEnvelopeModulationDevice.md) + - [SampleFaderModulationDevice](API/renoise/renoise.SampleFaderModulationDevice.md) + - [SampleKeyTrackingModulationDevice](API/renoise/renoise.SampleKeyTrackingModulationDevice.md) + - [SampleLfoModulationDevice](API/renoise/renoise.SampleLfoModulationDevice.md) + - [SampleMapping](API/renoise/renoise.SampleMapping.md) + - [SampleModulationDevice](API/renoise/renoise.SampleModulationDevice.md) + - [SampleModulationSet](API/renoise/renoise.SampleModulationSet.md) + - [SampleOperandModulationDevice](API/renoise/renoise.SampleOperandModulationDevice.md) + - [SampleStepperModulationDevice](API/renoise/renoise.SampleStepperModulationDevice.md) + - [SampleVelocityTrackingModulationDevice](API/renoise/renoise.SampleVelocityTrackingModulationDevice.md) + - [ScriptingTool](API/renoise/renoise.ScriptingTool.md) + - [ScriptingTool.MidiMessage](API/renoise/renoise.ScriptingTool.MidiMessage.md) + - [Socket](API/renoise/renoise.Socket.md) + - [Socket.SocketBase](API/renoise/renoise.Socket.SocketBase.md) + - [Socket.SocketClient](API/renoise/renoise.Socket.SocketClient.md) + - [Socket.SocketServer](API/renoise/renoise.Socket.SocketServer.md) + - [Song](API/renoise/renoise.Song.md) + - [SongPos](API/renoise/renoise.SongPos.md) + - [Track](API/renoise/renoise.Track.md) + - [Transport](API/renoise/renoise.Transport.md) + - [ViewBuilder](API/renoise/renoise.ViewBuilder.md) + - [Views](API/renoise/renoise.Views.md) + - [Views.Aligner](API/renoise/renoise.Views.Aligner.md) + - [Views.Bitmap](API/renoise/renoise.Views.Bitmap.md) + - [Views.Button](API/renoise/renoise.Views.Button.md) + - [Views.CheckBox](API/renoise/renoise.Views.CheckBox.md) + - [Views.Chooser](API/renoise/renoise.Views.Chooser.md) + - [Views.Control](API/renoise/renoise.Views.Control.md) + - [Views.MiniSlider](API/renoise/renoise.Views.MiniSlider.md) + - [Views.MultiLineText](API/renoise/renoise.Views.MultiLineText.md) + - [Views.MultiLineTextField](API/renoise/renoise.Views.MultiLineTextField.md) + - [Views.Popup](API/renoise/renoise.Views.Popup.md) + - [Views.Rack](API/renoise/renoise.Views.Rack.md) + - [Views.RotaryEncoder](API/renoise/renoise.Views.RotaryEncoder.md) + - [Views.Slider](API/renoise/renoise.Views.Slider.md) + - [Views.Switch](API/renoise/renoise.Views.Switch.md) + - [Views.Text](API/renoise/renoise.Views.Text.md) + - [Views.TextField](API/renoise/renoise.Views.TextField.md) + - [Views.Value](API/renoise/renoise.Views.Value.md) + - [Views.ValueBox](API/renoise/renoise.Views.ValueBox.md) + - [Views.ValueField](API/renoise/renoise.Views.ValueField.md) + - [Views.View](API/renoise/renoise.Views.View.md) + - [Views.XYPad](API/renoise/renoise.Views.XYPad.md) + - [Builtin Types](API/builtins.md) - [any](API/builtins/any.md) - [boolean](API/builtins/boolean.md) - [function](API/builtins/function.md) @@ -249,14 +118,14 @@ - [table](API/builtins/table.md) - [unknown](API/builtins/unknown.md) - [userdata](API/builtins/userdata.md) - - [modules](API/modules.md) + - [Module Extensions](API/modules.md) - [bit](API/modules/bit.md) - [debug](API/modules/debug.md) - [global](API/modules/global.md) - [io](API/modules/io.md) - [math](API/modules/math.md) - [os](API/modules/os.md) - - [structs](API/structs.md) + - [API Helper Types](API/structs.md) - [AlignerViewProperties](API/structs/AlignerViewProperties.md) - [AudioDeviceInfo](API/structs/AudioDeviceInfo.md) - [BitmapViewProperties](API/structs/BitmapViewProperties.md)