From e77f76a815207ac912569ed473a9072448b726c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduard=20M=C3=BCller=20/=20taktik?= <11521600+emuell@users.noreply.github.com> Date: Fri, 2 Aug 2024 22:47:41 +0200 Subject: [PATCH] update starter pack (#1) * update starter pack - include definitions - add a web link to the api book in the starter pack root - use relative links in book, remove url_root argument from generate app - archive using XRNX_Starter_Pack as name --- .github/workflows/archive.yml | 12 +- .github/workflows/pages.yml | 9 +- .gitignore | 1 + README.md | 16 +- book.toml | 4 +- docs/API/builtins/table.md | 32 +- docs/API/modules/bit.md | 46 +- docs/API/modules/global.md | 24 +- docs/API/modules/io.md | 34 +- docs/API/modules/math.md | 16 +- docs/API/modules/os.md | 24 +- docs/API/renoise.md | 626 +++++++++--------- docs/API/renoise/renoise.Application.md | 158 ++--- docs/API/renoise/renoise.ApplicationWindow.md | 62 +- docs/API/renoise/renoise.AudioDevice.md | 42 +- docs/API/renoise/renoise.DeviceParameter.md | 36 +- docs/API/renoise/renoise.Dialog.md | 6 +- .../renoise/renoise.Document.DocumentList.md | 34 +- .../renoise/renoise.Document.DocumentNode.md | 40 +- .../renoise/renoise.Document.Observable.md | 10 +- .../renoise.Document.ObservableBang.md | 12 +- .../renoise.Document.ObservableBoolean.md | 20 +- .../renoise.Document.ObservableBooleanList.md | 42 +- .../renoise.Document.ObservableList.md | 18 +- .../renoise.Document.ObservableNumber.md | 20 +- .../renoise.Document.ObservableNumberList.md | 42 +- .../renoise.Document.ObservableString.md | 20 +- .../renoise.Document.ObservableStringList.md | 42 +- .../renoise/renoise.Document.Serializable.md | 8 +- docs/API/renoise/renoise.Document.md | 12 +- docs/API/renoise/renoise.EffectColumn.md | 16 +- docs/API/renoise/renoise.GroupTrack.md | 140 ++-- docs/API/renoise/renoise.Instrument.md | 156 ++--- docs/API/renoise/renoise.InstrumentDevice.md | 28 +- docs/API/renoise/renoise.InstrumentMacro.md | 20 +- .../renoise/renoise.InstrumentMacroMapping.md | 12 +- .../renoise.InstrumentMidiInputProperties.md | 16 +- .../renoise.InstrumentMidiOutputProperties.md | 30 +- docs/API/renoise/renoise.InstrumentPhrase.md | 140 ++-- .../renoise.InstrumentPhraseMapping.md | 24 +- .../renoise/renoise.InstrumentPluginDevice.md | 28 +- .../renoise.InstrumentPluginProperties.md | 52 +- .../renoise.InstrumentTriggerOptions.md | 20 +- docs/API/renoise/renoise.Midi.MidiDevice.md | 4 +- .../renoise/renoise.Midi.MidiInputDevice.md | 4 +- .../renoise/renoise.Midi.MidiOutputDevice.md | 6 +- docs/API/renoise/renoise.Midi.md | 16 +- docs/API/renoise/renoise.NoteColumn.md | 36 +- docs/API/renoise/renoise.Osc.Bundle.md | 6 +- docs/API/renoise/renoise.Osc.Message.md | 6 +- docs/API/renoise/renoise.Osc.md | 14 +- docs/API/renoise/renoise.Pattern.md | 46 +- docs/API/renoise/renoise.PatternIterator.md | 62 +- docs/API/renoise/renoise.PatternLine.md | 34 +- docs/API/renoise/renoise.PatternSequencer.md | 78 +-- docs/API/renoise/renoise.PatternTrack.md | 44 +- .../renoise/renoise.PatternTrackAutomation.md | 42 +- docs/API/renoise/renoise.Sample.md | 98 +-- .../renoise.SampleAhdrsModulationDevice.md | 54 +- docs/API/renoise/renoise.SampleBuffer.md | 66 +- docs/API/renoise/renoise.SampleDeviceChain.md | 40 +- .../renoise.SampleEnvelopeModulationDevice.md | 100 +-- .../renoise.SampleFaderModulationDevice.md | 54 +- ...noise.SampleKeyTrackingModulationDevice.md | 48 +- .../renoise.SampleLfoModulationDevice.md | 52 +- docs/API/renoise/renoise.SampleMapping.md | 26 +- .../renoise/renoise.SampleModulationDevice.md | 44 +- .../renoise/renoise.SampleModulationSet.md | 46 +- .../renoise.SampleOperandModulationDevice.md | 46 +- .../renoise.SampleStepperModulationDevice.md | 82 +-- ....SampleVelocityTrackingModulationDevice.md | 50 +- .../renoise.ScriptingTool.MidiMessage.md | 16 +- docs/API/renoise/renoise.ScriptingTool.md | 78 +-- docs/API/renoise/renoise.Socket.SocketBase.md | 8 +- .../renoise/renoise.Socket.SocketClient.md | 22 +- .../renoise/renoise.Socket.SocketServer.md | 28 +- docs/API/renoise/renoise.Socket.md | 8 +- docs/API/renoise/renoise.Song.md | 252 +++---- docs/API/renoise/renoise.SongPos.md | 4 +- docs/API/renoise/renoise.Track.md | 136 ++-- docs/API/renoise/renoise.Transport.md | 154 ++--- docs/API/renoise/renoise.ViewBuilder.md | 14 +- docs/API/renoise/renoise.Views.Aligner.md | 16 +- docs/API/renoise/renoise.Views.Bitmap.md | 22 +- docs/API/renoise/renoise.Views.Button.md | 30 +- docs/API/renoise/renoise.Views.CheckBox.md | 24 +- docs/API/renoise/renoise.Views.Chooser.md | 26 +- docs/API/renoise/renoise.Views.Control.md | 16 +- docs/API/renoise/renoise.Views.MiniSlider.md | 30 +- .../renoise/renoise.Views.MultiLineText.md | 24 +- .../renoise.Views.MultiLineTextField.md | 36 +- docs/API/renoise/renoise.Views.Popup.md | 26 +- docs/API/renoise/renoise.Views.Rack.md | 18 +- .../renoise/renoise.Views.RotaryEncoder.md | 30 +- docs/API/renoise/renoise.Views.Slider.md | 32 +- docs/API/renoise/renoise.Views.Switch.md | 26 +- docs/API/renoise/renoise.Views.Text.md | 14 +- docs/API/renoise/renoise.Views.TextField.md | 26 +- docs/API/renoise/renoise.Views.Value.md | 20 +- docs/API/renoise/renoise.Views.ValueBox.md | 30 +- docs/API/renoise/renoise.Views.ValueField.md | 28 +- docs/API/renoise/renoise.Views.View.md | 12 +- docs/API/renoise/renoise.Views.XYPad.md | 24 +- docs/guide/README.md | 2 +- docs/start/possibilities.md | 2 +- docs/start/tool.md | 2 +- generate/build.sh | 3 +- generate/src/main.rs | 4 +- generate/src/render.rs | 4 +- tools/README.md | 1 - 110 files changed, 2305 insertions(+), 2297 deletions(-) delete mode 100644 tools/README.md diff --git a/.github/workflows/archive.yml b/.github/workflows/archive.yml index 076e58e..2773086 100644 --- a/.github/workflows/archive.yml +++ b/.github/workflows/archive.yml @@ -16,7 +16,7 @@ jobs: - name: Build the book run: | - ./generate/build.sh "3.9.3" "" + ./generate/build.sh "3.9.3" cargo install mdbook cargo install mdbook-linkcheck mdbook build @@ -24,12 +24,14 @@ jobs: - name: Create XRNX_Starter_Pack run: | mkdir dist - cp -rf book dist/docs + cp -rf definitions dist/definitions + cp -rf book/html dist/docs cp -rf tools dist/tools - cd dist && zip -r -q ../XRNX_Starter_Pack.zip . + rm -rf dist/*/.git dist/*/.gitignore + echo -e '\n\n\n\n' > dist/docs.html - name: Archive uses: actions/upload-artifact@v4 with: - name: Archive - path: XRNX_Starter_Pack.zip + name: XRNX_Starter_Pack + path: dist diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 9268a71..b45b93a 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -1,6 +1,9 @@ name: Build and Deploy mdBook -on: [push] +on: + push: + branches: + - master jobs: build: @@ -16,7 +19,7 @@ jobs: - name: Build the book run: | - ./generate/build.sh "3.9.3" "/xrnx/" + ./generate/build.sh "3.9.3" cargo install mdbook cargo install mdbook-linkcheck mdbook build @@ -25,7 +28,7 @@ jobs: uses: actions/upload-pages-artifact@v3 with: name: github-pages - path: ./book + path: ./book/html deploy: # Add a dependency to the build job diff --git a/.gitignore b/.gitignore index 53631a4..195e70a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ Cargo.lock /book/ +/dist/ /generate/Cargo.lock /generate/target/ /generate/lua-language-server/ diff --git a/README.md b/README.md index c4d89e1..68fb13e 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,24 @@ Welcome to the Renoise Lua Scripting Repository! This site is for developers who want to write their own scripts & tools for [Renoise](http://www.renoise.com/). If you are only interested in downloading tools for Renoise and not in developing your own, please have a look at the [Renoise Tools Page](http://tools.renoise.com/). -### Getting Started +### Documentation & Guides -Read the [Renoise Scripting Development Book](https://renoise.github.io/xrnx) +Read the [Renoise Scripting Development Book](https://renoise.github.io/xrnx). This book is highly recommended for anyone who wants to get into all this Renoise scripting. Please read it first to get an overview of what's needed to develop tools for Renoise. It contains an introduction, some guides and the full API documentation. -### Example tools +### Example Tools -In addition to the documentation, this repository also contains some sample tools in the [tools folder](./tools) that are intended for new tool developers only. You can download them, install them, and read them as an interactive tutorial. +In addition to the documentation, this repository also contains some sample tools in the [tools folder](./tools) that are intended for new tool developers only. You can download them, install them, and read them as an interactive tutorial. The example tools are also included in the XRNX Starter pack (see below). -See https://github.com/renoise/tools for tools created by the Renoise team that actually do something. +See [github.com/renoise/tools](https://github.com/renoise/tools) for tools created by the Renoise team that actually do something. + +### Starter Pack + +The scripting development book, API definition and example tools, can also be downloaded as a "starter pack" bundle file from the [releases page](https://github.com/renoise/xrnx/releases). ### Need more help? For any questions regarding the Lua API or this repository, please have a look at the [Renoise Scripting Development Forum](https://forum.renoise.com/c/renoise-tool-development). -*Have fun scripting and hacking Renoise! \ No newline at end of file +*Have fun scripting and hacking Renoise!* \ No newline at end of file diff --git a/book.toml b/book.toml index 94b3ae9..a964172 100644 --- a/book.toml +++ b/book.toml @@ -12,5 +12,5 @@ create-missing = false default-theme = "dark" preferred-dark-theme = "coal" -#[output.linkcheck] -#warning-policy = "ignore" \ No newline at end of file +[output.linkcheck] +warning-policy = "ignore" \ No newline at end of file diff --git a/docs/API/builtins/table.md b/docs/API/builtins/table.md index e853b46..a976c32 100644 --- a/docs/API/builtins/table.md +++ b/docs/API/builtins/table.md @@ -3,22 +3,22 @@ A built-in type representing associative arrays, [see details](https://www.lua.o --- ## Functions -### `clear`(t : [`table`](/API/builtins/table.md)) {#clear} +### `clear`(t : [`table`](../../API/builtins/table.md)) {#clear} Recursively clears and removes all table elements. -### `copy`(t : [`table`](/API/builtins/table.md)) {#copy} -`->`[`table`](/API/builtins/table.md) +### `copy`(t : [`table`](../../API/builtins/table.md)) {#copy} +`->`[`table`](../../API/builtins/table.md) Copy the metatable and all first level elements of the given table into a new table. Use table.rcopy to do a recursive copy of all elements -### `count`(t : [`table`](/API/builtins/table.md)) {#count} +### `count`(t : [`table`](../../API/builtins/table.md)) {#count} Count the number of items of a table, also works for non index based tables (using pairs). ### examples: ```lua t = {["a"]=1, ["b"]=1}; print(table.count(t)) --> 2 ``` -### `create`(t : [`table`](/API/builtins/table.md)[`?`](/API/builtins/nil.md)) {#create} -`->`[`table`](/API/builtins/table.md) | tablelib +### `create`(t : [`table`](../../API/builtins/table.md)[`?`](../../API/builtins/nil.md)) {#create} +`->`[`table`](../../API/builtins/table.md) | tablelib Create a new, or convert an exiting table to an object that uses the global 'table.XXX' functions as methods, just like strings in Lua do. @@ -27,8 +27,8 @@ Create a new, or convert an exiting table to an object that uses the global t = table.create(); t:insert("a"); rprint(t) -> [1] = a; t = table.create{1,2,3}; print(t:concat("|")); -> "1|2|3"; ``` -### `find`(t : [`table`](/API/builtins/table.md), value : [`any`](/API/builtins/any.md), start_index : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md)) {#find} -`->`key_or_nil : [`string`](/API/builtins/string.md) | [`number`](/API/builtins/number.md)[`?`](/API/builtins/nil.md) +### `find`(t : [`table`](../../API/builtins/table.md), value : [`any`](../../API/builtins/any.md), start_index : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md)) {#find} +`->`key_or_nil : [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) Find first match of *value* in the given table, starting from element number *start_index*.
@@ -40,8 +40,8 @@ t = {a=1, b=2}; table.find(t, 2) --> "b" t = {"a", "b", "a"}; table.find(t, "a", 2) --> "3" t = {"a", "b"}; table.find(t, "c") --> nil ``` -### `is_empty`(t : [`table`](/API/builtins/table.md)) {#is_empty} -`->`[`boolean`](/API/builtins/boolean.md) +### `is_empty`(t : [`table`](../../API/builtins/table.md)) {#is_empty} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true when the table is empty, else false and will also work for non indexed tables @@ -50,8 +50,8 @@ for non indexed tables t = {}; print(table.is_empty(t)); -> true; t = {66}; print(table.is_empty(t)); -> false; t = {["a"] = 1}; print(table.is_empty(t)); -> false; -### `keys`(t : [`table`](/API/builtins/table.md)) {#keys} -`->`[`table`](/API/builtins/table.md) +### `keys`(t : [`table`](../../API/builtins/table.md)) {#keys} +`->`[`table`](../../API/builtins/table.md) Return an indexed table of all keys that are used in the table. ### examples: @@ -59,13 +59,13 @@ Return an indexed table of all keys that are used in the table. t = {a="aa", b="bb"}; rprint(table.keys(t)); --> "a", "b" t = {"a", "b"}; rprint(table.keys(t)); --> 1, 2 ``` -### `rcopy`(t : [`table`](/API/builtins/table.md)) {#rcopy} -`->`[`table`](/API/builtins/table.md) +### `rcopy`(t : [`table`](../../API/builtins/table.md)) {#rcopy} +`->`[`table`](../../API/builtins/table.md) Deeply copy the metatable and all elements of the given table recursively into a new table - create a clone with unique references. -### `values`(t : [`table`](/API/builtins/table.md)) {#values} -`->`[`table`](/API/builtins/table.md) +### `values`(t : [`table`](../../API/builtins/table.md)) {#values} +`->`[`table`](../../API/builtins/table.md) Return an indexed table of all values that are used in the table ### examples: diff --git a/docs/API/modules/bit.md b/docs/API/modules/bit.md index 2736e2e..3dcdc1f 100644 --- a/docs/API/modules/bit.md +++ b/docs/API/modules/bit.md @@ -5,8 +5,8 @@ Integer, Bit Operations, provided by --- ## Functions -### `arshift`(x : [`integer`](/API/builtins/integer.md), n : [`integer`](/API/builtins/integer.md)) {#arshift} -`->`[`integer`](/API/builtins/integer.md) +### `arshift`(x : [`integer`](../../API/builtins/integer.md), n : [`integer`](../../API/builtins/integer.md)) {#arshift} +`->`[`integer`](../../API/builtins/integer.md) Returns the bitwise arithmetic right-shift of its first argument by the number of bits given by the second argument. @@ -15,27 +15,27 @@ Logical shifts treat the first argument as an unsigned number and shift in 0-bits. Arithmetic right-shift treats the most-significant bit as a sign bit and replicates it. Only the lower 5 bits of the shift count are used (reduces to the range [0..31]). -### `band`(x1 : [`integer`](/API/builtins/integer.md), ...[`integer`](/API/builtins/integer.md)) {#band} -`->`[`integer`](/API/builtins/integer.md) +### `band`(x1 : [`integer`](../../API/builtins/integer.md), ...[`integer`](../../API/builtins/integer.md)) {#band} +`->`[`integer`](../../API/builtins/integer.md) Returns the bitwise and of all of its arguments. Note that more than two arguments are allowed. -### `bnot`(x : [`integer`](/API/builtins/integer.md)) {#bnot} -`->`[`integer`](/API/builtins/integer.md) +### `bnot`(x : [`integer`](../../API/builtins/integer.md)) {#bnot} +`->`[`integer`](../../API/builtins/integer.md) Returns the bitwise **not** of its argument. -### `bor`(x1 : [`integer`](/API/builtins/integer.md), ...[`integer`](/API/builtins/integer.md)) {#bor} -`->`[`integer`](/API/builtins/integer.md) +### `bor`(x1 : [`integer`](../../API/builtins/integer.md), ...[`integer`](../../API/builtins/integer.md)) {#bor} +`->`[`integer`](../../API/builtins/integer.md) Returns the bitwise or of all of its arguments. Note that more than two arguments are allowed. -### `bswap`(x : [`integer`](/API/builtins/integer.md)) {#bswap} -`->`[`integer`](/API/builtins/integer.md) +### `bswap`(x : [`integer`](../../API/builtins/integer.md)) {#bswap} +`->`[`integer`](../../API/builtins/integer.md) Swaps the bytes of its argument and returns it. This can be used to convert little-endian 32 bit numbers to big-endian 32 bit numbers or vice versa. -### `lshift`(x : [`integer`](/API/builtins/integer.md), n : [`integer`](/API/builtins/integer.md)) {#lshift} -`->`[`integer`](/API/builtins/integer.md) +### `lshift`(x : [`integer`](../../API/builtins/integer.md), n : [`integer`](../../API/builtins/integer.md)) {#lshift} +`->`[`integer`](../../API/builtins/integer.md) Returns the bitwise logical left-shift of its first argument by the number of bits given by the second argument. @@ -44,8 +44,8 @@ Logical shifts treat the first argument as an unsigned number and shift in 0-bits. Arithmetic right-shift treats the most-significant bit as a sign bit and replicates it. Only the lower 5 bits of the shift count are used (reduces to the range [0..31]). -### `rol`(x : [`integer`](/API/builtins/integer.md), n : [`integer`](/API/builtins/integer.md)) {#rol} -`->`[`integer`](/API/builtins/integer.md) +### `rol`(x : [`integer`](../../API/builtins/integer.md), n : [`integer`](../../API/builtins/integer.md)) {#rol} +`->`[`integer`](../../API/builtins/integer.md) Returns bitwise left rotation of its first argument by the number of bits given by the second argument. Bits shifted out on one side are shifted back @@ -53,8 +53,8 @@ in on the other side. Only the lower 5 bits of the rotate count are used (reduces to the range [0..31]). -### `ror`(x : [`integer`](/API/builtins/integer.md), n : [`integer`](/API/builtins/integer.md)) {#ror} -`->`[`integer`](/API/builtins/integer.md) +### `ror`(x : [`integer`](../../API/builtins/integer.md), n : [`integer`](../../API/builtins/integer.md)) {#ror} +`->`[`integer`](../../API/builtins/integer.md) Returns bitwise right rotation of its first argument by the number of bits given by the second argument. Bits shifted out on one side are shifted back @@ -62,8 +62,8 @@ in on the other side. Only the lower 5 bits of the rotate count are used (reduces to the range [0..31]). -### `rshift`(x : [`integer`](/API/builtins/integer.md), n : [`integer`](/API/builtins/integer.md)) {#rshift} -`->`[`integer`](/API/builtins/integer.md) +### `rshift`(x : [`integer`](../../API/builtins/integer.md), n : [`integer`](../../API/builtins/integer.md)) {#rshift} +`->`[`integer`](../../API/builtins/integer.md) Returns the bitwise logical right-shift of its first argument by the number of bits given by the second argument. @@ -72,20 +72,20 @@ Logical shifts treat the first argument as an unsigned number and shift in 0-bits. Arithmetic right-shift treats the most-significant bit as a sign bit and replicates it. Only the lower 5 bits of the shift count are used (reduces to the range [0..31]). -### `tobit`(x : [`integer`](/API/builtins/integer.md)) {#tobit} -`->`[`integer`](/API/builtins/integer.md) +### `tobit`(x : [`integer`](../../API/builtins/integer.md)) {#tobit} +`->`[`integer`](../../API/builtins/integer.md) Normalizes a number to the numeric range for bit operations and returns it. This function is usually not needed since all bit operations already normalize all of their input arguments. Check the operational semantics for details. -### `tohex`(x : [`integer`](/API/builtins/integer.md), n : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md)) {#tohex} +### `tohex`(x : [`integer`](../../API/builtins/integer.md), n : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md)) {#tohex} Converts its first argument to a hex string. The number of hex digits is given by the absolute value of the optional second argument. Positive numbers between 1 and 8 generate lowercase hex digits. Negative numbers generate uppercase hex digits. Only the least-significant 4*|n| bits are used. The default is to generate 8 lowercase hex digits. -### `xor`(x1 : [`integer`](/API/builtins/integer.md), ...[`integer`](/API/builtins/integer.md)) {#xor} -`->`[`integer`](/API/builtins/integer.md) +### `xor`(x1 : [`integer`](../../API/builtins/integer.md), ...[`integer`](../../API/builtins/integer.md)) {#xor} +`->`[`integer`](../../API/builtins/integer.md) Returns the bitwise xor of all of its arguments. Note that more than two arguments are allowed. diff --git a/docs/API/modules/global.md b/docs/API/modules/global.md index c1b059e..4d498ca 100644 --- a/docs/API/modules/global.md +++ b/docs/API/modules/global.md @@ -2,8 +2,8 @@ --- ## Functions -### `class`(name : [`string`](/API/builtins/string.md)) {#class} -`->`[`function`](/API/builtins/function.md) +### `class`(name : [`string`](../../API/builtins/string.md)) {#class} +`->`[`function`](../../API/builtins/function.md) Luabind "class" registration. Registers a global class object and returns a closure to optionally set the base class. @@ -43,19 +43,19 @@ class 'Mammal' (Animal) local mamal = Mammal("Cow") mamal:show() ``` -### `objinfo`(object : [`userdata`](/API/builtins/userdata.md)) {#objinfo} -`->`[`string`](/API/builtins/string.md)`[]` +### `objinfo`(object : [`userdata`](../../API/builtins/userdata.md)) {#objinfo} +`->`[`string`](../../API/builtins/string.md)`[]` Return a string which lists properties and methods of class objects. -### `oprint`(object : [`userdata`](/API/builtins/userdata.md)) {#oprint} +### `oprint`(object : [`userdata`](../../API/builtins/userdata.md)) {#oprint} Dumps properties and methods of class objects (like renoise.app()). -### `rawequal`(obj1 : [`any`](/API/builtins/any.md), obj2 : [`any`](/API/builtins/any.md)) {#rawequal} +### `rawequal`(obj1 : [`any`](../../API/builtins/any.md), obj2 : [`any`](../../API/builtins/any.md)) {#rawequal} Checks whether v1 is equal to v2, without invoking the `__eq` metamethod. [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-rawequal) ### `ripairs`(table : ) {#ripairs} -`->`fun(table: [], i?: integer):integer, , , i : [`integer`](/API/builtins/integer.md) +`->`fun(table: [], i?: integer):integer, , , i : [`integer`](../../API/builtins/integer.md) An iterator like ipairs, but in reverse order. ### examples: @@ -63,11 +63,11 @@ An iterator like ipairs, but in reverse order. t = {"a", "b", "c"} 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} +### `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/renoise.PatternLine.md)) {#tostring} -`->`[`string`](/API/builtins/string.md) +### `tostring`(pattern_line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md)) {#tostring} +`->`[`string`](../../API/builtins/string.md) Receives a value of any type and converts it to a string in a human-readable format. @@ -78,8 +78,8 @@ For complete control of how numbers are converted, use [string.format](http://ww [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-tostring) -### `type`(value : [`any`](/API/builtins/any.md)) {#type} -`->`[`string`](/API/builtins/string.md) +### `type`(value : [`any`](../../API/builtins/any.md)) {#type} +`->`[`string`](../../API/builtins/string.md) Returns the type of its only argument, coded as a string. The possible results of this function are `"nil"` (a string, not the value `nil`), `"number"`, `"string"`, `"boolean"`, `"table"`, `"function"`, `"thread"`, and `"userdata"`. diff --git a/docs/API/modules/io.md b/docs/API/modules/io.md index c46e741..1cba6ee 100644 --- a/docs/API/modules/io.md +++ b/docs/API/modules/io.md @@ -2,18 +2,18 @@ --- ## Functions -### `chmod`(filename : [`string`](/API/builtins/string.md), mode : [`integer`](/API/builtins/integer.md)) {#chmod} -`->`result : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md), error_code : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) +### `chmod`(filename : [`string`](../../API/builtins/string.md), mode : [`integer`](../../API/builtins/integer.md)) {#chmod} +`->`result : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), error_code : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) Change permissions of a file, folder or link. mode is a unix permission styled octal number (like 755 - WITHOUT a leading octal 0). Executable, group and others flags are ignored on windows and won't fire errors -### `exists`(filename : [`string`](/API/builtins/string.md)) {#exists} -`->`[`boolean`](/API/builtins/boolean.md) +### `exists`(filename : [`string`](../../API/builtins/string.md)) {#exists} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true when a file, folder or link at the given path and name exists -### `stat`(filename : [`string`](/API/builtins/string.md)) {#stat} -`->`result : [`Stat`](#stat)[`?`](/API/builtins/nil.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md), error_code : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) +### `stat`(filename : [`string`](../../API/builtins/string.md)) {#stat} +`->`result : [`Stat`](#stat)[`?`](../../API/builtins/nil.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), error_code : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) Returns a table with status info about the file, folder or link at the given path and name, else nil the error and the error code is returned. @@ -27,38 +27,38 @@ return value for io.stat --- ## Properties -### atime : [`integer`](/API/builtins/integer.md) {#atime} +### atime : [`integer`](../../API/builtins/integer.md) {#atime} last access time in seconds since the epoch -### ctime : [`integer`](/API/builtins/integer.md) {#ctime} +### ctime : [`integer`](../../API/builtins/integer.md) {#ctime} inode change time (NOT creation time!) in seconds -### dev : [`integer`](/API/builtins/integer.md) {#dev} +### dev : [`integer`](../../API/builtins/integer.md) {#dev} device number of filesystem -### gid : [`integer`](/API/builtins/integer.md) {#gid} +### gid : [`integer`](../../API/builtins/integer.md) {#gid} numeric group ID of file's owner -### ino : [`integer`](/API/builtins/integer.md) {#ino} +### ino : [`integer`](../../API/builtins/integer.md) {#ino} inode number -### mode : [`integer`](/API/builtins/integer.md) {#mode} +### mode : [`integer`](../../API/builtins/integer.md) {#mode} unix styled file permissions -### mtime : [`integer`](/API/builtins/integer.md) {#mtime} +### mtime : [`integer`](../../API/builtins/integer.md) {#mtime} last modify time in seconds since the epoch -### nlink : [`integer`](/API/builtins/integer.md) {#nlink} +### nlink : [`integer`](../../API/builtins/integer.md) {#nlink} number of (hard) links to the file -### rdev : [`integer`](/API/builtins/integer.md) {#rdev} +### rdev : [`integer`](../../API/builtins/integer.md) {#rdev} the device identifier (special files only) -### size : [`integer`](/API/builtins/integer.md) {#size} +### size : [`integer`](../../API/builtins/integer.md) {#size} total size of file, in bytes ### type : `"file"` | `"directory"` | `"link"` | `"socket"` | `"named pipe"` | `"char device"` | `"block device"` {#type} -### uid : [`integer`](/API/builtins/integer.md) {#uid} +### uid : [`integer`](../../API/builtins/integer.md) {#uid} numeric user ID of file's owner diff --git a/docs/API/modules/math.md b/docs/API/modules/math.md index eca8cf0..bf3941c 100644 --- a/docs/API/modules/math.md +++ b/docs/API/modules/math.md @@ -2,8 +2,8 @@ --- ## Functions -### `db2fader`(min_dB : [`number`](/API/builtins/number.md), max_dB : [`number`](/API/builtins/number.md), dB_to_convert : [`number`](/API/builtins/number.md)) {#db2fader} -`->`[`number`](/API/builtins/number.md) +### `db2fader`(min_dB : [`number`](../../API/builtins/number.md), max_dB : [`number`](../../API/builtins/number.md), dB_to_convert : [`number`](../../API/builtins/number.md)) {#db2fader} +`->`[`number`](../../API/builtins/number.md) Converts a dB value to a normalized linear fader value between 0-1 within the given dB range. @@ -12,8 +12,8 @@ the given dB range. print(math.db2fader(-96, 0, 1)) --> 0 print(math.db2fader(-48, 6, 0)) --> 0.73879611492157 ``` -### `db2lin`(n : [`number`](/API/builtins/number.md)) {#db2lin} -`->`[`number`](/API/builtins/number.md) +### `db2lin`(n : [`number`](../../API/builtins/number.md)) {#db2lin} +`->`[`number`](../../API/builtins/number.md) Converts a dB value to a linear value. ### example: @@ -21,8 +21,8 @@ Converts a dB value to a linear value. print(math.db2lin(math.infdb)) --> 0 print(math.db2lin(6.0)) --> 1.9952623149689 ``` -### `fader2db`(min_dB : [`number`](/API/builtins/number.md), max_dB : [`number`](/API/builtins/number.md), fader_value : [`number`](/API/builtins/number.md)) {#fader2db} -`->`[`number`](/API/builtins/number.md) +### `fader2db`(min_dB : [`number`](../../API/builtins/number.md), max_dB : [`number`](../../API/builtins/number.md), fader_value : [`number`](../../API/builtins/number.md)) {#fader2db} +`->`[`number`](../../API/builtins/number.md) Converts a normalized linear mixer fader value to a db value within the given dB range. @@ -31,8 +31,8 @@ the given dB range. print(math.fader2db(-96, 0, 1)) --> 0 print(math.fader2db(-96, 0, 0)) --> -96 ``` -### `lin2db`(n : [`number`](/API/builtins/number.md)) {#lin2db} -`->`[`number`](/API/builtins/number.md) +### `lin2db`(n : [`number`](../../API/builtins/number.md)) {#lin2db} +`->`[`number`](../../API/builtins/number.md) Converts a linear value to a db value. db values will be clipped to math.infdb. diff --git a/docs/API/modules/os.md b/docs/API/modules/os.md index b7d18d1..3374812 100644 --- a/docs/API/modules/os.md +++ b/docs/API/modules/os.md @@ -3,19 +3,19 @@ --- ## Functions ### `clock()` {#clock} -`->`[`number`](/API/builtins/number.md) +`->`[`number`](../../API/builtins/number.md) Returns an approximation of the amount in seconds of CPU time used by the program. [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-os.clock) ### `currentdir()` {#currentdir} -`->`path : [`string`](/API/builtins/string.md) +`->`path : [`string`](../../API/builtins/string.md) Returns the current working dir. Will always be the scripts directory when executing a script from a file -### `dirnames`(path : [`any`](/API/builtins/any.md)) {#dirnames} -`->`paths : [`string`](/API/builtins/string.md)`[]` +### `dirnames`(path : [`any`](../../API/builtins/any.md)) {#dirnames} +`->`paths : [`string`](../../API/builtins/string.md)`[]` Returns a list of directory names (names, not full paths) for the given parent directory. Passed directory must be valid, or an error will be thrown. @@ -24,22 +24,22 @@ parent directory. Passed directory must be valid, or an error will be thrown. Calls the ISO C function `exit` to terminate the host program. [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-os.exit) -### `filenames`(path : [`string`](/API/builtins/string.md), file_extensions : [`string`](/API/builtins/string.md)`[]`[`?`](/API/builtins/nil.md)) {#filenames} -`->`paths : [`string`](/API/builtins/string.md)`[]` +### `filenames`(path : [`string`](../../API/builtins/string.md), file_extensions : [`string`](../../API/builtins/string.md)`[]`[`?`](../../API/builtins/nil.md)) {#filenames} +`->`paths : [`string`](../../API/builtins/string.md)`[]` Returns a list file names (names, not full paths) for the given parent directory. Second optional argument is a list of file extensions that should be searched for, like {"*.wav", "*.txt"}. By default all files are matched. The passed directory must be valid, or an error will be thrown. -### `mkdir`(path : [`string`](/API/builtins/string.md)) {#mkdir} -`->`[`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `mkdir`(path : [`string`](../../API/builtins/string.md)) {#mkdir} +`->`[`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) Creates a new directory. mkdir can only create one new sub directory at the same time. If you need to create more than one sub dir, call mkdir multiple times. Returns true if the operation was successful; in case of error, it returns nil plus an error string. -### `move`(src : [`string`](/API/builtins/string.md), dest : [`string`](/API/builtins/string.md)) {#move} -`->`[`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `move`(src : [`string`](../../API/builtins/string.md), dest : [`string`](../../API/builtins/string.md)) {#move} +`->`[`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) Moves a file or a directory from path 'src' to 'dest'. Unlike 'os.rename' this also supports moving a file from one file system to another one. Returns @@ -56,8 +56,8 @@ return #1: | "MACINTOSH" | "LINUX" ``` -### `tmpname`(extension : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md)) {#tmpname} -`->`[`string`](/API/builtins/string.md) +### `tmpname`(extension : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md)) {#tmpname} +`->`[`string`](../../API/builtins/string.md) Returns a string with a file name that can be used for a temporary file. diff --git a/docs/API/renoise.md b/docs/API/renoise.md index 2db950d..a1ec91e 100644 --- a/docs/API/renoise.md +++ b/docs/API/renoise.md @@ -3,14 +3,14 @@ Holds all renoise related API functions and classes. --- ## Properties -### API_VERSION : [`number`](/API/builtins/number.md) {#API_VERSION} +### API_VERSION : [`number`](../API/builtins/number.md) {#API_VERSION} Currently 6.1. Any changes in the API which are not backwards compatible, will increase the internal API's major version number (e.g. from 1.4 -> 2.0). All other backwards compatible changes, like new functionality, new functions and classes which do not break existing scripts, will increase only the minor version number (e.g. 1.0 -> 1.1). -### RENOISE_VERSION : [`string`](/API/builtins/string.md) {#RENOISE_VERSION} +### RENOISE_VERSION : [`string`](../API/builtins/string.md) {#RENOISE_VERSION} Renoise Version "Major.Minor.Revision[AlphaBetaRcVersion][Demo]" @@ -22,11 +22,11 @@ Renoise Version "Major.Minor.Revision[AlphaBetaRcVersion][Demo]" Construct a new viewbuilder instance you can use to create views. ### `app()` {#app} -`->`[`renoise.Application`](/API/renoise/renoise.Application.md) +`->`[`renoise.Application`](../API/renoise/renoise.Application.md) Global access to the Renoise Application. ### `song()` {#song} -`->`[`renoise.Song`](/API/renoise/renoise.Song.md)[`?`](/API/builtins/nil.md) +`->`[`renoise.Song`](../API/renoise/renoise.Song.md)[`?`](../API/builtins/nil.md) Global access to the Renoise Song. @@ -35,7 +35,7 @@ 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/renoise.ScriptingTool.md) +`->`[`renoise.ScriptingTool`](../API/renoise/renoise.ScriptingTool.md) Global access to the Renoise Scripting Tool (your XRNX tool). @@ -50,40 +50,40 @@ scripting terminal and editor in Renoise. --- ## Properties -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### margin : [`RackMargin`](#RackMargin)[`?`](/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) -### mode : [`AlignerMode`](#AlignerMode)[`?`](/API/builtins/nil.md) {#mode} +### mode : [`AlignerMode`](#AlignerMode)[`?`](../API/builtins/nil.md) {#mode} * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) -### spacing : [`RackSpacing`](#RackSpacing)[`?`](/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) -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -96,27 +96,27 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bitmap : [`BitmapPath`](#BitmapPath)[`?`](/API/builtins/nil.md) {#bitmap} +### bitmap : [`BitmapPath`](#BitmapPath)[`?`](../API/builtins/nil.md) {#bitmap} Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -124,23 +124,23 @@ 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. -### mode : [`BitmapMode`](#BitmapMode)[`?`](/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`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](../API/builtins/nil.md) {#notifier} A click notifier -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -153,13 +153,13 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bitmap : [`ButtonBitmapPath`](#ButtonBitmapPath)[`?`](/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 @@ -168,24 +168,24 @@ 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)[`?`](/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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -193,30 +193,30 @@ 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. -### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](../API/builtins/nil.md) {#notifier} A click notifier -### pressed : [`ButtonNotifier`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#pressed} +### pressed : [`ButtonNotifier`](#ButtonNotifier)[`?`](../API/builtins/nil.md) {#pressed} A click notifier -### released : [`ButtonNotifier`](#ButtonNotifier)[`?`](/API/builtins/nil.md) {#released} +### released : [`ButtonNotifier`](#ButtonNotifier)[`?`](../API/builtins/nil.md) {#released} A click notifier -### text : [`ButtonLabel`](#ButtonLabel)[`?`](/API/builtins/nil.md) {#text} +### text : [`ButtonLabel`](#ButtonLabel)[`?`](../API/builtins/nil.md) {#text} The text label of the button * Default: "" -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -229,34 +229,34 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### items : [`ItemLabels`](#ItemLabels)[`?`](/API/builtins/nil.md) {#items} +### items : [`ItemLabels`](#ItemLabels)[`?`](../API/builtins/nil.md) {#items} A list of buttons labels to show in order. Must have more than one item. -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -264,23 +264,23 @@ 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. -### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](/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 -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`SelectedItem`](#SelectedItem)[`?`](/API/builtins/nil.md) {#value} +### value : [`SelectedItem`](#SelectedItem)[`?`](../API/builtins/nil.md) {#value} The currently selected item's index -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -293,31 +293,31 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewBooleanObservable`](#ViewBooleanObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewBooleanObservable`](#ViewBooleanObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -325,24 +325,24 @@ 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. -### notifier : [`CheckBoxBooleanNotifier`](#CheckBoxBooleanNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`CheckBoxBooleanNotifier`](#CheckBoxBooleanNotifier)[`?`](../API/builtins/nil.md) {#notifier} A notifier for when the checkbox is toggled -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`CheckBoxBoolean`](#CheckBoxBoolean)[`?`](/API/builtins/nil.md) {#value} +### value : [`CheckBoxBoolean`](#CheckBoxBoolean)[`?`](../API/builtins/nil.md) {#value} The current state of the checkbox, expressed as boolean. * Default: false -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -355,34 +355,34 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### items : [`ItemLabels`](#ItemLabels)[`?`](/API/builtins/nil.md) {#items} +### items : [`ItemLabels`](#ItemLabels)[`?`](../API/builtins/nil.md) {#items} A list of buttons labels to show in order. Must have more than one item. -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -390,23 +390,23 @@ 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. -### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](/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 -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`SelectedItem`](#SelectedItem)[`?`](/API/builtins/nil.md) {#value} +### value : [`SelectedItem`](#SelectedItem)[`?`](../API/builtins/nil.md) {#value} The currently selected item's index -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -419,38 +419,38 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](/API/builtins/nil.md) {#default} +### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](../API/builtins/nil.md) {#default} The default value that will be re-applied on double-click -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/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 -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -458,27 +458,27 @@ 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. -### min : [`SliderMinValue`](#SliderMinValue)[`?`](/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`](#NumberValueNotifier)[`?`](/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 -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../API/builtins/nil.md) {#value} The current value of the view -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -491,67 +491,67 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`TextActive`](#TextActive)[`?`](/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 -### bind : [`ViewStringListObservable`](#ViewStringListObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewStringListObservable`](#ViewStringListObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### edit_mode : [`TextEditMode`](#TextEditMode)[`?`](/API/builtins/nil.md) {#edit_mode} +### 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 -### font : [`TextFontStyle`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](../API/builtins/nil.md) {#font} The style that the text should be displayed with. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](../API/builtins/nil.md) {#notifier} Set up a notifier for text changes -### paragraphs : [`TextParagraphs`](#TextParagraphs)[`?`](/API/builtins/nil.md) {#paragraphs} +### 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`](#TextBackgroundStyle)[`?`](/API/builtins/nil.md) {#style} +### style : [`TextBackgroundStyle`](#TextBackgroundStyle)[`?`](../API/builtins/nil.md) {#style} Setup the text view's background: -### text : [`TextValueAlias`](#TextValueAlias)[`?`](/API/builtins/nil.md) {#text} +### text : [`TextValueAlias`](#TextValueAlias)[`?`](../API/builtins/nil.md) {#text} Exactly the same as "value"; provided for consistency. * Default: "" -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`TextMultilineString`](#TextMultilineString)[`?`](/API/builtins/nil.md) {#value} +### value : [`TextMultilineString`](#TextMultilineString)[`?`](../API/builtins/nil.md) {#value} The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs. -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -564,44 +564,44 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### font : [`TextFontStyle`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](../API/builtins/nil.md) {#font} The style that the text should be displayed with. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### paragraphs : [`TextParagraphs`](#TextParagraphs)[`?`](/API/builtins/nil.md) {#paragraphs} +### 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`](#TextBackgroundStyle)[`?`](/API/builtins/nil.md) {#style} +### style : [`TextBackgroundStyle`](#TextBackgroundStyle)[`?`](../API/builtins/nil.md) {#style} Setup the text view's background: -### text : [`TextMultilineString`](#TextMultilineString)[`?`](/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. -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -614,35 +614,35 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### items : [`PopupItemLabels`](#PopupItemLabels)[`?`](/API/builtins/nil.md) {#items} +### 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. -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -650,23 +650,23 @@ 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. -### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](/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 -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`SelectedItem`](#SelectedItem)[`?`](/API/builtins/nil.md) {#value} +### value : [`SelectedItem`](#SelectedItem)[`?`](../API/builtins/nil.md) {#value} The currently selected item's index -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -679,34 +679,34 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### margin : [`RackMargin`](#RackMargin)[`?`](/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`](#RackSpacing)[`?`](/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`](#ViewBackgroundStyle)[`?`](/API/builtins/nil.md) {#style} +### style : [`ViewBackgroundStyle`](#ViewBackgroundStyle)[`?`](../API/builtins/nil.md) {#style} Setup a background style for the view. -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### uniform : [`RackUniformity`](#RackUniformity)[`?`](/API/builtins/nil.md) {#uniform} +### 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 @@ -714,13 +714,13 @@ 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 -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -733,38 +733,38 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](/API/builtins/nil.md) {#default} +### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](../API/builtins/nil.md) {#default} The default value that will be re-applied on double-click -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/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 -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -772,27 +772,27 @@ 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. -### min : [`SliderMinValue`](#SliderMinValue)[`?`](/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`](#NumberValueNotifier)[`?`](/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 -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../API/builtins/nil.md) {#value} The current value of the view -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -805,38 +805,38 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](/API/builtins/nil.md) {#default} +### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](../API/builtins/nil.md) {#default} The default value that will be re-applied on double-click -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/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 -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -844,33 +844,33 @@ 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. -### min : [`SliderMinValue`](#SliderMinValue)[`?`](/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`](#NumberValueNotifier)[`?`](/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`](#SliderStepAmounts)[`?`](/API/builtins/nil.md) {#steps} +### 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) -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../API/builtins/nil.md) {#value} The current value of the view -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -883,60 +883,60 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`TextActive`](#TextActive)[`?`](/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`](#TextAlignment)[`?`](/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 -### bind : [`ViewStringObservable`](#ViewStringObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewStringObservable`](#ViewStringObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### edit_mode : [`TextEditMode`](#TextEditMode)[`?`](/API/builtins/nil.md) {#edit_mode} +### 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 -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](/API/builtins/nil.md) {#notifier} +### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](../API/builtins/nil.md) {#notifier} Set up a notifier for text changes -### text : [`TextValueAlias`](#TextValueAlias)[`?`](/API/builtins/nil.md) {#text} +### text : [`TextValueAlias`](#TextValueAlias)[`?`](../API/builtins/nil.md) {#text} Exactly the same as "value"; provided for consistency. * Default: "" -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`TextValue`](#TextValue)[`?`](/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: "" -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -949,43 +949,43 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### align : [`TextAlignment`](#TextAlignment)[`?`](/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`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](../API/builtins/nil.md) {#font} The style that the text should be displayed with. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### style : [`TextStyle`](#TextStyle)[`?`](/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`](#TextSingleLineString)[`?`](/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: "" -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -998,35 +998,35 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### max : [`ValueBoxMaxValue`](#ValueBoxMaxValue)[`?`](/API/builtins/nil.md) {#max} +### max : [`ValueBoxMaxValue`](#ValueBoxMaxValue)[`?`](../API/builtins/nil.md) {#max} The maximum value that can be set using the view * Default: 100 -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -1034,39 +1034,39 @@ 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. -### min : [`ValueBoxMinValue`](#ValueBoxMinValue)[`?`](/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`](#NumberValueNotifier)[`?`](/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`](#SliderStepAmounts)[`?`](/API/builtins/nil.md) {#steps} +### 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) -### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](/API/builtins/nil.md) {#tonumber} +### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](../API/builtins/nil.md) {#tonumber} Make sure to also set `tostring` if you set this. -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### tostring : [`PairedShowNumberAsString`](#PairedShowNumberAsString)[`?`](/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`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../API/builtins/nil.md) {#value} The current value of the view -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -1079,39 +1079,39 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### align : [`TextAlignment`](#TextAlignment)[`?`](/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 -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](/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 -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -1119,33 +1119,33 @@ 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. -### min : [`SliderMinValue`](#SliderMinValue)[`?`](/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`](#NumberValueNotifier)[`?`](/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 -### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](/API/builtins/nil.md) {#tonumber} +### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](../API/builtins/nil.md) {#tonumber} Make sure to also set `tostring` if you set this. -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### tostring : [`PairedShowNumberAsString`](#PairedShowNumberAsString)[`?`](/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`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../API/builtins/nil.md) {#value} The current value of the view -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -1158,39 +1158,39 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### align : [`TextAlignment`](#TextAlignment)[`?`](/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 -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](/API/builtins/nil.md) {#bind} +### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../API/builtins/nil.md) {#bind} 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. -### font : [`TextFontStyle`](#TextFontStyle)[`?`](/API/builtins/nil.md) {#font} +### font : [`TextFontStyle`](#TextFontStyle)[`?`](../API/builtins/nil.md) {#font} The style that the text should be displayed with. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](/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 -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### tostring : [`ShowNumberAsString`](#ShowNumberAsString)[`?`](/API/builtins/nil.md) {#tostring} +### tostring : [`ShowNumberAsString`](#ShowNumberAsString)[`?`](../API/builtins/nil.md) {#tostring} 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 @@ -1198,16 +1198,16 @@ 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. -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](/API/builtins/nil.md) {#value} +### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../API/builtins/nil.md) {#value} The current value of the view -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -1258,28 +1258,28 @@ vb.views["my_view"].visible = false --- ## Properties -### views : table<[`string`](/API/builtins/string.md), [`renoise.Views.View`](/API/renoise/renoise.Views.View.md)> {#views} +### views : table<[`string`](../API/builtins/string.md), [`renoise.Views.View`](../API/renoise/renoise.Views.View.md)> {#views} --- ## Functions -### `bitmap`([*self*](/API/builtins/self.md), properties : [`BitmapViewProperties`](#bitmapviewproperties)[`?`](/API/builtins/nil.md)) {#bitmap} -`->`[`renoise.Views.Bitmap`](/API/renoise/renoise.Views.Bitmap.md) +### `bitmap`([*self*](../API/builtins/self.md), properties : [`BitmapViewProperties`](#bitmapviewproperties)[`?`](../API/builtins/nil.md)) {#bitmap} +`->`[`renoise.Views.Bitmap`](../API/renoise/renoise.Views.Bitmap.md) See: [renoise.Views.Bitmap](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/bitmap.lua#63#10) -### `button`([*self*](/API/builtins/self.md), properties : [`ButtonProperties`](#buttonproperties)[`?`](/API/builtins/nil.md)) {#button} -`->`[`renoise.Views.Button`](/API/renoise/renoise.Views.Button.md) +### `button`([*self*](../API/builtins/self.md), properties : [`ButtonProperties`](#buttonproperties)[`?`](../API/builtins/nil.md)) {#button} +`->`[`renoise.Views.Button`](../API/renoise/renoise.Views.Button.md) See: [renoise.Views.Button](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/button.lua#40#10) -### `checkbox`([*self*](/API/builtins/self.md), properties : [`CheckBoxProperties`](#checkboxproperties)[`?`](/API/builtins/nil.md)) {#checkbox} -`->`[`renoise.Views.CheckBox`](/API/renoise/renoise.Views.CheckBox.md) +### `checkbox`([*self*](../API/builtins/self.md), properties : [`CheckBoxProperties`](#checkboxproperties)[`?`](../API/builtins/nil.md)) {#checkbox} +`->`[`renoise.Views.CheckBox`](../API/renoise/renoise.Views.CheckBox.md) See: [renoise.Views.CheckBox](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/checkbox.lua#28#10) -### `chooser`([*self*](/API/builtins/self.md), properties : [`ChooserProperties`](#chooserproperties)[`?`](/API/builtins/nil.md)) {#chooser} -`->`[`renoise.Views.Chooser`](/API/renoise/renoise.Views.Chooser.md) +### `chooser`([*self*](../API/builtins/self.md), properties : [`ChooserProperties`](#chooserproperties)[`?`](../API/builtins/nil.md)) {#chooser} +`->`[`renoise.Views.Chooser`](../API/renoise/renoise.Views.Chooser.md) See: [renoise.Views.Chooser](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/chooser.lua#19#10) -### `column`([*self*](/API/builtins/self.md), properties : [`RackViewProperties`](#rackviewproperties)) {#column} +### `column`([*self*](../API/builtins/self.md), properties : [`RackViewProperties`](#rackviewproperties)) {#column} You can add nested child views when constructing a column or row by including them in the constructor table in the views property. @@ -1295,7 +1295,7 @@ vb:column { } } ``` -### `horizontal_aligner`([*self*](/API/builtins/self.md), properties : [`AlignerViewProperties`](#alignerviewproperties)) {#horizontal_aligner} +### `horizontal_aligner`([*self*](../API/builtins/self.md), properties : [`AlignerViewProperties`](#alignerviewproperties)) {#horizontal_aligner} You can add nested child views when constructing aligners by including them in the constructor table. @@ -1311,27 +1311,27 @@ vb:horizontal_aligner { } } ``` -### `minislider`([*self*](/API/builtins/self.md), properties : [`MiniSliderProperties`](#minisliderproperties)[`?`](/API/builtins/nil.md)) {#minislider} -`->`[`renoise.Views.MiniSlider`](/API/renoise/renoise.Views.MiniSlider.md) +### `minislider`([*self*](../API/builtins/self.md), properties : [`MiniSliderProperties`](#minisliderproperties)[`?`](../API/builtins/nil.md)) {#minislider} +`->`[`renoise.Views.MiniSlider`](../API/renoise/renoise.Views.MiniSlider.md) See: [renoise.Views.MiniSlider](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/minislider.lua#18#10) -### `multiline_text`([*self*](/API/builtins/self.md), properties : [`MultilineTextViewProperties`](#multilinetextviewproperties)[`?`](/API/builtins/nil.md)) {#multiline_text} -`->`[`renoise.Views.MultiLineText`](/API/renoise/renoise.Views.MultiLineText.md) +### `multiline_text`([*self*](../API/builtins/self.md), properties : [`MultilineTextViewProperties`](#multilinetextviewproperties)[`?`](../API/builtins/nil.md)) {#multiline_text} +`->`[`renoise.Views.MultiLineText`](../API/renoise/renoise.Views.MultiLineText.md) See: [renoise.Views.MultiLineText](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/multiline_text.lua#44#10) -### `multiline_textfield`([*self*](/API/builtins/self.md), properties : [`MultilineTextFieldProperties`](#multilinetextfieldproperties)[`?`](/API/builtins/nil.md)) {#multiline_textfield} -`->`[`renoise.Views.MultiLineTextField`](/API/renoise/renoise.Views.MultiLineTextField.md) +### `multiline_textfield`([*self*](../API/builtins/self.md), properties : [`MultilineTextFieldProperties`](#multilinetextfieldproperties)[`?`](../API/builtins/nil.md)) {#multiline_textfield} +`->`[`renoise.Views.MultiLineTextField`](../API/renoise/renoise.Views.MultiLineTextField.md) See: [renoise.Views.MultiLineTextField](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/multiline_textfield.lua#22#10) -### `popup`([*self*](/API/builtins/self.md), properties : [`PopUpMenuProperties`](#popupmenuproperties)[`?`](/API/builtins/nil.md)) {#popup} -`->`[`renoise.Views.Popup`](/API/renoise/renoise.Views.Popup.md) +### `popup`([*self*](../API/builtins/self.md), properties : [`PopUpMenuProperties`](#popupmenuproperties)[`?`](../API/builtins/nil.md)) {#popup} +`->`[`renoise.Views.Popup`](../API/renoise/renoise.Views.Popup.md) See: [renoise.Views.Popup](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/popup.lua#25#10) -### `rotary`([*self*](/API/builtins/self.md), properties : [`RotaryEncoderProperties`](#rotaryencoderproperties)[`?`](/API/builtins/nil.md)) {#rotary} -`->`[`renoise.Views.RotaryEncoder`](/API/renoise/renoise.Views.RotaryEncoder.md) +### `rotary`([*self*](../API/builtins/self.md), properties : [`RotaryEncoderProperties`](#rotaryencoderproperties)[`?`](../API/builtins/nil.md)) {#rotary} +`->`[`renoise.Views.RotaryEncoder`](../API/renoise/renoise.Views.RotaryEncoder.md) See: [renoise.Views.RotaryEncoder](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/rotary.lua#23#10) -### `row`([*self*](/API/builtins/self.md), properties : [`RackViewProperties`](#rackviewproperties)) {#row} +### `row`([*self*](../API/builtins/self.md), properties : [`RackViewProperties`](#rackviewproperties)) {#row} You can add nested child views when constructing a column or row by including them in the constructor table in the views property. @@ -1347,11 +1347,11 @@ vb:column { } } ``` -### `slider`([*self*](/API/builtins/self.md), properties : [`SliderProperties`](#sliderproperties)[`?`](/API/builtins/nil.md)) {#slider} -`->`[`renoise.Views.Slider`](/API/renoise/renoise.Views.Slider.md) +### `slider`([*self*](../API/builtins/self.md), properties : [`SliderProperties`](#sliderproperties)[`?`](../API/builtins/nil.md)) {#slider} +`->`[`renoise.Views.Slider`](../API/renoise/renoise.Views.Slider.md) See: [renoise.Views.Slider](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/slider.lua#42#10) -### `space`([*self*](/API/builtins/self.md), properties : [`ViewProperties`](#viewproperties)) {#space} +### `space`([*self*](../API/builtins/self.md), properties : [`ViewProperties`](#viewproperties)) {#space} You can create an empty space in layouts with a space. ### example: @@ -1369,31 +1369,31 @@ vb:row { }, } ``` -### `switch`([*self*](/API/builtins/self.md), properties : [`ButtonSwitchProperties`](#buttonswitchproperties)[`?`](/API/builtins/nil.md)) {#switch} -`->`[`renoise.Views.Switch`](/API/renoise/renoise.Views.Switch.md) +### `switch`([*self*](../API/builtins/self.md), properties : [`ButtonSwitchProperties`](#buttonswitchproperties)[`?`](../API/builtins/nil.md)) {#switch} +`->`[`renoise.Views.Switch`](../API/renoise/renoise.Views.Switch.md) See: [renoise.Views.Switch](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/switch.lua#30#10) -### `text`([*self*](/API/builtins/self.md), properties : [`TextViewProperties`](#textviewproperties)[`?`](/API/builtins/nil.md)) {#text} -`->`[`renoise.Views.Text`](/API/renoise/renoise.Views.Text.md) +### `text`([*self*](../API/builtins/self.md), properties : [`TextViewProperties`](#textviewproperties)[`?`](../API/builtins/nil.md)) {#text} +`->`[`renoise.Views.Text`](../API/renoise/renoise.Views.Text.md) See: [renoise.Views.Text](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/text.lua#48#10) -### `textfield`([*self*](/API/builtins/self.md), properties : [`TextFieldProperties`](#textfieldproperties)[`?`](/API/builtins/nil.md)) {#textfield} -`->`[`renoise.Views.TextField`](/API/renoise/renoise.Views.TextField.md) +### `textfield`([*self*](../API/builtins/self.md), properties : [`TextFieldProperties`](#textfieldproperties)[`?`](../API/builtins/nil.md)) {#textfield} +`->`[`renoise.Views.TextField`](../API/renoise/renoise.Views.TextField.md) See: [renoise.Views.TextField](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/textfield.lua#41#10) -### `value`([*self*](/API/builtins/self.md), properties : [`ValueViewProperties`](#valueviewproperties)[`?`](/API/builtins/nil.md)) {#value} -`->`[`renoise.Views.Value`](/API/renoise/renoise.Views.Value.md) +### `value`([*self*](../API/builtins/self.md), properties : [`ValueViewProperties`](#valueviewproperties)[`?`](../API/builtins/nil.md)) {#value} +`->`[`renoise.Views.Value`](../API/renoise/renoise.Views.Value.md) See: [renoise.Views.Value](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/value.lua#20#10) -### `valuebox`([*self*](/API/builtins/self.md), properties : [`ValueBoxProperties`](#valueboxproperties)[`?`](/API/builtins/nil.md)) {#valuebox} -`->`[`renoise.Views.ValueBox`](/API/renoise/renoise.Views.ValueBox.md) +### `valuebox`([*self*](../API/builtins/self.md), properties : [`ValueBoxProperties`](#valueboxproperties)[`?`](../API/builtins/nil.md)) {#valuebox} +`->`[`renoise.Views.ValueBox`](../API/renoise/renoise.Views.ValueBox.md) See: [renoise.Views.ValueBox](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/valuebox.lua#51#10) -### `valuefield`([*self*](/API/builtins/self.md), properties : [`ValueFieldProperties`](#valuefieldproperties)[`?`](/API/builtins/nil.md)) {#valuefield} -`->`[`renoise.Views.ValueField`](/API/renoise/renoise.Views.ValueField.md) +### `valuefield`([*self*](../API/builtins/self.md), properties : [`ValueFieldProperties`](#valuefieldproperties)[`?`](../API/builtins/nil.md)) {#valuefield} +`->`[`renoise.Views.ValueField`](../API/renoise/renoise.Views.ValueField.md) See: [renoise.Views.ValueField](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/valuefield.lua#20#10) -### `vertical_aligner`([*self*](/API/builtins/self.md), properties : [`AlignerViewProperties`](#alignerviewproperties)) {#vertical_aligner} +### `vertical_aligner`([*self*](../API/builtins/self.md), properties : [`AlignerViewProperties`](#alignerviewproperties)) {#vertical_aligner} You can add nested child views when constructing aligners by including them in the constructor table. @@ -1409,8 +1409,8 @@ vb:horizontal_aligner { } } ``` -### `xypad`([*self*](/API/builtins/self.md), properties : [`XYPadProperties`](#xypadproperties)[`?`](/API/builtins/nil.md)) {#xypad} -`->`[`renoise.Views.XYPad`](/API/renoise/renoise.Views.XYPad.md) +### `xypad`([*self*](../API/builtins/self.md), properties : [`XYPadProperties`](#xypadproperties)[`?`](../API/builtins/nil.md)) {#xypad} +`->`[`renoise.Views.XYPad`](../API/renoise/renoise.Views.XYPad.md) See: [renoise.Views.XYPad](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/views/xypad.lua#64#10) @@ -1420,28 +1420,28 @@ See: [renoise.Views.XYPad](file:///c%3A/Users/emuell/Development/Renoise-XRNX/de --- ## Properties -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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`](#ViewTooltip)[`?`](/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`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -1454,13 +1454,13 @@ relative to the view's parent size and will automatically update on size changes --- ## Properties -### active : [`ControlActive`](#ControlActive)[`?`](/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. -### bind : [`XYPadObservables`](#XYPadObservables)[`?`](/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, @@ -1470,22 +1470,22 @@ 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. -### height : [`ViewDimension`](#ViewDimension)[`?`](/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`](#ViewId)[`?`](/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. -### max : [`XYPadMaxValues`](#XYPadMaxValues)[`?`](/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} -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](/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 @@ -1493,34 +1493,34 @@ 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. -### min : [`XYPadMinValues`](#XYPadMinValues)[`?`](/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`](#XYValueNotifier)[`?`](/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`](#XYPadSnapbackValues)[`?`](/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. -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](/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) -### value : [`XYPadValues`](#XYPadValues)[`?`](/API/builtins/nil.md) {#value} +### value : [`XYPadValues`](#XYPadValues)[`?`](../API/builtins/nil.md) {#value} A table of the XYPad's current values on each axis -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](/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`](#ViewDimension)[`?`](/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 @@ -1549,7 +1549,7 @@ AlignerMode: ``` # alias BitmapImagePath {#BitmapImagePath} -[`string`](/API/builtins/string.md) +[`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" @@ -1585,7 +1585,7 @@ BitmapMode: Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). # alias BooleanValueNotifierFunction {#BooleanValueNotifierFunction} -(value : [`boolean`](/API/builtins/boolean.md)) +(value : [`boolean`](../API/builtins/boolean.md)) # alias BooleanValueNotifierMethod1 {#BooleanValueNotifierMethod1} @@ -1614,7 +1614,7 @@ always visible. Set color {0,0,0} to enable the theme colors for the button again. # alias ButtonLabel {#ButtonLabel} -[`string`](/API/builtins/string.md) +[`string`](../API/builtins/string.md) The text label of the button * Default: "" @@ -1623,7 +1623,7 @@ The text label of the button A click notifier # alias CheckBoxBoolean {#CheckBoxBoolean} -[`boolean`](/API/builtins/boolean.md) +[`boolean`](../API/builtins/boolean.md) The current state of the checkbox, expressed as boolean. * Default: false @@ -1632,14 +1632,14 @@ The current state of the checkbox, expressed as boolean. A notifier for when the checkbox is toggled # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -1652,7 +1652,7 @@ message will do nothing and no error is fired. Set up a notifier that will be called whenever a new item is picked # alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} -(value : [`integer`](/API/builtins/integer.md)) +(value : [`integer`](../API/builtins/integer.md)) # alias IntegerValueNotifierMethod1 {#IntegerValueNotifierMethod1} @@ -1664,7 +1664,7 @@ Set up a notifier that will be called whenever a new item is picked # alias ItemLabels {#ItemLabels} -[`string`](/API/builtins/string.md)`[]` +[`string`](../API/builtins/string.md)`[]` A list of buttons labels to show in order. Must have more than one item. # alias NotifierFunction {#NotifierFunction} @@ -1684,7 +1684,7 @@ fun() Set up a value notifier that will be called whenever the value changes # alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) +(value : [`number`](../API/builtins/number.md)) # alias NumberValueNotifierMethod1 {#NumberValueNotifierMethod1} @@ -1696,7 +1696,7 @@ Set up a value notifier that will be called whenever the value changes # alias PairedParseStringAsNumber {#PairedParseStringAsNumber} -(value : [`string`](/API/builtins/string.md)) `->` [`number`](/API/builtins/number.md)[`?`](/API/builtins/nil.md) +(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. # alias PairedShowNumberAsString {#PairedShowNumberAsString} @@ -1704,30 +1704,30 @@ Make sure to also set `tostring` if you set this. Make sure to also set `tonumber` if you set this. # alias PopupItemLabels {#PopupItemLabels} -[`string`](/API/builtins/string.md)`[]` +[`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 RGBColor {#RGBColor} -{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +{ 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 # alias RackMargin {#RackMargin} -[`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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 @@ -1736,11 +1736,11 @@ as a child view size changes or new children are added. * Default: false # alias SelectedItem {#SelectedItem} -[`integer`](/API/builtins/integer.md) +[`integer`](../API/builtins/integer.md) The currently selected item's index # alias ShowNumberAsString {#ShowNumberAsString} -(value : [`number`](/API/builtins/number.md)) `->` [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +(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 @@ -1749,25 +1749,25 @@ Note: When the callback fails with an error, it will be disabled to avoid a flood of error messages. # alias SliderDefaultValue {#SliderDefaultValue} -[`number`](/API/builtins/number.md) +[`number`](../API/builtins/number.md) The default value that will be re-applied on double-click # alias SliderMaxValue {#SliderMaxValue} -[`number`](/API/builtins/number.md) +[`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) +[`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) +[`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) } +{ 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) @@ -1778,7 +1778,7 @@ second value is the big step (applied on right clicks) Set up a notifier for text changes # alias StringValueNotifierFunction {#StringValueNotifierFunction} -(value : [`string`](/API/builtins/string.md)) +(value : [`string`](../API/builtins/string.md)) # alias StringValueNotifierMethod1 {#StringValueNotifierMethod1} @@ -1790,7 +1790,7 @@ Set up a notifier for text changes # alias TextActive {#TextActive} -[`boolean`](/API/builtins/boolean.md) +[`boolean`](../API/builtins/boolean.md) When false, text is displayed but can not be entered/modified by the user. * Default: true @@ -1816,7 +1816,7 @@ TextBackgroundStyle: ``` # alias TextEditMode {#TextEditMode} -[`boolean`](/API/builtins/boolean.md) +[`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 @@ -1834,19 +1834,19 @@ TextFontStyle: ``` # alias TextMultilineString {#TextMultilineString} -[`string`](/API/builtins/string.md) +[`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)`[]` +[`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 TextSingleLineString {#TextSingleLineString} -[`string`](/API/builtins/string.md) +[`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: "" @@ -1862,23 +1862,23 @@ TextStyle: ``` # alias TextValue {#TextValue} -[`string`](/API/builtins/string.md) +[`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) +[`string`](../API/builtins/string.md) Exactly the same as "value"; provided for consistency. * Default: "" # alias ValueBoxMaxValue {#ValueBoxMaxValue} -[`number`](/API/builtins/number.md) +[`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) +[`number`](../API/builtins/number.md) The minimum value that can be set using the view * Default: 0 @@ -1896,7 +1896,7 @@ ViewBackgroundStyle: ``` # alias ViewBooleanObservable {#ViewBooleanObservable} -[`renoise.Document.ObservableBoolean`](/API/renoise/renoise.Document.ObservableBoolean.md) +[`renoise.Document.ObservableBoolean`](../API/renoise/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 @@ -1904,20 +1904,20 @@ 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. # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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 ViewId {#ViewId} -[`string`](/API/builtins/string.md) +[`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. # alias ViewNumberObservable {#ViewNumberObservable} -[`renoise.Document.ObservableNumber`](/API/renoise/renoise.Document.ObservableNumber.md) +[`renoise.Document.ObservableNumber`](../API/renoise/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 @@ -1925,7 +1925,7 @@ 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. # alias ViewStringListObservable {#ViewStringListObservable} -[`renoise.Document.ObservableStringList`](/API/renoise/renoise.Document.ObservableStringList.md) +[`renoise.Document.ObservableStringList`](../API/renoise/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 @@ -1933,7 +1933,7 @@ 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. # alias ViewStringObservable {#ViewStringObservable} -[`renoise.Document.ObservableString`](/API/renoise/renoise.Document.ObservableString.md) +[`renoise.Document.ObservableString`](../API/renoise/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 @@ -1941,12 +1941,12 @@ 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. # alias ViewTooltip {#ViewTooltip} -[`string`](/API/builtins/string.md) +[`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) +[`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). @@ -1963,7 +1963,7 @@ A table of allowed minimum values for each axis * Default: {x: 0.0, y: 0.0} # alias XYPadObservables {#XYPadObservables} -{ x : [`renoise.Document.ObservableNumber`](/API/renoise/renoise.Document.ObservableNumber.md), y : [`renoise.Document.ObservableNumber`](/API/renoise/renoise.Document.ObservableNumber.md) } +{ x : [`renoise.Document.ObservableNumber`](../API/renoise/renoise.Document.ObservableNumber.md), y : [`renoise.Document.ObservableNumber`](../API/renoise/renoise.Document.ObservableNumber.md) } Bind the view's value to a pair of renoise.Document.ObservableNumber objects. Automatically keep both values in sync. @@ -1975,7 +1975,7 @@ is expected here and not a single value. So you have to bind two ObservableNumber object to the pad. # alias XYPadSnapbackValues {#XYPadSnapbackValues} -{ x : [`number`](/API/builtins/number.md), y : [`number`](/API/builtins/number.md) } +{ 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. diff --git a/docs/API/renoise/renoise.Application.md b/docs/API/renoise/renoise.Application.md index 96723cf..a535fa3 100644 --- a/docs/API/renoise/renoise.Application.md +++ b/docs/API/renoise/renoise.Application.md @@ -6,206 +6,206 @@ 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/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. -### installed_tools : table<[`string`](/API/builtins/string.md), [`string`](/API/builtins/string.md)> {#installed_tools} +### installed_tools : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)> {#installed_tools} **READ-ONLY** Returns information about all currently installed tools. -### key_modifier_states : table<[`string`](/API/builtins/string.md), [`string`](/API/builtins/string.md)> {#key_modifier_states} +### key_modifier_states : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)> {#key_modifier_states} **READ-ONLY** Access keyboard modifier states. -### log_filename : [`string`](/API/builtins/string.md) {#log_filename} +### log_filename : [`string`](../../API/builtins/string.md) {#log_filename} **READ-ONLY** Access to the application's full log filename and path. Will already be opened for writing, but you nevertheless should be able to read from it. -### recently_loaded_song_files : [`string`](/API/builtins/string.md)`[]` {#recently_loaded_song_files} +### recently_loaded_song_files : [`string`](../../API/builtins/string.md)`[]` {#recently_loaded_song_files} **READ-ONLY** List of recently loaded song files. -### recently_saved_song_files : [`string`](/API/builtins/string.md)`[]` {#recently_saved_song_files} +### 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/renoise.ApplicationWindow.md) {#window} +### window : [`renoise.ApplicationWindow`](../../API/renoise/renoise.ApplicationWindow.md) {#window} **READ-ONLY** Access to the application's window. --- ## Functions -### `install_tool`([*self*](/API/builtins/self.md), file_path : [`string`](/API/builtins/string.md)) {#install_tool} +### `install_tool`([*self*](../../API/builtins/self.md), file_path : [`string`](../../API/builtins/string.md)) {#install_tool} Install order update a tool. Any errors are shown to the user during installation. Installing an already existing tool will upgrade the tool without confirmation. Upgraded tools will automatically be re-enabled, if necessary. -### `load_instrument`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_instrument} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_instrument`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_instrument} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load an instrument into the currently selected instrument. Any errors during the export are shown to the user. -### `load_instrument_device_chain`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_instrument_device_chain} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_instrument_device_chain`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_instrument_device_chain} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load an instrument device chain into the currently selected instrument's device chain. When no device chain is selected, a new one will be created. Any errors during the export are shown to the user. -### `load_instrument_device_preset`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_instrument_device_preset} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_instrument_device_preset`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_instrument_device_preset} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load an instrument device into the currently selected instrument's device chain's device. When no device is selected, a new one will be created. Any errors during the export are shown to the user. -### `load_instrument_modulation_set`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_instrument_modulation_set} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_instrument_modulation_set`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_instrument_modulation_set} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load an instrument modulation chain into the currently selected instrument's modulation chain. When no device is selected, a new one will be created. Any errors during the export are shown to the user. -### `load_instrument_multi_sample`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_instrument_multi_sample} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_instrument_multi_sample`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_instrument_multi_sample} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load an instrument multi sample into the currently selected instrument. Any errors during the export are shown to the user. -### `load_instrument_phrase`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_instrument_phrase} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_instrument_phrase`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_instrument_phrase} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load an instrument phrase into the currently selected instrument's phrases. When no phrase is selected, a new one will be created. Any errors during the export are shown to the user. -### `load_instrument_sample`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_instrument_sample} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_instrument_sample`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_instrument_sample} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load an instrument sample into the currently selected instrument's sample lists. When no sample is selected, a new one will be created. Any errors during the export are shown to the user. -### `load_song`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_song} +### `load_song`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_song} Load a new song document from the given filename (will ask to save changes if needed, any errors are shown to the user). Just like new_song(), the song is not loaded immediately, but soon after the call was made. See 'renoise.app():new_song()' for details. -### `load_theme`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_theme} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_theme`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_theme} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load a new theme file and apply it. Any errors during the export are shown to the user. -### `load_track_device_chain`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_track_device_chain} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_track_device_chain`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_track_device_chain} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load a track device chains into the currently selected track. Any errors during the export are shown to the user. -### `load_track_device_preset`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_track_device_preset} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_track_device_preset`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_track_device_preset} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load a track device devices into the currently selected track. When no device is selected a new device will be created. Any errors during the export are shown to the user. -### `new_song`([*self*](/API/builtins/self.md)) {#new_song} +### `new_song`([*self*](../../API/builtins/self.md)) {#new_song} Create a new song document (will ask the user to save changes if needed). The song is not created immediately, but soon after the call was made and the user did not aborted the operation. In order to continue execution with the new song, attach a notifier to 'renoise.app().new_document_observable' See: [renoise.ScriptingTool](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/tool.lua#19#10) for more info. -### `new_song_no_template`([*self*](/API/builtins/self.md)) {#new_song_no_template} +### `new_song_no_template`([*self*](../../API/builtins/self.md)) {#new_song_no_template} Create a new song document, avoiding template XRNS songs (when present) to be loaded. The song is not created immediately, but soon after the call was made and the user did not aborted the operation. In order to continue execution with the new song, attach a notifier to 'renoise.app().new_document_observable' See: [renoise.ScriptingTool](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/tool.lua#19#10) for more info. -### `open_path`([*self*](/API/builtins/self.md), file_path : [`string`](/API/builtins/string.md)) {#open_path} +### `open_path`([*self*](../../API/builtins/self.md), file_path : [`string`](../../API/builtins/string.md)) {#open_path} 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} +### `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`](#DialogTitle)) {#prompt_for_filename_to_read} -`->`path : [`string`](/API/builtins/string.md) +### `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`](#DialogTitle)) {#prompt_for_filename_to_write} -`->`path : [`string`](/API/builtins/string.md) +### `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`](#DialogTitle)) {#prompt_for_multiple_filenames_to_read} -`->`paths : [`string`](/API/builtins/string.md)`[]` +### `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`](#DialogTitle)) {#prompt_for_path} -`->`path : [`string`](/API/builtins/string.md) +### `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. -### `save_instrument`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_instrument} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_instrument`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_instrument} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a currently selected instrument to a file with the given name. When no instruemnt is selected an error is raised. returns success. -### `save_instrument_device_chain`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_instrument_device_chain} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_instrument_device_chain`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_instrument_device_chain} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a currently selected instrument's device chain to a file with the given name. When no chain is selected an error is raised. returns success. -### `save_instrument_modulation_set`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_instrument_modulation_set} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_instrument_modulation_set`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_instrument_modulation_set} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a currently selected instrument's modulation set to a file with the given name. When no modulation is selected an error is raised. returns success. -### `save_instrument_multi_sample`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_instrument_multi_sample} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_instrument_multi_sample`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_instrument_multi_sample} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a currently selected instrument multi sample file to a file with the given name. When no instrument is selected an error is raised. returns success. -### `save_instrument_phrase`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_instrument_phrase} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_instrument_phrase`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_instrument_phrase} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a currently selected instrument's phrase to a file with the given name. When no phrase is selected an error is raised. returns success. -### `save_instrument_sample`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_instrument_sample} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_instrument_sample`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_instrument_sample} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a currently selected instrument's sample to a file with the given name. When no sample is selected an error is raised. returns success. -### `save_song`([*self*](/API/builtins/self.md)) {#save_song} +### `save_song`([*self*](../../API/builtins/self.md)) {#save_song} Quicksave or save the current song under a new name. Any errors during the export are shown to the user. -### `save_song_as`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_song_as} +### `save_song_as`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_song_as} Save the current song under a new name. Any errors during the export are shown to the user. -### `save_theme`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_theme} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_theme`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_theme} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a current theme to a file with the given name. returns success. -### `save_track_device_chain`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_track_device_chain} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `save_track_device_chain`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_track_device_chain} +`->`success : [`boolean`](../../API/builtins/boolean.md) Save a currently selected track device chain to a file with the given name. When no device chain is selected an error is raised. returns success. -### `show_custom_dialog`([*self*](/API/builtins/self.md), title : [`DialogTitle`](#DialogTitle), content_view : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md), key_handler : [`KeyHandler`](#KeyHandler)[`?`](/API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](/API/builtins/nil.md)) {#show_custom_dialog} -`->`[`renoise.Dialog`](/API/renoise/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`](#keyhandleroptions)[`?`](../../API/builtins/nil.md)) {#show_custom_dialog} +`->`[`renoise.Dialog`](../../API/renoise/renoise.Dialog.md) Shows a non modal dialog (a floating tool window) with custom content. When no key_handler is provided, the Escape key is used to close the dialog. See: [renoise.ViewBuilder](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/viewbuilder.lua#17#10) for more info about custom views. -### `show_custom_prompt`([*self*](/API/builtins/self.md), title : [`string`](/API/builtins/string.md), content_view : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md), button_labels : [`string`](/API/builtins/string.md)`[]`, key_handler : [`KeyHandler`](#KeyHandler)[`?`](/API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](/API/builtins/nil.md)) {#show_custom_prompt} -`->`label : [`string`](/API/builtins/string.md) +### `show_custom_prompt`([*self*](../../API/builtins/self.md), title : [`string`](../../API/builtins/string.md), content_view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), button_labels : [`string`](../../API/builtins/string.md)`[]`, key_handler : [`KeyHandler`](#KeyHandler)[`?`](../../API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](../../API/builtins/nil.md)) {#show_custom_prompt} +`->`label : [`string`](../../API/builtins/string.md) Opens a modal dialog with a title, custom content and custom button labels. See: [renoise.ViewBuilder](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/viewbuilder.lua#17#10) for more info about custom views. -### `show_error`([*self*](/API/builtins/self.md), message : [`string`](/API/builtins/string.md)) {#show_error} +### `show_error`([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) {#show_error} Shows an error dialog to the user. -### `show_message`([*self*](/API/builtins/self.md), message : [`string`](/API/builtins/string.md)) {#show_message} +### `show_message`([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) {#show_message} Shows an info message dialog to the user. -### `show_prompt`([*self*](/API/builtins/self.md), title : [`string`](/API/builtins/string.md), message : [`string`](/API/builtins/string.md), button_labels : [`string`](/API/builtins/string.md)`[]`[`?`](/API/builtins/nil.md)) {#show_prompt} -`->`label : [`string`](/API/builtins/string.md) +### `show_prompt`([*self*](../../API/builtins/self.md), title : [`string`](../../API/builtins/string.md), message : [`string`](../../API/builtins/string.md), button_labels : [`string`](../../API/builtins/string.md)`[]`[`?`](../../API/builtins/nil.md)) {#show_prompt} +`->`label : [`string`](../../API/builtins/string.md) Opens a modal dialog with a title, text and custom button labels. Returns the pressed button label or an empty string when canceled. -### `show_status`([*self*](/API/builtins/self.md), message : [`string`](/API/builtins/string.md)) {#show_status} +### `show_status`([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) {#show_status} Shows a message in Renoise's status bar to the user. -### `show_warning`([*self*](/API/builtins/self.md), message : [`string`](/API/builtins/string.md)) {#show_warning} +### `show_warning`([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) {#show_warning} Shows a warning dialog to the user. -### `uninstall_tool`([*self*](/API/builtins/self.md), file_path : [`string`](/API/builtins/string.md)) {#uninstall_tool} +### `uninstall_tool`([*self*](../../API/builtins/self.md), file_path : [`string`](../../API/builtins/string.md)) {#uninstall_tool} Uninstall an existing tool. Any errors are shown to the user during uninstallation. @@ -217,19 +217,19 @@ during uninstallation. --- ## Properties -### character : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) {#character} +### character : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) {#character} possible character representation of the key ### modifiers : [`ModifierStates`](#ModifierStates) {#modifiers} the held down modifiers as a string -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} name of the key, like 'esc' or 'a' -### note : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#note} +### note : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#note} virtual keyboard piano key value (starting from 0) -### repeated : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#repeated} +### repeated : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) {#repeated} only present if `send_key_repeat` was set to true ### state : `"pressed"` | `"released"` {#state} @@ -242,10 +242,10 @@ only present if `send_key_release` was set to true --- ## Properties -### send_key_release : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#send_key_release} +### send_key_release : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) {#send_key_release} Default: false -### send_key_repeat : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#send_key_repeat} +### send_key_repeat : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) {#send_key_repeat} Default: true @@ -257,11 +257,11 @@ Default: true --- ## Aliases # alias DialogTitle {#DialogTitle} -[`string`](/API/builtins/string.md) +[`string`](../../API/builtins/string.md) The title that shows up at the title-bar of the dialog. # alias KeyHandler {#KeyHandler} -(dialog : [`renoise.Dialog`](/API/renoise/renoise.Dialog.md), key_event : [`KeyEvent`](#keyevent)) `->` [`KeyEvent`](#keyevent)[`?`](/API/builtins/nil.md) +(dialog : [`renoise.Dialog`](../../API/renoise/renoise.Dialog.md), key_event : [`KeyEvent`](#keyevent)) `->` [`KeyEvent`](#keyevent)[`?`](../../API/builtins/nil.md) Optional keyhandler to process key events on a custom dialog. When returning the passed key from the key-handler function, the key will be passed back to Renoise's key event chain, in order to allow @@ -271,7 +271,7 @@ because your dialog will steal the focus from all other Renoise views such as the Pattern Editor, etc. # alias ModifierStates {#ModifierStates} -[`string`](/API/builtins/string.md) +[`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" diff --git a/docs/API/renoise/renoise.ApplicationWindow.md b/docs/API/renoise/renoise.ApplicationWindow.md index 643eaea..6842775 100644 --- a/docs/API/renoise/renoise.ApplicationWindow.md +++ b/docs/API/renoise/renoise.ApplicationWindow.md @@ -43,105 +43,105 @@ 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/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} Track changes to document properties or general states by attaching listener functions to it. ### 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/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} Track changes to document properties or general states by attaching listener functions to it. ### active_upper_frame : [`renoise.ApplicationWindow.UpperFrame`](renoise.ApplicationWindow.md#UpperFrame) {#active_upper_frame} -### active_upper_frame_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### disk_browser_is_visible : [`boolean`](/API/builtins/boolean.md) {#disk_browser_is_visible} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### fullscreen : [`boolean`](/API/builtins/boolean.md) {#fullscreen} +### 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} +### instrument_box_is_visible : [`boolean`](../../API/builtins/boolean.md) {#instrument_box_is_visible} InstrumentBox -### instrument_box_is_visible_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### instrument_editor_is_detached : [`boolean`](/API/builtins/boolean.md) {#instrument_editor_is_detached} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} **READ-ONLY**. Window status flag. -### is_minimized : [`boolean`](/API/builtins/boolean.md) {#is_minimized} +### is_minimized : [`boolean`](../../API/builtins/boolean.md) {#is_minimized} **READ-ONLY**. Window status flag. -### lock_keyboard_focus : [`boolean`](/API/builtins/boolean.md) {#lock_keyboard_focus} +### lock_keyboard_focus : [`boolean`](../../API/builtins/boolean.md) {#lock_keyboard_focus} When true, the middle frame views (like the pattern editor) will stay focused unless alt or middle mouse is clicked. -### lower_frame_is_visible : [`boolean`](/API/builtins/boolean.md) {#lower_frame_is_visible} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. ### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### mixer_view_is_detached : [`boolean`](/API/builtins/boolean.md) {#mixer_view_is_detached} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### mixer_view_post_fx : [`boolean`](/API/builtins/boolean.md) {#mixer_view_post_fx} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### pattern_advanced_edit_is_visible : [`boolean`](/API/builtins/boolean.md) {#pattern_advanced_edit_is_visible} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### pattern_matrix_is_visible : [`boolean`](/API/builtins/boolean.md) {#pattern_matrix_is_visible} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### sample_record_dialog_is_visible : [`boolean`](/API/builtins/boolean.md) {#sample_record_dialog_is_visible} +### 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} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. @@ -149,14 +149,14 @@ functions to it. --- ## Functions -### `maximize`([*self*](/API/builtins/self.md)) {#maximize} +### `maximize`([*self*](../../API/builtins/self.md)) {#maximize} Expand the window over the entire screen, without hiding menu bars, docks and so on. -### `minimize`([*self*](/API/builtins/self.md)) {#minimize} +### `minimize`([*self*](../../API/builtins/self.md)) {#minimize} Minimize the window to the dock or taskbar, depending on the OS. -### `restore`([*self*](/API/builtins/self.md)) {#restore} +### `restore`([*self*](../../API/builtins/self.md)) {#restore} "un-maximize" or "un-minimize" the window, or just bring it to front. -### `select_preset`([*self*](/API/builtins/self.md), preset_index : [`integer`](/API/builtins/integer.md)) {#select_preset} +### `select_preset`([*self*](../../API/builtins/self.md), preset_index : [`integer`](../../API/builtins/integer.md)) {#select_preset} Select/activate one of the global view presets, to memorize/restore the user interface layout. diff --git a/docs/API/renoise/renoise.AudioDevice.md b/docs/API/renoise/renoise.AudioDevice.md index 825e547..67ec430 100644 --- a/docs/API/renoise/renoise.AudioDevice.md +++ b/docs/API/renoise/renoise.AudioDevice.md @@ -3,75 +3,75 @@ Audio DSP device in tracks or sample device chains. --- ## Properties -### active_preset : [`integer`](/API/builtins/integer.md) {#active_preset} +### active_preset : [`integer`](../../API/builtins/integer.md) {#active_preset} 0 when none is active or available -### active_preset_data : [`string`](/API/builtins/string.md) {#active_preset_data} +### 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/renoise.Document.Observable.md) {#active_preset_observable} +### active_preset_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#active_preset_observable} Track changes to document properties or general states by attaching listener functions to it. -### device_path : [`string`](/API/builtins/string.md) {#device_path} +### 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: `renoise.song().tracks[]:insert_device_at()` -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### 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/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### external_editor_available : [`boolean`](/API/builtins/boolean.md) {#external_editor_available} +### 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) -### external_editor_visible : [`boolean`](/API/builtins/boolean.md) {#external_editor_visible} +### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) {#external_editor_visible} true to show the editor, false to close it -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} !active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} **READ-ONLY** -### is_maximized : [`boolean`](/API/builtins/boolean.md) {#is_maximized} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in DSP chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} **READ-ONLY** -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### presets : [`string`](/API/builtins/string.md)`[]` {#presets} +### presets : [`string`](../../API/builtins/string.md)`[]` {#presets} **READ-ONLY** preset names -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** --- ## Functions -### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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. -### `preset`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#preset} -`->`preset_name : [`string`](/API/builtins/string.md) +### `preset`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#preset} +`->`preset_name : [`string`](../../API/builtins/string.md) Access to a single preset name by index. Use properties 'presets' to iterate over all presets and to query the presets count. diff --git a/docs/API/renoise/renoise.DeviceParameter.md b/docs/API/renoise/renoise.DeviceParameter.md index d3ada2f..96bb257 100644 --- a/docs/API/renoise/renoise.DeviceParameter.md +++ b/docs/API/renoise/renoise.DeviceParameter.md @@ -12,61 +12,61 @@ A single parameter within an audio DSP effect (renoise.AudioDevice) --- ## Properties -### is_automatable : [`boolean`](/API/builtins/boolean.md) {#is_automatable} +### is_automatable : [`boolean`](../../API/builtins/boolean.md) {#is_automatable} **READ-ONLY** -### is_automated : [`boolean`](/API/builtins/boolean.md) {#is_automated} +### 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/renoise.Document.Observable.md) {#is_automated_observable} +### is_automated_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_automated_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_midi_mapped : [`boolean`](/API/builtins/boolean.md) {#is_midi_mapped} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} **READ-ONLY** ### polarity : [`renoise.DeviceParameter.Polarity`](renoise.DeviceParameter.md#Polarity) {#polarity} **READ-ONLY** -### show_in_mixer : [`boolean`](/API/builtins/boolean.md) {#show_in_mixer} +### show_in_mixer : [`boolean`](../../API/builtins/boolean.md) {#show_in_mixer} - Show in mixer. Not valid for parameters of instrument devices. -### show_in_mixer_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### time_quantum : [`number`](/API/builtins/number.md) {#time_quantum} +### time_quantum : [`number`](../../API/builtins/number.md) {#time_quantum} **READ-ONLY** -### value : [`number`](/API/builtins/number.md) {#value} +### value : [`number`](../../API/builtins/number.md) {#value} value in Range: (value_min - value_max) -### value_default : [`number`](/API/builtins/number.md) {#value_default} +### value_default : [`number`](../../API/builtins/number.md) {#value_default} **READ-ONLY** -### value_max : [`number`](/API/builtins/number.md) {#value_max} +### value_max : [`number`](../../API/builtins/number.md) {#value_max} **READ-ONLY** -### value_min : [`number`](/API/builtins/number.md) {#value_min} +### value_min : [`number`](../../API/builtins/number.md) {#value_min} **READ-ONLY** -### value_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#value_observable} +### value_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#value_observable} Track changes to document properties or general states by attaching listener functions to it. -### value_quantum : [`number`](/API/builtins/number.md) {#value_quantum} +### 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/renoise.Document.Observable.md) {#value_string_observable} +### value_string : [`string`](../../API/builtins/string.md) {#value_string} +### value_string_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#value_string_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -74,7 +74,7 @@ functions to it. --- ## Functions -### `record_value`([*self*](/API/builtins/self.md), value : [`number`](/API/builtins/number.md)) {#record_value} +### `record_value`([*self*](../../API/builtins/self.md), value : [`number`](../../API/builtins/number.md)) {#record_value} Set a new value and write automation when the MIDI mapping "record to automation" option is set. Only works for parameters of track devices, not for instrument devices. diff --git a/docs/API/renoise/renoise.Dialog.md b/docs/API/renoise/renoise.Dialog.md index 12634fd..1a2ea72 100644 --- a/docs/API/renoise/renoise.Dialog.md +++ b/docs/API/renoise/renoise.Dialog.md @@ -7,15 +7,15 @@ create views for the dialog. --- ## Properties -### visible : [`boolean`](/API/builtins/boolean.md) {#visible} +### visible : [`boolean`](../../API/builtins/boolean.md) {#visible} **READ-ONLY** Check if a dialog is alive and visible. --- ## Functions -### `close`([*self*](/API/builtins/self.md)) {#close} +### `close`([*self*](../../API/builtins/self.md)) {#close} Close a visible dialog. -### `show`([*self*](/API/builtins/self.md)) {#show} +### `show`([*self*](../../API/builtins/self.md)) {#show} Bring an already visible dialog to front and make it the key window. diff --git a/docs/API/renoise/renoise.Document.DocumentList.md b/docs/API/renoise/renoise.Document.DocumentList.md index f86e5b2..efd7e90 100644 --- a/docs/API/renoise/renoise.Document.DocumentList.md +++ b/docs/API/renoise/renoise.Document.DocumentList.md @@ -4,40 +4,40 @@ nodes in an observable list. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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/renoise.Document.DocumentNode.md)) {#find} -`->`[`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) +### `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`](#ListNotifierFunction)) {#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/renoise.Document.DocumentNode.md)) {#insert} -`->`[`renoise.Document.DocumentNode`](/API/renoise/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/renoise.Document.DocumentNode.md)[`?`](/API/builtins/nil.md) +### `property`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#property} +`->`[`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} +### `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`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#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. Trying to unregister a function or method which wasn't registered, will resolve into an error. -### `size`([*self*](/API/builtins/self.md)) {#size} -`->`[`integer`](/API/builtins/integer.md) +### `size`([*self*](../../API/builtins/self.md)) {#size} +`->`[`integer`](../../API/builtins/integer.md) Returns the number of entries of the list. -### `swap`([*self*](/API/builtins/self.md), pos1 : [`integer`](/API/builtins/integer.md), pos2 : [`integer`](/API/builtins/integer.md)) {#swap} +### `swap`([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) {#swap} 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. @@ -47,7 +47,7 @@ With a series of swaps you can move the item from/to any position. --- ## Aliases # alias ListElementAdded {#ListElementAdded} -{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } # alias ListElementChange {#ListElementChange} @@ -55,11 +55,11 @@ With a series of swaps you can move the item from/to any position. # alias ListElementRemoved {#ListElementRemoved} -{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } # alias ListElementsSwapped {#ListElementsSwapped} -{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` } +{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swapped"` } # alias ListNotifierFunction {#ListNotifierFunction} @@ -67,7 +67,7 @@ With a series of swaps you can move the item from/to any position. # alias ListNotifierMemberContext {#ListNotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.DocumentNode.md b/docs/API/renoise/renoise.Document.DocumentNode.md index 1a53068..01b8f71 100644 --- a/docs/API/renoise/renoise.Document.DocumentNode.md +++ b/docs/API/renoise/renoise.Document.DocumentNode.md @@ -4,29 +4,29 @@ documents or observables. --- ## Functions -### `__init`([*self*](/API/builtins/self.md)) {#__init} +### `__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`](#ObservableProperties)) {#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/renoise.Document.DocumentNode.md)) {#add_property} -`->`[`renoise.Document.DocumentNode`](/API/renoise/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. If you want to replace a property, remove it first, then add it again. -### `from_string`([*self*](/API/builtins/self.md), string : [`string`](/API/builtins/string.md)) {#from_string} -`->`success : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`string`](../../API/builtins/string.md)) {#from_string} +`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) Parse document tree from the given string data. See renoise.Document.DocumentNode:load_from for details about how properties are parsed and errors are handled. -### `has_property`([*self*](/API/builtins/self.md), property_name : [`string`](/API/builtins/string.md)) {#has_property} -`->`[`boolean`](/API/builtins/boolean.md) +### `has_property`([*self*](../../API/builtins/self.md), property_name : [`string`](../../API/builtins/string.md)) {#has_property} +`->`[`boolean`](../../API/builtins/boolean.md) Check if the given property exists. -### `load_from`([*self*](/API/builtins/self.md), file_name : [`string`](/API/builtins/string.md)) {#load_from} -`->`success : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `load_from`([*self*](../../API/builtins/self.md), file_name : [`string`](../../API/builtins/string.md)) {#load_from} +`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) Load the document tree from an XML file. This will NOT create new properties, except for list items, but will only assign existing property values in the @@ -38,23 +38,23 @@ data. 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`](#DocumentMember)[`?`](/API/builtins/nil.md) +### `property`([*self*](../../API/builtins/self.md), property_name : [`string`](../../API/builtins/string.md)) {#property} +`->`[`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`](#DocumentMember)) {#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 `my_document:remove_property(my_document["some_member"])` -### `save_as`([*self*](/API/builtins/self.md), file_name : [`string`](/API/builtins/string.md)) {#save_as} -`->`success : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `save_as`([*self*](../../API/builtins/self.md), file_name : [`string`](../../API/builtins/string.md)) {#save_as} +`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) Save the whole document tree to an XML file. Overwrites all contents of the file when it already exists. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize the whole document tree to a XML string. @@ -63,16 +63,16 @@ 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) +[`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) Track changes to document properties or general states by attaching listener functions to it. # 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)> +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)> # 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)`[]` +[`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/renoise/renoise.Document.Observable.md b/docs/API/renoise/renoise.Document.Observable.md index 6abae33..d1f12bd 100644 --- a/docs/API/renoise/renoise.Document.Observable.md +++ b/docs/API/renoise/renoise.Document.Observable.md @@ -4,7 +4,7 @@ functions to it. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#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. @@ -23,11 +23,11 @@ renoise.song().transport.bpm_observable:add_notifier({ end }) ``` -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#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. @@ -43,7 +43,7 @@ fun() # alias NotifierMemberContext {#NotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableBang.md b/docs/API/renoise/renoise.Document.ObservableBang.md index 75c040c..e39d73d 100644 --- a/docs/API/renoise/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`](#NotifierFunction)) {#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. @@ -22,13 +22,13 @@ renoise.song().transport.bpm_observable:add_notifier({ end }) ``` -### `bang`([*self*](/API/builtins/self.md)) {#bang} +### `bang`([*self*](../../API/builtins/self.md)) {#bang} fire a notification, calling all registered notifiers. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#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. @@ -44,7 +44,7 @@ fun() # alias NotifierMemberContext {#NotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableBoolean.md b/docs/API/renoise/renoise.Document.ObservableBoolean.md index ab87482..0133544 100644 --- a/docs/API/renoise/renoise.Document.ObservableBoolean.md +++ b/docs/API/renoise/renoise.Document.ObservableBoolean.md @@ -2,14 +2,14 @@ --- ## Properties -### value : [`boolean`](/API/builtins/boolean.md) {#value} +### value : [`boolean`](../../API/builtins/boolean.md) {#value} Read/write access to the value of an observable. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#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. @@ -28,23 +28,23 @@ renoise.song().transport.bpm_observable:add_notifier({ end }) ``` -### `from_string`([*self*](/API/builtins/self.md), string : [`any`](/API/builtins/any.md)) {#from_string} -`->`[`string`](/API/builtins/string.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) {#from_string} +`->`[`string`](../../API/builtins/string.md) Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#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. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize an object to a string. @@ -57,7 +57,7 @@ fun() # alias NotifierMemberContext {#NotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableBooleanList.md b/docs/API/renoise/renoise.Document.ObservableBooleanList.md index 357accf..97c8c52 100644 --- a/docs/API/renoise/renoise.Document.ObservableBooleanList.md +++ b/docs/API/renoise/renoise.Document.ObservableBooleanList.md @@ -3,50 +3,50 @@ A observable list of boolean values. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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. -### `find`([*self*](/API/builtins/self.md), start_pos : [`integer`](/API/builtins/integer.md), value : [`boolean`](/API/builtins/boolean.md)) {#find} -`->`[`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) +### `find`([*self*](../../API/builtins/self.md), start_pos : [`integer`](../../API/builtins/integer.md), value : [`boolean`](../../API/builtins/boolean.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. -### `from_string`([*self*](/API/builtins/self.md), string : [`any`](/API/builtins/any.md)) {#from_string} -`->`[`string`](/API/builtins/string.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) {#from_string} +`->`[`string`](../../API/builtins/string.md) Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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/renoise.Document.ObservableBoolean.md) +### `insert`([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md), value : [`boolean`](../../API/builtins/boolean.md)) {#insert} +`->`[`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/renoise.Document.ObservableBoolean.md)[`?`](/API/builtins/nil.md) +### `property`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#property} +`->`[`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} +### `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`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#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. Trying to unregister a function or method which wasn't registered, will resolve into an error. -### `size`([*self*](/API/builtins/self.md)) {#size} -`->`[`integer`](/API/builtins/integer.md) +### `size`([*self*](../../API/builtins/self.md)) {#size} +`->`[`integer`](../../API/builtins/integer.md) Returns the number of entries of the list. -### `swap`([*self*](/API/builtins/self.md), pos1 : [`integer`](/API/builtins/integer.md), pos2 : [`integer`](/API/builtins/integer.md)) {#swap} +### `swap`([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) {#swap} 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. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize an object to a string. @@ -55,7 +55,7 @@ Serialize an object to a string. --- ## Aliases # alias ListElementAdded {#ListElementAdded} -{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } # alias ListElementChange {#ListElementChange} @@ -63,11 +63,11 @@ Serialize an object to a string. # alias ListElementRemoved {#ListElementRemoved} -{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } # alias ListElementsSwapped {#ListElementsSwapped} -{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` } +{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swapped"` } # alias ListNotifierFunction {#ListNotifierFunction} @@ -75,7 +75,7 @@ Serialize an object to a string. # alias ListNotifierMemberContext {#ListNotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableList.md b/docs/API/renoise/renoise.Document.ObservableList.md index b8ea12f..49fcc23 100644 --- a/docs/API/renoise/renoise.Document.ObservableList.md +++ b/docs/API/renoise/renoise.Document.ObservableList.md @@ -5,20 +5,20 @@ to the lists **layout** (items got added, removed, swapped). --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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`](#ListNotifierFunction)) {#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`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#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. Trying to unregister a function or method which wasn't registered, will resolve into an error. -### `size`([*self*](/API/builtins/self.md)) {#size} -`->`[`integer`](/API/builtins/integer.md) +### `size`([*self*](../../API/builtins/self.md)) {#size} +`->`[`integer`](../../API/builtins/integer.md) Returns the number of entries of the list. @@ -27,7 +27,7 @@ Returns the number of entries of the list. --- ## Aliases # alias ListElementAdded {#ListElementAdded} -{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } # alias ListElementChange {#ListElementChange} @@ -35,11 +35,11 @@ Returns the number of entries of the list. # alias ListElementRemoved {#ListElementRemoved} -{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } # alias ListElementsSwapped {#ListElementsSwapped} -{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` } +{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swapped"` } # alias ListNotifierFunction {#ListNotifierFunction} @@ -47,7 +47,7 @@ Returns the number of entries of the list. # alias ListNotifierMemberContext {#ListNotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableNumber.md b/docs/API/renoise/renoise.Document.ObservableNumber.md index b33ba76..4a75a1d 100644 --- a/docs/API/renoise/renoise.Document.ObservableNumber.md +++ b/docs/API/renoise/renoise.Document.ObservableNumber.md @@ -2,14 +2,14 @@ --- ## Properties -### value : [`number`](/API/builtins/number.md) {#value} +### value : [`number`](../../API/builtins/number.md) {#value} Read/write access to the value of an Observable. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#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. @@ -28,23 +28,23 @@ renoise.song().transport.bpm_observable:add_notifier({ end }) ``` -### `from_string`([*self*](/API/builtins/self.md), string : [`any`](/API/builtins/any.md)) {#from_string} -`->`[`string`](/API/builtins/string.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) {#from_string} +`->`[`string`](../../API/builtins/string.md) Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#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. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize an object to a string. @@ -57,7 +57,7 @@ fun() # alias NotifierMemberContext {#NotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableNumberList.md b/docs/API/renoise/renoise.Document.ObservableNumberList.md index 5f35c97..3d2752c 100644 --- a/docs/API/renoise/renoise.Document.ObservableNumberList.md +++ b/docs/API/renoise/renoise.Document.ObservableNumberList.md @@ -3,49 +3,49 @@ A observable list of number values. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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. -### `find`([*self*](/API/builtins/self.md), start_pos : [`integer`](/API/builtins/integer.md), value : [`number`](/API/builtins/number.md)) {#find} -`->`[`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) +### `find`([*self*](../../API/builtins/self.md), start_pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.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. -### `from_string`([*self*](/API/builtins/self.md), string : [`any`](/API/builtins/any.md)) {#from_string} -`->`[`string`](/API/builtins/string.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) {#from_string} +`->`[`string`](../../API/builtins/string.md) Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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/renoise.Document.ObservableNumber.md) +### `insert`([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md)) {#insert} +`->`[`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/renoise.Document.ObservableNumber.md)[`?`](/API/builtins/nil.md) +### `property`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#property} +`->`[`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} +### `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`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#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. Trying to unregister a function or method which wasn't registered, will resolve into an error. -### `size`([*self*](/API/builtins/self.md)) {#size} -`->`[`integer`](/API/builtins/integer.md) +### `size`([*self*](../../API/builtins/self.md)) {#size} +`->`[`integer`](../../API/builtins/integer.md) Returns the number of entries of the list. -### `swap`([*self*](/API/builtins/self.md), pos1 : [`integer`](/API/builtins/integer.md), pos2 : [`integer`](/API/builtins/integer.md)) {#swap} +### `swap`([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) {#swap} 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. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize an object to a string. @@ -54,7 +54,7 @@ Serialize an object to a string. --- ## Aliases # alias ListElementAdded {#ListElementAdded} -{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } # alias ListElementChange {#ListElementChange} @@ -62,11 +62,11 @@ Serialize an object to a string. # alias ListElementRemoved {#ListElementRemoved} -{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } # alias ListElementsSwapped {#ListElementsSwapped} -{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` } +{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swapped"` } # alias ListNotifierFunction {#ListNotifierFunction} @@ -74,7 +74,7 @@ Serialize an object to a string. # alias ListNotifierMemberContext {#ListNotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableString.md b/docs/API/renoise/renoise.Document.ObservableString.md index 916d9ab..dc65662 100644 --- a/docs/API/renoise/renoise.Document.ObservableString.md +++ b/docs/API/renoise/renoise.Document.ObservableString.md @@ -2,14 +2,14 @@ --- ## Properties -### value : [`string`](/API/builtins/string.md) {#value} +### value : [`string`](../../API/builtins/string.md) {#value} Read/write access to the value of an Observable. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#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. @@ -28,23 +28,23 @@ renoise.song().transport.bpm_observable:add_notifier({ end }) ``` -### `from_string`([*self*](/API/builtins/self.md), string : [`any`](/API/builtins/any.md)) {#from_string} -`->`[`string`](/API/builtins/string.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) {#from_string} +`->`[`string`](../../API/builtins/string.md) Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#has_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) {#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. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize an object to a string. @@ -57,7 +57,7 @@ fun() # alias NotifierMemberContext {#NotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.ObservableStringList.md b/docs/API/renoise/renoise.Document.ObservableStringList.md index 25c0de9..a5edfb2 100644 --- a/docs/API/renoise/renoise.Document.ObservableStringList.md +++ b/docs/API/renoise/renoise.Document.ObservableStringList.md @@ -3,49 +3,49 @@ A observable list of number values. --- ## Functions -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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. -### `find`([*self*](/API/builtins/self.md), start_pos : [`integer`](/API/builtins/integer.md), value : [`number`](/API/builtins/number.md)) {#find} -`->`[`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) +### `find`([*self*](../../API/builtins/self.md), start_pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.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. -### `from_string`([*self*](/API/builtins/self.md), string : [`any`](/API/builtins/any.md)) {#from_string} -`->`[`string`](/API/builtins/string.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) {#from_string} +`->`[`string`](../../API/builtins/string.md) Assign the object's value from a string - when possible. Errors are silently ignored. -### `has_notifier`([*self*](/API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) {#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/renoise.Document.ObservableString.md) +### `insert`([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md)) {#insert} +`->`[`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/renoise.Document.ObservableString.md)[`?`](/API/builtins/nil.md) +### `property`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#property} +`->`[`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} +### `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`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) {#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. Trying to unregister a function or method which wasn't registered, will resolve into an error. -### `size`([*self*](/API/builtins/self.md)) {#size} -`->`[`integer`](/API/builtins/integer.md) +### `size`([*self*](../../API/builtins/self.md)) {#size} +`->`[`integer`](../../API/builtins/integer.md) Returns the number of entries of the list. -### `swap`([*self*](/API/builtins/self.md), pos1 : [`integer`](/API/builtins/integer.md), pos2 : [`integer`](/API/builtins/integer.md)) {#swap} +### `swap`([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) {#swap} 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. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize an object to a string. @@ -54,7 +54,7 @@ Serialize an object to a string. --- ## Aliases # alias ListElementAdded {#ListElementAdded} -{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } # alias ListElementChange {#ListElementChange} @@ -62,11 +62,11 @@ Serialize an object to a string. # alias ListElementRemoved {#ListElementRemoved} -{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } # alias ListElementsSwapped {#ListElementsSwapped} -{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` } +{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swapped"` } # alias ListNotifierFunction {#ListNotifierFunction} @@ -74,7 +74,7 @@ Serialize an object to a string. # alias ListNotifierMemberContext {#ListNotifierMemberContext} -[`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md) +[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) diff --git a/docs/API/renoise/renoise.Document.Serializable.md b/docs/API/renoise/renoise.Document.Serializable.md index fcf5fed..8d1da60 100644 --- a/docs/API/renoise/renoise.Document.Serializable.md +++ b/docs/API/renoise/renoise.Document.Serializable.md @@ -2,13 +2,13 @@ --- ## Functions -### `from_string`([*self*](/API/builtins/self.md), string : [`any`](/API/builtins/any.md)) {#from_string} -`->`[`string`](/API/builtins/string.md) +### `from_string`([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) {#from_string} +`->`[`string`](../../API/builtins/string.md) Assign the object's value from a string - when possible. Errors are silently ignored. -### `to_string`([*self*](/API/builtins/self.md)) {#to_string} -`->`[`string`](/API/builtins/string.md) +### `to_string`([*self*](../../API/builtins/self.md)) {#to_string} +`->`[`string`](../../API/builtins/string.md) Serialize an object to a string. diff --git a/docs/API/renoise/renoise.Document.md b/docs/API/renoise/renoise.Document.md index 0ab4981..64f7db7 100644 --- a/docs/API/renoise/renoise.Document.md +++ b/docs/API/renoise/renoise.Document.md @@ -68,8 +68,8 @@ my_document = MyDocument() --- ## Functions -### `create`(model_name : [`string`](/API/builtins/string.md)) {#create} -`->`(properties : [`ObservableProperties`](#ObservableProperties)) `->` [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) +### `create`(model_name : [`string`](../../API/builtins/string.md)) {#create} +`->`(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 @@ -108,8 +108,8 @@ create new instances. -- create a new instance of "MyDoc" my_other_document = renoise.Document.instantiate("MyDoc") ``` -### `instantiate`(model_name : [`string`](/API/builtins/string.md)) {#instantiate} -`->`[`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md) +### `instantiate`(model_name : [`string`](../../API/builtins/string.md)) {#instantiate} +`->`[`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. @@ -119,11 +119,11 @@ 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)> +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)> # 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)`[]` +[`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/renoise/renoise.EffectColumn.md b/docs/API/renoise/renoise.EffectColumn.md index db828ce..5873ba0 100644 --- a/docs/API/renoise/renoise.EffectColumn.md +++ b/docs/API/renoise/renoise.EffectColumn.md @@ -7,30 +7,30 @@ them in Renoise's pattern or phrase editor. --- ## Properties -### amount_string : [`string`](/API/builtins/string.md) {#amount_string} +### amount_string : [`string`](../../API/builtins/string.md) {#amount_string} Range: ('00' - 'FF') -### amount_value : [`integer`](/API/builtins/integer.md) {#amount_value} +### amount_value : [`integer`](../../API/builtins/integer.md) {#amount_value} Range: (0 - 255) -### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} +### is_empty : [`boolean`](../../API/builtins/boolean.md) {#is_empty} **READ-ONLY** True, when all effect column properties are empty. -### is_selected : [`boolean`](/API/builtins/boolean.md) {#is_selected} +### is_selected : [`boolean`](../../API/builtins/boolean.md) {#is_selected} **READ-ONLY** True, when this column is selected in the pattern or phrase editor. -### number_string : [`string`](/API/builtins/string.md) {#number_string} +### number_string : [`string`](../../API/builtins/string.md) {#number_string} Range: ('00' - 'ZZ') -### number_value : [`integer`](/API/builtins/integer.md) {#number_value} +### number_value : [`integer`](../../API/builtins/integer.md) {#number_value} 0-65535 in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 --- ## Functions -### `clear`([*self*](/API/builtins/self.md)) {#clear} +### `clear`([*self*](../../API/builtins/self.md)) {#clear} Clear the effect column. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.EffectColumn`](/API/renoise/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/renoise.GroupTrack.md b/docs/API/renoise/renoise.GroupTrack.md index b7e35f9..ab86792 100644 --- a/docs/API/renoise/renoise.GroupTrack.md +++ b/docs/API/renoise/renoise.GroupTrack.md @@ -6,16 +6,16 @@ Group track component of a Renoise song. ### available_device_infos : [`AudioDeviceInfo`](#audiodeviceinfo)`[]` {#available_device_infos} **READ-ONLY** Array of tables containing information about the devices. -### available_devices : [`string`](/API/builtins/string.md)`[]` {#available_devices} +### available_devices : [`string`](../../API/builtins/string.md)`[]` {#available_devices} **READ-ONLY** FX devices this track can handle. -### available_output_routings : [`string`](/API/builtins/string.md)`[]` {#available_output_routings} +### available_output_routings : [`string`](../../API/builtins/string.md)`[]` {#available_output_routings} **READ-ONLY** -### collapsed : [`boolean`](/API/builtins/boolean.md) {#collapsed} +### collapsed : [`boolean`](../../API/builtins/boolean.md) {#collapsed} Collapsed/expanded visual appearance. -### collapsed_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#collapsed_observable} +### collapsed_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#collapsed_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -25,129 +25,129 @@ 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 -### color_blend : [`integer`](/API/builtins/integer.md) {#color_blend} +### color_blend : [`integer`](../../API/builtins/integer.md) {#color_blend} Range: (0 - 100) Color blend in percent -### color_blend_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_blend_observable} +### color_blend_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#color_blend_observable} Track changes to document properties or general states by attaching listener functions to it. -### color_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_observable} +### color_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#color_observable} Track changes to document properties or general states by attaching listener functions to it. -### delay_column_visible : [`boolean`](/API/builtins/boolean.md) {#delay_column_visible} -### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} +### delay_column_visible : [`boolean`](../../API/builtins/boolean.md) {#delay_column_visible} +### delay_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### devices : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md)`[]` {#devices} +### devices : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md)`[]` {#devices} **READ-ONLY** List of audio DSP FX. -### devices_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#devices_observable} +### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#devices_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### group_collapsed : [`boolean`](/API/builtins/boolean.md) {#group_collapsed} +### group_collapsed : [`boolean`](../../API/builtins/boolean.md) {#group_collapsed} Collapsed/expanded visual appearance of whole group. -### group_parent : [`renoise.GroupTrack`](/API/renoise/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} +### max_effect_columns : [`integer`](../../API/builtins/integer.md) {#max_effect_columns} **READ-ONLY** 8 OR 0 depending on the track type -### max_note_columns : [`integer`](/API/builtins/integer.md) {#max_note_columns} +### 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/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. -### min_effect_columns : [`integer`](/API/builtins/integer.md) {#min_effect_columns} +### min_effect_columns : [`integer`](../../API/builtins/integer.md) {#min_effect_columns} **READ-ONLY** 1 OR 0 depending on the track type -### min_note_columns : [`integer`](/API/builtins/integer.md) {#min_note_columns} +### min_note_columns : [`integer`](../../API/builtins/integer.md) {#min_note_columns} **READ-ONLY** 1 OR 0 depending on the track type ### 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/renoise.Document.Observable.md) {#mute_state_observable} +### mute_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#mute_state_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} Name, as visible in track headers -### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### output_delay : [`number`](/API/builtins/number.md) {#output_delay} +### output_delay : [`number`](../../API/builtins/number.md) {#output_delay} Range: (-100.0-100.0) in ms -### output_delay_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_delay_observable} +### output_delay_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#output_delay_observable} Track changes to document properties or general states by attaching listener functions to it. -### output_routing : [`string`](/API/builtins/string.md) {#output_routing} +### output_routing : [`string`](../../API/builtins/string.md) {#output_routing} One of `available_output_routings` -### output_routing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_routing_observable} +### output_routing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#output_routing_observable} Track changes to document properties or general states by attaching listener functions to it. -### panning_column_visible : [`boolean`](/API/builtins/boolean.md) {#panning_column_visible} -### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} +### panning_column_visible : [`boolean`](../../API/builtins/boolean.md) {#panning_column_visible} +### panning_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### postfx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_panning} +### postfx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#postfx_panning} **READ-ONLY** -### postfx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_volume} +### postfx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#postfx_volume} **READ-ONLY** -### prefx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_panning} +### prefx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#prefx_panning} **READ-ONLY** -### prefx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_volume} +### prefx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#prefx_volume} **READ-ONLY** -### prefx_width : [`renoise.DeviceParameter`](/API/renoise/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/renoise.Document.Observable.md) {#sample_effects_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/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### solo_state : [`boolean`](/API/builtins/boolean.md) {#solo_state} -### solo_state_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#solo_state_observable} +### solo_state : [`boolean`](../../API/builtins/boolean.md) {#solo_state} +### solo_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#solo_state_observable} Track changes to document properties or general states by attaching listener functions to it. ### type : [`renoise.Track.TrackType`](renoise.Track.md#TrackType) {#type} **READ-ONLY** -### visible_effect_columns : [`integer`](/API/builtins/integer.md) {#visible_effect_columns} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### visible_note_columns : [`integer`](/API/builtins/integer.md) {#visible_note_columns} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### volume_column_visible : [`boolean`](/API/builtins/boolean.md) {#volume_column_visible} -### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} +### volume_column_visible : [`boolean`](../../API/builtins/boolean.md) {#volume_column_visible} +### volume_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -155,45 +155,45 @@ functions to it. --- ## Functions -### `column_is_muted`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_is_muted} -`->`[`boolean`](/API/builtins/boolean.md) +### `column_is_muted`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) {#column_is_muted} +`->`[`boolean`](../../API/builtins/boolean.md) 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/renoise.Document.Observable.md) +### `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/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) +### `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/renoise.Document.Observable.md) +### `column_name_observable`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) {#column_name_observable} +`->`[`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_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. -### `device`([*self*](/API/builtins/self.md), device_index : [`integer`](/API/builtins/integer.md)) {#device} -`->`[`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) +### `device`([*self*](../../API/builtins/self.md), device_index : [`integer`](../../API/builtins/integer.md)) {#device} +`->`[`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. -### `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/renoise.AudioDevice.md) +### `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/renoise.AudioDevice.md) Insert a new device at the given position. `device_path` must be one of `renoise.Track.available_devices`. -### `mute`([*self*](/API/builtins/self.md)) {#mute} +### `mute`([*self*](../../API/builtins/self.md)) {#mute} Uses default mute state from the prefs. Not for the master track. -### `set_column_is_muted`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md), muted : [`boolean`](/API/builtins/boolean.md)) {#set_column_is_muted} -### `set_column_name`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md), name : [`string`](/API/builtins/string.md)) {#set_column_name} -### `solo`([*self*](/API/builtins/self.md)) {#solo} -### `swap_devices_at`([*self*](/API/builtins/self.md), device_index1 : [`integer`](/API/builtins/integer.md), device_index2 : [`integer`](/API/builtins/integer.md)) {#swap_devices_at} +### `set_column_is_muted`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), muted : [`boolean`](../../API/builtins/boolean.md)) {#set_column_is_muted} +### `set_column_name`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), name : [`string`](../../API/builtins/string.md)) {#set_column_name} +### `solo`([*self*](../../API/builtins/self.md)) {#solo} +### `swap_devices_at`([*self*](../../API/builtins/self.md), device_index1 : [`integer`](../../API/builtins/integer.md), device_index2 : [`integer`](../../API/builtins/integer.md)) {#swap_devices_at} Swap the positions of two devices in the device chain. The mixer device at index 1 can not be swapped or moved. -### `swap_effect_columns_at`([*self*](/API/builtins/self.md), column_index1 : [`integer`](/API/builtins/integer.md), column_index2 : [`integer`](/API/builtins/integer.md)) {#swap_effect_columns_at} -### `swap_note_columns_at`([*self*](/API/builtins/self.md), column_index1 : [`integer`](/API/builtins/integer.md), column_index2 : [`integer`](/API/builtins/integer.md)) {#swap_note_columns_at} +### `swap_effect_columns_at`([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) {#swap_effect_columns_at} +### `swap_note_columns_at`([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) {#swap_note_columns_at} Swap the positions of two note or effect columns within a track. -### `unmute`([*self*](/API/builtins/self.md)) {#unmute} +### `unmute`([*self*](../../API/builtins/self.md)) {#unmute} @@ -204,22 +204,22 @@ Audio device info --- ## Properties -### favorite_name : [`string`](/API/builtins/string.md) {#favorite_name} +### favorite_name : [`string`](../../API/builtins/string.md) {#favorite_name} The device's name as displayed in favorites -### is_bridged : [`boolean`](/API/builtins/boolean.md) {#is_bridged} +### is_bridged : [`boolean`](../../API/builtins/boolean.md) {#is_bridged} true if the device is a bridged plugin -### is_favorite : [`boolean`](/API/builtins/boolean.md) {#is_favorite} +### is_favorite : [`boolean`](../../API/builtins/boolean.md) {#is_favorite} true if the device is a favorite -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The device's name -### path : [`string`](/API/builtins/string.md) {#path} +### path : [`string`](../../API/builtins/string.md) {#path} The device's path used by `renoise.Track:insert_device_at` -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} The device's name as displayed in shortened lists @@ -231,7 +231,7 @@ The device's name as displayed in shortened lists --- ## Aliases # alias RGBColor {#RGBColor} -{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +{ 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 diff --git a/docs/API/renoise/renoise.Instrument.md b/docs/API/renoise/renoise.Instrument.md index d47eb7e..af37a49 100644 --- a/docs/API/renoise/renoise.Instrument.md +++ b/docs/API/renoise/renoise.Instrument.md @@ -36,66 +36,66 @@ --- ## Properties -### MAX_NUMBER_OF_PHRASES : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_PHRASES} -### NUMBER_OF_MACROS : [`integer`](/API/builtins/integer.md) {#NUMBER_OF_MACROS} +### MAX_NUMBER_OF_PHRASES : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_PHRASES} +### NUMBER_OF_MACROS : [`integer`](../../API/builtins/integer.md) {#NUMBER_OF_MACROS} ### 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/renoise.Document.Observable.md) {#active_tab_observable} +### active_tab_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#active_tab_observable} Track changes to document properties or general states by attaching listener functions to it. -### channel_pressure_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) {#channel_pressure_macro} +### 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} +### 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/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/renoise.Document.Observable.md) {#comments_observable} +### comments_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#comments_observable} Track changes to document properties or general states by attaching listener functions to it. -### macros : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md)`[]` {#macros} +### 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} +### macros_visible : [`boolean`](../../API/builtins/boolean.md) {#macros_visible} Macro parameter pane visibility in the GUI. -### macros_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#macros_visible_observable} +### macros_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#macros_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### midi_input_properties : [`renoise.InstrumentMidiInputProperties`](/API/renoise/renoise.InstrumentMidiInputProperties.md) {#midi_input_properties} +### 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/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/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} +### name : [`string`](../../API/builtins/string.md) {#name} Instrument's name. -### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### phrase_editor_visible : [`boolean`](/API/builtins/boolean.md) {#phrase_editor_visible} +### 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/renoise.Document.Observable.md) {#phrase_editor_visible_observable} +### phrase_editor_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#phrase_editor_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### phrase_mappings : [`renoise.InstrumentPhraseMapping`](/API/renoise/renoise.InstrumentPhraseMapping.md)`[]` {#phrase_mappings} +### phrase_mappings : [`renoise.InstrumentPhraseMapping`](../../API/renoise/renoise.InstrumentPhraseMapping.md)`[]` {#phrase_mappings} **READ-ONLY** Phrase mappings. -### phrase_mappings_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#phrase_mappings_observable} +### phrase_mappings_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#phrase_mappings_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). @@ -103,35 +103,35 @@ to the lists **layout** (items got added, removed, swapped). ### phrase_playback_mode : [`renoise.Instrument.PhrasePlaybackMode`](renoise.Instrument.md#PhrasePlaybackMode) {#phrase_playback_mode} Phrase playback. -### phrase_playback_mode_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### phrase_program : [`integer`](/API/builtins/integer.md) {#phrase_program} +### 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/renoise.Document.Observable.md) {#phrase_program_observable} +### phrase_program_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#phrase_program_observable} Track changes to document properties or general states by attaching listener functions to it. -### phrases : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md)`[]` {#phrases} +### phrases : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md)`[]` {#phrases} **READ-ONLY** Phrases. -### phrases_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#phrases_observable} +### phrases_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#phrases_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### pitchbend_macro : [`renoise.InstrumentMacro`](/API/renoise/renoise.InstrumentMacro.md) {#pitchbend_macro} +### pitchbend_macro : [`renoise.InstrumentMacro`](../../API/renoise/renoise.InstrumentMacro.md) {#pitchbend_macro} Access the MIDI pitch-bend macro -### plugin_properties : [`renoise.InstrumentPluginProperties`](/API/renoise/renoise.InstrumentPluginProperties.md) {#plugin_properties} +### plugin_properties : [`renoise.InstrumentPluginProperties`](../../API/renoise/renoise.InstrumentPluginProperties.md) {#plugin_properties} **READ-ONLY** Plugin properties. -### sample_device_chains : [`renoise.SampleDeviceChain`](/API/renoise/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/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} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). @@ -139,59 +139,59 @@ to the lists **layout** (items got added, removed, swapped). ### 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/renoise.Document.Observable.md) {#sample_mapping_overlap_mode_observable} +### sample_mapping_overlap_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#sample_mapping_overlap_mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### sample_mappings : [`renoise.SampleMapping`](/API/renoise/renoise.SampleMapping.md)`[]` {#sample_mappings} +### 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/renoise.Document.ObservableList.md) {#sample_mappings_observable} +### sample_mappings_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#sample_mappings_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### sample_modulation_sets : [`renoise.SampleModulationSet`](/API/renoise/renoise.SampleModulationSet.md)`[]` {#sample_modulation_sets} +### 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/renoise.Document.ObservableList.md) {#sample_modulation_sets_observable} +### sample_modulation_sets_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#sample_modulation_sets_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### samples : [`renoise.Sample`](/API/renoise/renoise.Sample.md)`[]` {#samples} +### samples : [`renoise.Sample`](../../API/renoise/renoise.Sample.md)`[]` {#samples} **READ-ONLY** Samples slots. -### samples_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#samples_observable} +### samples_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#samples_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### show_comments_after_loading : [`boolean`](/API/builtins/boolean.md) {#show_comments_after_loading} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### transpose : [`integer`](/API/builtins/integer.md) {#transpose} +### 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/renoise.Document.Observable.md) {#transpose_observable} +### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#transpose_observable} Track changes to document properties or general states by attaching listener functions to it. -### trigger_options : [`renoise.InstrumentTriggerOptions`](/API/renoise/renoise.InstrumentTriggerOptions.md) {#trigger_options} +### 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} +### volume : [`number`](../../API/builtins/number.md) {#volume} Range: (0 - math.db2lin(6)) -### volume_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_observable} +### volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#volume_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -199,8 +199,8 @@ functions to it. --- ## Functions -### `can_insert_phrase_mapping_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#can_insert_phrase_mapping_at} -`->`[`boolean`](/API/builtins/boolean.md) +### `can_insert_phrase_mapping_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#can_insert_phrase_mapping_at} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true if a new phrase mapping can be inserted at the given phrase mapping index (see See renoise.song().instruments[].phrase_mappings). @@ -209,86 +209,86 @@ Phrase note mappings may not overlap and are sorted by note, so there can be max 119 phrases per instrument when each phrase is mapped to 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} +### `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/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_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. -### `delete_phrase_mapping_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_phrase_mapping_at} +### `delete_phrase_mapping_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#delete_phrase_mapping_at} Delete a new phrase mapping at the given phrase mapping index. -### `delete_sample_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_sample_at} +### `delete_sample_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#delete_sample_at} Delete an existing sample. -### `delete_sample_device_chain_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_sample_device_chain_at} +### `delete_sample_device_chain_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#delete_sample_device_chain_at} 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_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/renoise.InstrumentPhrase.md) +### `insert_phrase_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#insert_phrase_at} +`->`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/renoise.InstrumentPhrase.md)) {#insert_phrase_mapping_at} -`->`new_mapping : [`renoise.InstrumentPhraseMapping`](/API/renoise/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/renoise.Sample.md) +### `insert_sample_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#insert_sample_at} +`->`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/renoise.SampleDeviceChain.md) +### `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/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/renoise.SampleModulationSet.md) +### `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/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/renoise.InstrumentMacro.md) +### `macro`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#macro} +`->`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/renoise.InstrumentPhrase.md) +### `phrase`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#phrase} +`->`[`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/renoise.InstrumentPhraseMapping.md) +### `phrase_mapping`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#phrase_mapping} +`->`[`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/renoise.Sample.md) +### `sample`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#sample} +`->`[`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/renoise.SampleDeviceChain.md) +### `sample_device_chain`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#sample_device_chain} +`->`[`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/renoise.SampleMapping.md) +### `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/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/renoise.SampleModulationSet.md) +### `sample_modulation_set`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#sample_modulation_set} +`->`[`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. -### `swap_sample_device_chains_at`([*self*](/API/builtins/self.md), index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md)) {#swap_sample_device_chains_at} +### `swap_sample_device_chains_at`([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) {#swap_sample_device_chains_at} Swap positions of two sample device chains. -### `swap_sample_modulation_sets_at`([*self*](/API/builtins/self.md), index1 : [`any`](/API/builtins/any.md), index2 : [`any`](/API/builtins/any.md)) {#swap_sample_modulation_sets_at} +### `swap_sample_modulation_sets_at`([*self*](../../API/builtins/self.md), index1 : [`any`](../../API/builtins/any.md), index2 : [`any`](../../API/builtins/any.md)) {#swap_sample_modulation_sets_at} Swap positions of two modulation sets. -### `swap_samples_at`([*self*](/API/builtins/self.md), index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md)) {#swap_samples_at} +### `swap_samples_at`([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) {#swap_samples_at} Swap positions of two samples. diff --git a/docs/API/renoise/renoise.InstrumentDevice.md b/docs/API/renoise/renoise.InstrumentDevice.md index 7360d77..fdd763c 100644 --- a/docs/API/renoise/renoise.InstrumentDevice.md +++ b/docs/API/renoise/renoise.InstrumentDevice.md @@ -2,51 +2,51 @@ --- ## Properties -### active_preset : [`integer`](/API/builtins/integer.md) {#active_preset} +### active_preset : [`integer`](../../API/builtins/integer.md) {#active_preset} Preset handling. 0 when when none is active (or available) -### active_preset_data : [`string`](/API/builtins/string.md) {#active_preset_data} +### 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/renoise.Document.Observable.md) {#active_preset_observable} +### active_preset_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#active_preset_observable} Track changes to document properties or general states by attaching listener functions to it. -### device_path : [`string`](/API/builtins/string.md) {#device_path} +### 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() -### external_editor_available : [`boolean`](/API/builtins/boolean.md) {#external_editor_available} +### external_editor_available : [`boolean`](../../API/builtins/boolean.md) {#external_editor_available} **READ-ONLY** Returns whether or not the plugin provides its own custom GUI. -### external_editor_visible : [`boolean`](/API/builtins/boolean.md) {#external_editor_visible} +### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) {#external_editor_visible} When the plugin has no custom GUI, Renoise will create a dummy editor for it which lists the plugin parameters. set to true to show the editor, false to close it -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} **READ-ONLY** Device name. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### presets : [`string`](/API/builtins/string.md)`[]` {#presets} +### presets : [`string`](../../API/builtins/string.md)`[]` {#presets} **READ-ONLY** -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** --- ## Functions -### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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. -### `preset`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#preset} -`->`[`string`](/API/builtins/string.md) +### `preset`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#preset} +`->`[`string`](../../API/builtins/string.md) Access to a single preset name by index. Use properties 'presets' to iterate over all presets and to query the presets count. diff --git a/docs/API/renoise/renoise.InstrumentMacro.md b/docs/API/renoise/renoise.InstrumentMacro.md index b1d6b1e..880bc01 100644 --- a/docs/API/renoise/renoise.InstrumentMacro.md +++ b/docs/API/renoise/renoise.InstrumentMacro.md @@ -2,32 +2,32 @@ --- ## Properties -### mappings : [`renoise.InstrumentMacroMapping`](/API/renoise/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/renoise.Document.ObservableList.md) {#mappings_observable} +### mappings_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#mappings_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### value : [`number`](/API/builtins/number.md) {#value} +### value : [`number`](../../API/builtins/number.md) {#value} Range: (0 - 1) -### value_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#value_observable} +### value_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#value_observable} Track changes to document properties or general states by attaching listener functions to it. -### value_string : [`string`](/API/builtins/string.md) {#value_string} +### value_string : [`string`](../../API/builtins/string.md) {#value_string} Range: (0 - 100) -### value_string_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#value_string_observable} +### value_string_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#value_string_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -35,8 +35,8 @@ functions to it. --- ## Functions -### `mapping`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#mapping} -`->`[`renoise.InstrumentMacroMapping`](/API/renoise/renoise.InstrumentMacroMapping.md) +### `mapping`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#mapping} +`->`[`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/renoise.InstrumentMacroMapping.md b/docs/API/renoise/renoise.InstrumentMacroMapping.md index 2afaf05..89be495 100644 --- a/docs/API/renoise/renoise.InstrumentMacroMapping.md +++ b/docs/API/renoise/renoise.InstrumentMacroMapping.md @@ -14,28 +14,28 @@ --- ## Properties -### parameter : [`renoise.DeviceParameter`](/API/renoise/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} +### parameter_max : [`number`](../../API/builtins/number.md) {#parameter_max} Range: (0 - 1) -### parameter_max_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#parameter_max_observable} +### parameter_max_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#parameter_max_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameter_min : [`number`](/API/builtins/number.md) {#parameter_min} +### parameter_min : [`number`](../../API/builtins/number.md) {#parameter_min} Range: (0 - 1) -### parameter_min_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#parameter_min_observable} +### parameter_min_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#parameter_min_observable} Track changes to document properties or general states by attaching listener functions to it. ### 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/renoise.Document.Observable.md) {#parameter_scaling_observable} +### parameter_scaling_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#parameter_scaling_observable} Track changes to document properties or general states by attaching listener functions to it. diff --git a/docs/API/renoise/renoise.InstrumentMidiInputProperties.md b/docs/API/renoise/renoise.InstrumentMidiInputProperties.md index 49b6f89..2bbf30a 100644 --- a/docs/API/renoise/renoise.InstrumentMidiInputProperties.md +++ b/docs/API/renoise/renoise.InstrumentMidiInputProperties.md @@ -2,34 +2,34 @@ --- ## Properties -### assigned_track : [`integer`](/API/builtins/integer.md) {#assigned_track} +### 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/renoise.Document.Observable.md) {#assigned_track_observable} +### assigned_track_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#assigned_track_observable} Track changes to document properties or general states by attaching listener functions to it. -### channel : [`integer`](/API/builtins/integer.md) {#channel} +### channel : [`integer`](../../API/builtins/integer.md) {#channel} Range: (1 - 16) 0 = Omni -### channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#channel_observable} +### channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#channel_observable} Track changes to document properties or general states by attaching listener functions to it. -### device_name : [`string`](/API/builtins/string.md) {#device_name} +### 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/renoise.Document.Observable.md) {#device_name_observable} +### device_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#device_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### note_range : [`integer`](/API/builtins/integer.md)`[]` {#note_range} +### 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/renoise.Document.Observable.md) {#note_range_observable} +### note_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#note_range_observable} Track changes to document properties or general states by attaching listener functions to it. diff --git a/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md b/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md index 4ff6077..b747b9d 100644 --- a/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md +++ b/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md @@ -12,41 +12,41 @@ --- ## Properties -### bank : [`integer`](/API/builtins/integer.md) {#bank} +### bank : [`integer`](../../API/builtins/integer.md) {#bank} Range: (1 - 65536) 0 = OFF -### bank_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bank_observable} +### bank_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bank_observable} Track changes to document properties or general states by attaching listener functions to it. -### channel : [`integer`](/API/builtins/integer.md) {#channel} +### channel : [`integer`](../../API/builtins/integer.md) {#channel} Range: (1 - 16) -### channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#channel_observable} +### channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#channel_observable} Track changes to document properties or general states by attaching listener functions to it. -### delay : [`integer`](/API/builtins/integer.md) {#delay} +### delay : [`integer`](../../API/builtins/integer.md) {#delay} Range: (0 - 100) -### delay_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_observable} +### delay_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#delay_observable} Track changes to document properties or general states by attaching listener functions to it. -### device_name : [`string`](/API/builtins/string.md) {#device_name} +### 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/renoise.Document.Observable.md) {#device_name_observable} +### device_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#device_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### duration : [`integer`](/API/builtins/integer.md) {#duration} +### duration : [`integer`](../../API/builtins/integer.md) {#duration} Range: (1 - 8000) 8000 = INF -### duration_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#duration_observable} +### duration_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#duration_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -56,21 +56,21 @@ functions to it. 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/renoise.Document.Observable.md) {#instrument_type_observable} +### instrument_type_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#instrument_type_observable} Track changes to document properties or general states by attaching listener functions to it. -### program : [`integer`](/API/builtins/integer.md) {#program} +### program : [`integer`](../../API/builtins/integer.md) {#program} Range: (1 - 128) 0 = OFF -### program_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#program_observable} +### program_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#program_observable} Track changes to document properties or general states by attaching listener functions to it. -### transpose : [`integer`](/API/builtins/integer.md) {#transpose} +### transpose : [`integer`](../../API/builtins/integer.md) {#transpose} Range: (-120 - 120) -### transpose_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#transpose_observable} +### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#transpose_observable} Track changes to document properties or general states by attaching listener functions to it. diff --git a/docs/API/renoise/renoise.InstrumentPhrase.md b/docs/API/renoise/renoise.InstrumentPhrase.md index 8f84681..46eb95b 100644 --- a/docs/API/renoise/renoise.InstrumentPhrase.md +++ b/docs/API/renoise/renoise.InstrumentPhrase.md @@ -15,149 +15,149 @@ not instruments, but samples are addressed/triggered in phrases. --- ## Properties -### MAX_NUMBER_OF_EFFECT_COLUMNS : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_EFFECT_COLUMNS} -### MAX_NUMBER_OF_LINES : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_LINES} +### MAX_NUMBER_OF_EFFECT_COLUMNS : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_EFFECT_COLUMNS} +### MAX_NUMBER_OF_LINES : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_LINES} Maximum number of lines that can be present in a phrase. -### MAX_NUMBER_OF_NOTE_COLUMNS : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_NOTE_COLUMNS} -### MIN_NUMBER_OF_EFFECT_COLUMNS : [`integer`](/API/builtins/integer.md) {#MIN_NUMBER_OF_EFFECT_COLUMNS} +### MAX_NUMBER_OF_NOTE_COLUMNS : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_NOTE_COLUMNS} +### MIN_NUMBER_OF_EFFECT_COLUMNS : [`integer`](../../API/builtins/integer.md) {#MIN_NUMBER_OF_EFFECT_COLUMNS} Min/Maximum number of effect columns that can be present in a phrase. -### MIN_NUMBER_OF_NOTE_COLUMNS : [`integer`](/API/builtins/integer.md) {#MIN_NUMBER_OF_NOTE_COLUMNS} +### MIN_NUMBER_OF_NOTE_COLUMNS : [`integer`](../../API/builtins/integer.md) {#MIN_NUMBER_OF_NOTE_COLUMNS} Min/Maximum number of note columns that can be present in a phrase. -### autoseek : [`boolean`](/API/builtins/boolean.md) {#autoseek} +### autoseek : [`boolean`](../../API/builtins/boolean.md) {#autoseek} Phrase autoseek settings -### autoseek_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#autoseek_observable} +### autoseek_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#autoseek_observable} Track changes to document properties or general states by attaching listener functions to it. -### base_note : [`integer`](/API/builtins/integer.md) {#base_note} +### 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/renoise.Document.Observable.md) {#base_note_observable} +### base_note_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#base_note_observable} Track changes to document properties or general states by attaching listener functions to it. -### delay_column_visible : [`boolean`](/API/builtins/boolean.md) {#delay_column_visible} -### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} +### delay_column_visible : [`boolean`](../../API/builtins/boolean.md) {#delay_column_visible} +### delay_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### instrument_column_visible : [`boolean`](/API/builtins/boolean.md) {#instrument_column_visible} +### instrument_column_visible : [`boolean`](../../API/builtins/boolean.md) {#instrument_column_visible} Column visibility. -### instrument_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} +### 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/renoise.Document.Observable.md) {#is_empty_observable} +### is_empty_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_empty_observable} Track changes to document properties or general states by attaching listener functions to it. ### key_tracking : [`renoise.InstrumentPhrase.KeyTrackingMode`](renoise.InstrumentPhrase.md#KeyTrackingMode) {#key_tracking} Phrase's key-tracking mode. -### key_tracking_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#key_tracking_observable} +### key_tracking_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#key_tracking_observable} Track changes to document properties or general states by attaching listener functions to it. -### lines : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)`[]` {#lines} +### 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} +### 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/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_end_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} +### 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/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_start_observable} Track changes to document properties or general states by attaching listener functions to it. -### looping : [`boolean`](/API/builtins/boolean.md) {#looping} +### looping : [`boolean`](../../API/builtins/boolean.md) {#looping} Loop mode. The phrase plays as one-shot when disabled. -### looping_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#looping_observable} +### looping_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#looping_observable} Track changes to document properties or general states by attaching listener functions to it. -### lpb : [`integer`](/API/builtins/integer.md) {#lpb} +### 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/renoise.Document.Observable.md) {#lpb_observable} +### lpb_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#lpb_observable} Track changes to document properties or general states by attaching listener functions to it. -### mapping : [`renoise.InstrumentPhraseMapping`](/API/renoise/renoise.InstrumentPhraseMapping.md) {#mapping} +### 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 : [`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/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### number_of_lines : [`integer`](/API/builtins/integer.md) {#number_of_lines} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### panning_column_visible : [`boolean`](/API/builtins/boolean.md) {#panning_column_visible} -### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} +### panning_column_visible : [`boolean`](../../API/builtins/boolean.md) {#panning_column_visible} +### panning_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### sample_effects_column_visible : [`boolean`](/API/builtins/boolean.md) {#sample_effects_column_visible} -### sample_effects_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sample_effects_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/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### shuffle : [`number`](/API/builtins/number.md) {#shuffle} +### 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/renoise.Document.Observable.md) {#shuffle_observable} +### shuffle_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#shuffle_observable} Track changes to document properties or general states by attaching listener functions to it. -### visible_effect_columns : [`integer`](/API/builtins/integer.md) {#visible_effect_columns} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### visible_note_columns : [`integer`](/API/builtins/integer.md) {#visible_note_columns} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### volume_column_visible : [`boolean`](/API/builtins/boolean.md) {#volume_column_visible} -### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} +### volume_column_visible : [`boolean`](../../API/builtins/boolean.md) {#volume_column_visible} +### volume_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -165,56 +165,56 @@ functions to it. --- ## Functions -### `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} +### `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} -`->`[`boolean`](/API/builtins/boolean.md) +### `column_is_muted`([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md)) {#column_is_muted} +`->`[`boolean`](../../API/builtins/boolean.md) 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/renoise.Document.Observable.md) +### `column_is_muted_observable`([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md)) {#column_is_muted_observable} +`->`[`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) +### `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/renoise.Document.Observable.md) +### `column_name_observable`([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md)) {#column_name_observable} +`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -### `copy_from`([*self*](/API/builtins/self.md), phrase : [`renoise.InstrumentPhrase`](/API/renoise/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`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_edited_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#PhraseLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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](file:///c%3A/Users/emuell/Development/Renoise-XRNX/definitions/library/renoise/song/pattern.lua#85#9) for more details. -### `line`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#line} -`->`[`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md) +### `line`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#line} +`->`[`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/renoise.PatternLine.md)`[]` +### `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/renoise.PatternLine.md)`[]` Get a specific line range -### `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} +### `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} 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_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. @@ -226,7 +226,7 @@ Line iterator position. --- ## Properties -### line : [`integer`](/API/builtins/integer.md) {#line} +### line : [`integer`](../../API/builtins/integer.md) {#line} @@ -236,7 +236,7 @@ Line iterator position. --- ## Aliases # alias PhraseLineChangeCallbackWithContext {#PhraseLineChangeCallbackWithContext} -(obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md), pos : [`PhraseLinePosition`](#phraselineposition)) +(obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md), pos : [`PhraseLinePosition`](#phraselineposition)) diff --git a/docs/API/renoise/renoise.InstrumentPhraseMapping.md b/docs/API/renoise/renoise.InstrumentPhraseMapping.md index 7394211..a749a19 100644 --- a/docs/API/renoise/renoise.InstrumentPhraseMapping.md +++ b/docs/API/renoise/renoise.InstrumentPhraseMapping.md @@ -12,45 +12,45 @@ --- ## Properties -### base_note : [`integer`](/API/builtins/integer.md) {#base_note} +### 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/renoise.Document.Observable.md) {#base_note_observable} +### base_note_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#base_note_observable} Track changes to document properties or general states by attaching listener functions to it. ### key_tracking : [`renoise.InstrumentPhraseMapping.KeyTrackingMode`](renoise.InstrumentPhraseMapping.md#KeyTrackingMode) {#key_tracking} Phrase's key-tracking mode. -### key_tracking_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#key_tracking_observable} +### key_tracking_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#key_tracking_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_end : [`integer`](/API/builtins/integer.md) {#loop_end} -### loop_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end : [`integer`](../../API/builtins/integer.md) {#loop_end} +### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_end_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} -### loop_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start : [`integer`](../../API/builtins/integer.md) {#loop_start} +### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_start_observable} Track changes to document properties or general states by attaching listener functions to it. -### looping : [`boolean`](/API/builtins/boolean.md) {#looping} +### looping : [`boolean`](../../API/builtins/boolean.md) {#looping} Loop mode. The phrase plays as one-shot when disabled. -### looping_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#looping_observable} +### looping_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#looping_observable} Track changes to document properties or general states by attaching listener functions to it. -### note_range : [`integer`](/API/builtins/integer.md)`[]` {#note_range} +### 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/renoise.Document.Observable.md) {#note_range_observable} +### note_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#note_range_observable} Track changes to document properties or general states by attaching listener functions to it. -### phrase : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md) {#phrase} +### phrase : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md) {#phrase} Linked phrase. diff --git a/docs/API/renoise/renoise.InstrumentPluginDevice.md b/docs/API/renoise/renoise.InstrumentPluginDevice.md index 3e2d198..6c09d1b 100644 --- a/docs/API/renoise/renoise.InstrumentPluginDevice.md +++ b/docs/API/renoise/renoise.InstrumentPluginDevice.md @@ -2,51 +2,51 @@ --- ## Properties -### active_preset : [`integer`](/API/builtins/integer.md) {#active_preset} +### active_preset : [`integer`](../../API/builtins/integer.md) {#active_preset} Preset handling. 0 when when none is active (or available) -### active_preset_data : [`string`](/API/builtins/string.md) {#active_preset_data} +### 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/renoise.Document.Observable.md) {#active_preset_observable} +### active_preset_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#active_preset_observable} Track changes to document properties or general states by attaching listener functions to it. -### device_path : [`string`](/API/builtins/string.md) {#device_path} +### 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() -### external_editor_available : [`boolean`](/API/builtins/boolean.md) {#external_editor_available} +### external_editor_available : [`boolean`](../../API/builtins/boolean.md) {#external_editor_available} **READ-ONLY** Returns whether or not the plugin provides its own custom GUI. -### external_editor_visible : [`boolean`](/API/builtins/boolean.md) {#external_editor_visible} +### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) {#external_editor_visible} When the plugin has no custom GUI, Renoise will create a dummy editor for it which lists the plugin parameters. set to true to show the editor, false to close it -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} **READ-ONLY** Device name. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### presets : [`string`](/API/builtins/string.md)`[]` {#presets} +### presets : [`string`](../../API/builtins/string.md)`[]` {#presets} **READ-ONLY** -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** --- ## Functions -### `parameter`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#parameter} -`->`[`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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. -### `preset`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#preset} -`->`[`string`](/API/builtins/string.md) +### `preset`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#preset} +`->`[`string`](../../API/builtins/string.md) Access to a single preset name by index. Use properties 'presets' to iterate over all presets and to query the presets count. diff --git a/docs/API/renoise/renoise.InstrumentPluginProperties.md b/docs/API/renoise/renoise.InstrumentPluginProperties.md index ca59960..133a917 100644 --- a/docs/API/renoise/renoise.InstrumentPluginProperties.md +++ b/docs/API/renoise/renoise.InstrumentPluginProperties.md @@ -2,83 +2,83 @@ --- ## Properties -### alias_fx_device_index : [`integer`](/API/builtins/integer.md) {#alias_fx_device_index} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### alias_fx_track_index : [`integer`](/API/builtins/integer.md) {#alias_fx_track_index} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### alias_instrument_index : [`integer`](/API/builtins/integer.md) {#alias_instrument_index} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### auto_suspend : [`boolean`](/API/builtins/boolean.md) {#auto_suspend} +### auto_suspend : [`boolean`](../../API/builtins/boolean.md) {#auto_suspend} Valid for loaded and unloaded plugins. -### auto_suspend_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#auto_suspend_observable} +### auto_suspend_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#auto_suspend_observable} Track changes to document properties or general states by attaching listener functions to it. ### available_plugin_infos : [`PluginInfo`](#plugininfo)`[]` {#available_plugin_infos} **READ-ONLY** Returns a list of tables containing more information about the plugins. -### available_plugins : [`string`](/API/builtins/string.md)`[]` {#available_plugins} +### available_plugins : [`string`](../../API/builtins/string.md)`[]` {#available_plugins} **READ-ONLY** List of all currently available plugins. This is a list of unique plugin names which also contains the plugin's type (VST/AU/DSSI/...), not including the vendor names as visible in Renoise's GUI. So its an identifier, and not the name as visible in the GUI. When no plugin is loaded, the identifier is an empty string. -### channel : [`integer`](/API/builtins/integer.md) {#channel} +### channel : [`integer`](../../API/builtins/integer.md) {#channel} Range: (1 - 16) -### channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#channel_observable} +### channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#channel_observable} Track changes to document properties or general states by attaching listener functions to it. -### midi_output_routing_index : [`integer`](/API/builtins/integer.md) {#midi_output_routing_index} +### 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/renoise.Document.Observable.md) {#midi_output_routing_index_observable} +### midi_output_routing_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#midi_output_routing_index_observable} Track changes to document properties or general states by attaching listener functions to it. -### plugin_device : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) | [`renoise.InstrumentPluginDevice`](/API/renoise/renoise.InstrumentPluginDevice.md) {#plugin_device} +### 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/renoise.Document.Observable.md) {#plugin_device_observable} +### plugin_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#plugin_device_observable} Track changes to document properties or general states by attaching listener functions to it. -### plugin_loaded : [`boolean`](/API/builtins/boolean.md) {#plugin_loaded} +### 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} +### transpose : [`integer`](../../API/builtins/integer.md) {#transpose} Range: (-120 - 120) -### transpose_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#transpose_observable} +### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#transpose_observable} Track changes to document properties or general states by attaching listener functions to it. -### volume : [`number`](/API/builtins/number.md) {#volume} +### volume : [`number`](../../API/builtins/number.md) {#volume} Range: (0.0 - 4.0) linear gain -### volume_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_observable} +### volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#volume_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -92,22 +92,22 @@ functions to it. --- ## Properties -### favorite_name : [`string`](/API/builtins/string.md) {#favorite_name} +### favorite_name : [`string`](../../API/builtins/string.md) {#favorite_name} The plugin's name as displayed in favorites -### is_bridged : [`string`](/API/builtins/string.md) {#is_bridged} +### is_bridged : [`string`](../../API/builtins/string.md) {#is_bridged} true if the plugin is a bridged plugin -### is_favorite : [`string`](/API/builtins/string.md) {#is_favorite} +### is_favorite : [`string`](../../API/builtins/string.md) {#is_favorite} true if the plugin is a favorite -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The plugin's name -### path : [`string`](/API/builtins/string.md) {#path} +### path : [`string`](../../API/builtins/string.md) {#path} The plugin's path used by load_plugin() -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} The plugin's name as displayed in shortened lists diff --git a/docs/API/renoise/renoise.InstrumentTriggerOptions.md b/docs/API/renoise/renoise.InstrumentTriggerOptions.md index cebeb12..71162c3 100644 --- a/docs/API/renoise/renoise.InstrumentTriggerOptions.md +++ b/docs/API/renoise/renoise.InstrumentTriggerOptions.md @@ -13,41 +13,41 @@ --- ## Properties -### available_scale_modes : [`string`](/API/builtins/string.md)`[]` {#available_scale_modes} +### available_scale_modes : [`string`](../../API/builtins/string.md)`[]` {#available_scale_modes} **READ-ONLY** List of all available scale modes. -### monophonic : [`boolean`](/API/builtins/boolean.md) {#monophonic} +### monophonic : [`boolean`](../../API/builtins/boolean.md) {#monophonic} Mono/Poly mode. -### monophonic_glide : [`integer`](/API/builtins/integer.md) {#monophonic_glide} +### 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/renoise.Document.Observable.md) {#monophonic_glide_observable} +### monophonic_glide_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#monophonic_glide_observable} Track changes to document properties or general states by attaching listener functions to it. -### monophonic_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#monophonic_observable} +### monophonic_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#monophonic_observable} Track changes to document properties or general states by attaching listener functions to it. ### quantize : [`renoise.InstrumentTriggerOptions.QuantizeMode`](renoise.InstrumentTriggerOptions.md#QuantizeMode) {#quantize} Trigger quantization mode. -### quantize_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#quantize_observable} +### quantize_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#quantize_observable} Track changes to document properties or general states by attaching listener functions to it. -### scale_key : [`integer`](/API/builtins/integer.md) {#scale_key} +### 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/renoise.Document.Observable.md) {#scale_key_observable} +### scale_key_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#scale_key_observable} Track changes to document properties or general states by attaching listener functions to it. -### scale_mode : [`string`](/API/builtins/string.md) {#scale_mode} +### scale_mode : [`string`](../../API/builtins/string.md) {#scale_mode} one of 'available_scales'] -### scale_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#scale_mode_observable} +### scale_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#scale_mode_observable} Track changes to document properties or general states by attaching listener functions to it. diff --git a/docs/API/renoise/renoise.Midi.MidiDevice.md b/docs/API/renoise/renoise.Midi.MidiDevice.md index 635cae4..39ca11e 100644 --- a/docs/API/renoise/renoise.Midi.MidiDevice.md +++ b/docs/API/renoise/renoise.Midi.MidiDevice.md @@ -4,12 +4,12 @@ input and output devices. --- ## Properties -### is_open : [`boolean`](/API/builtins/boolean.md) {#is_open} +### is_open : [`boolean`](../../API/builtins/boolean.md) {#is_open} Returns true while the device is open (ready to send or receive messages). Your device refs will never be auto-closed, "is_open" will only be false if you explicitly call "midi_device:close()" to release a device. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The name of a device. This is the name you create a device with via `renoise.Midi.create_input_device` or `renoise.Midi.create_output_device`. diff --git a/docs/API/renoise/renoise.Midi.MidiInputDevice.md b/docs/API/renoise/renoise.Midi.MidiInputDevice.md index d8f6f4f..e38e046 100644 --- a/docs/API/renoise/renoise.Midi.MidiInputDevice.md +++ b/docs/API/renoise/renoise.Midi.MidiInputDevice.md @@ -4,12 +4,12 @@ Instances are created via `renoise.Midi.create_input_device` --- ## Properties -### is_open : [`boolean`](/API/builtins/boolean.md) {#is_open} +### is_open : [`boolean`](../../API/builtins/boolean.md) {#is_open} Returns true while the device is open (ready to send or receive messages). Your device refs will never be auto-closed, "is_open" will only be false if you explicitly call "midi_device:close()" to release a device. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The name of a device. This is the name you create a device with via `renoise.Midi.create_input_device` or `renoise.Midi.create_output_device`. diff --git a/docs/API/renoise/renoise.Midi.MidiOutputDevice.md b/docs/API/renoise/renoise.Midi.MidiOutputDevice.md index 2bb59db..7f1c5e0 100644 --- a/docs/API/renoise/renoise.Midi.MidiOutputDevice.md +++ b/docs/API/renoise/renoise.Midi.MidiOutputDevice.md @@ -4,12 +4,12 @@ Instances are created via `renoise.Midi.create_output_device` --- ## Properties -### is_open : [`boolean`](/API/builtins/boolean.md) {#is_open} +### is_open : [`boolean`](../../API/builtins/boolean.md) {#is_open} Returns true while the device is open (ready to send or receive messages). Your device refs will never be auto-closed, "is_open" will only be false if you explicitly call "midi_device:close()" to release a device. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The name of a device. This is the name you create a device with via `renoise.Midi.create_input_device` or `renoise.Midi.create_output_device`. @@ -17,7 +17,7 @@ The name of a device. This is the name you create a device with via --- ## Functions -### `send`([*self*](/API/builtins/self.md), message : [`integer`](/API/builtins/integer.md)`[]`) {#send} +### `send`([*self*](../../API/builtins/self.md), message : [`integer`](../../API/builtins/integer.md)`[]`) {#send} Send raw 1-3 byte MIDI messages or sysex messages. Message is expected to be an array of numbers. It must not be empty and can only contain numbers >= 0 and <= 0xFF (bytes). Sysex messages must be sent in one block, diff --git a/docs/API/renoise/renoise.Midi.md b/docs/API/renoise/renoise.Midi.md index 7e05f8b..635ddb4 100644 --- a/docs/API/renoise/renoise.Midi.md +++ b/docs/API/renoise/renoise.Midi.md @@ -5,19 +5,19 @@ MIDI data. --- ## Functions ### `available_input_devices()` {#available_input_devices} -`->`[`string`](/API/builtins/string.md)`[]` +`->`[`string`](../../API/builtins/string.md)`[]` Return a list of strings with currently available MIDI input devices. This list can change when devices are hot-plugged. See `renoise.Midi.devices_changed_observable` ### `available_output_devices()` {#available_output_devices} -`->`[`string`](/API/builtins/string.md)`[]` +`->`[`string`](../../API/builtins/string.md)`[]` 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`](#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) +### `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. @@ -34,8 +34,8 @@ When Renoise is already listening to this device, your callback *and* Renoise 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/renoise.Midi.MidiOutputDevice.md) +### `create_output_device`(device_name : [`string`](../../API/builtins/string.md)) {#create_output_device} +`->`[`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()`. @@ -45,7 +45,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/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. @@ -61,7 +61,7 @@ The messages will simply go into the void... --- ## Aliases # alias MidiMessage {#MidiMessage} -[`integer`](/API/builtins/integer.md)`[]` +[`integer`](../../API/builtins/integer.md)`[]` # alias MidiMessageFunction {#MidiMessageFunction} diff --git a/docs/API/renoise/renoise.NoteColumn.md b/docs/API/renoise/renoise.NoteColumn.md index ecedf1e..8b93234 100644 --- a/docs/API/renoise/renoise.NoteColumn.md +++ b/docs/API/renoise/renoise.NoteColumn.md @@ -10,57 +10,57 @@ them in Renoise's pattern or phrase editor. --- ## Properties -### delay_string : [`string`](/API/builtins/string.md) {#delay_string} +### delay_string : [`string`](../../API/builtins/string.md) {#delay_string} Range: (\'00'-\'FF\') or \'..\' -### delay_value : [`integer`](/API/builtins/integer.md) {#delay_value} +### delay_value : [`integer`](../../API/builtins/integer.md) {#delay_value} Range: (0-255) -### effect_amount_string : [`string`](/API/builtins/string.md) {#effect_amount_string} +### effect_amount_string : [`string`](../../API/builtins/string.md) {#effect_amount_string} Range: (\'00\' - \'FF\') -### effect_amount_value : [`integer`](/API/builtins/integer.md) {#effect_amount_value} +### effect_amount_value : [`integer`](../../API/builtins/integer.md) {#effect_amount_value} Range: (0-255) -### effect_number_string : [`string`](/API/builtins/string.md) {#effect_number_string} +### effect_number_string : [`string`](../../API/builtins/string.md) {#effect_number_string} Range: (\'00\'-\'ZZ\') -### effect_number_value : [`integer`](/API/builtins/integer.md) {#effect_number_value} +### effect_number_value : [`integer`](../../API/builtins/integer.md) {#effect_number_value} Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 -### instrument_string : [`string`](/API/builtins/string.md) {#instrument_string} +### instrument_string : [`string`](../../API/builtins/string.md) {#instrument_string} Range: (\'00\'-\'FE\') or \'..\' -### instrument_value : [`integer`](/API/builtins/integer.md) {#instrument_value} +### instrument_value : [`integer`](../../API/builtins/integer.md) {#instrument_value} Range: (0-254), 255==Empty -### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} +### is_empty : [`boolean`](../../API/builtins/boolean.md) {#is_empty} **READ-ONLY** True, when all note column properties are empty. -### is_selected : [`boolean`](/API/builtins/boolean.md) {#is_selected} +### is_selected : [`boolean`](../../API/builtins/boolean.md) {#is_selected} **READ-ONLY** True, when this column is selected in the pattern or phrase editors current pattern. -### note_string : [`string`](/API/builtins/string.md) {#note_string} +### note_string : [`string`](../../API/builtins/string.md) {#note_string} Range: (\'C-0\'-\'G-9\') or \'OFF\' or \'---\' -### note_value : [`integer`](/API/builtins/integer.md) {#note_value} +### note_value : [`integer`](../../API/builtins/integer.md) {#note_value} Range: (0-119) or 120=Off or 121=Empty -### panning_string : [`string`](/API/builtins/string.md) {#panning_string} +### panning_string : [`string`](../../API/builtins/string.md) {#panning_string} Range: (\'00'-\'ZF\') or \'..\' -### panning_value : [`integer`](/API/builtins/integer.md) {#panning_value} +### panning_value : [`integer`](../../API/builtins/integer.md) {#panning_value} Range: (0-127) or 255==Empty when column value is <= 0x80 or is 0xFF, i.e. to specify a pan value. Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2, when column value is > 0x80, i.e. to specify an effect. -### volume_string : [`string`](/API/builtins/string.md) {#volume_string} +### volume_string : [`string`](../../API/builtins/string.md) {#volume_string} Range(\'00\'-\'ZF\') or \'..\' -### volume_value : [`integer`](/API/builtins/integer.md) {#volume_value} +### volume_value : [`integer`](../../API/builtins/integer.md) {#volume_value} Range: (0-127) or 255==Empty when column value is <= 0x80 or is 0xFF, i.e. to specify a volume value. @@ -71,8 +71,8 @@ when column value is > 0x80, i.e. to specify an effect. --- ## Functions -### `clear`([*self*](/API/builtins/self.md)) {#clear} +### `clear`([*self*](../../API/builtins/self.md)) {#clear} Clear the note column. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.NoteColumn`](/API/renoise/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/renoise.Osc.Bundle.md b/docs/API/renoise/renoise.Osc.Bundle.md index 9aca66a..4994b29 100644 --- a/docs/API/renoise/renoise.Osc.Bundle.md +++ b/docs/API/renoise/renoise.Osc.Bundle.md @@ -2,14 +2,14 @@ --- ## Properties -### binary_data : [`string`](/API/builtins/string.md) {#binary_data} +### binary_data : [`string`](../../API/builtins/string.md) {#binary_data} **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/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](/API/renoise/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} +### timetag : [`number`](../../API/builtins/number.md) {#timetag} **READ-ONLY** Time value of the bundle. diff --git a/docs/API/renoise/renoise.Osc.Message.md b/docs/API/renoise/renoise.Osc.Message.md index b7bc9c2..631aa66 100644 --- a/docs/API/renoise/renoise.Osc.Message.md +++ b/docs/API/renoise/renoise.Osc.Message.md @@ -6,11 +6,11 @@ **READ-ONLY** Table of `{tag="X", value=SomeValue}` that represents the message arguments. See `renoise.Osc.Message.create` for more info. -### binary_data : [`string`](/API/builtins/string.md) {#binary_data} +### binary_data : [`string`](../../API/builtins/string.md) {#binary_data} **READ-ONLY** Raw binary representation of the message, as needed when e.g. sending the message over the network through sockets. -### pattern : [`string`](/API/builtins/string.md) {#pattern} +### pattern : [`string`](../../API/builtins/string.md) {#pattern} **READ-ONLY** The message pattern (e.g. "/renoise/transport/start") @@ -30,7 +30,7 @@ specified. For more info, see: http://opensoundcontrol.org/spec-1_0 --- ## Properties ### tag : [`OscTag`](#OscTag) {#tag} -### value : [`boolean`](/API/builtins/boolean.md) | [`string`](/API/builtins/string.md) | [`number`](/API/builtins/number.md) {#value} +### value : [`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md) {#value} diff --git a/docs/API/renoise/renoise.Osc.md b/docs/API/renoise/renoise.Osc.md index bae3a42..fe3486b 100644 --- a/docs/API/renoise/renoise.Osc.md +++ b/docs/API/renoise/renoise.Osc.md @@ -3,19 +3,19 @@ OSC (Open Sound Control) support for Lua scripts in Renoise. --- ## Functions -### `Bundle`(time : [`integer`](/API/builtins/integer.md), arguments : [`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md) | [`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md)`[]`) {#Bundle} -`->`[`renoise.Osc.Bundle`](/API/renoise/renoise.Osc.Bundle.md) +### `Bundle`(time : [`integer`](../../API/builtins/integer.md), arguments : [`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md) | [`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md)`[]`) {#Bundle} +`->`[`renoise.Osc.Bundle`](../../API/renoise/renoise.Osc.Bundle.md) Create a new bundle by specifying a time-tag and one or more messages. If you do not know what to do with the time-tag, use `os.clock()`, which simply means "now". Messages must be renoise.Osc.Message objects. Nested bundles (bundles in bundles) are right now not supported. -### `Message`(pattern : [`string`](/API/builtins/string.md), arguments : [`OscValue`](#oscvalue)`[]`[`?`](/API/builtins/nil.md)) {#Message} -`->`[`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md) +### `Message`(pattern : [`string`](../../API/builtins/string.md), arguments : [`OscValue`](#oscvalue)`[]`[`?`](../../API/builtins/nil.md)) {#Message} +`->`[`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md) Create a new OSC message with the given pattern and optional arguments. -### `from_binary_data`(binary_data : [`string`](/API/builtins/string.md)) {#from_binary_data} -`->`[`renoise.Osc.Bundle`](/API/renoise/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](/API/renoise/renoise.Osc.Message.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `from_binary_data`(binary_data : [`string`](../../API/builtins/string.md)) {#from_binary_data} +`->`[`renoise.Osc.Bundle`](../../API/renoise/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) 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 @@ -39,7 +39,7 @@ specified. For more info, see: http://opensoundcontrol.org/spec-1_0 --- ## Properties ### tag : [`OscTag`](#OscTag) {#tag} -### value : [`boolean`](/API/builtins/boolean.md) | [`string`](/API/builtins/string.md) | [`number`](/API/builtins/number.md) {#value} +### value : [`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md) {#value} diff --git a/docs/API/renoise/renoise.Pattern.md b/docs/API/renoise/renoise.Pattern.md index a3c07c9..37f0db1 100644 --- a/docs/API/renoise/renoise.Pattern.md +++ b/docs/API/renoise/renoise.Pattern.md @@ -2,29 +2,29 @@ --- ## Properties -### MAX_NUMBER_OF_LINES : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_LINES} +### MAX_NUMBER_OF_LINES : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_LINES} Maximum number of lines that can be present in a pattern. -### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} +### is_empty : [`boolean`](../../API/builtins/boolean.md) {#is_empty} Quickly check if any track in a pattern has some non empty pattern lines. This does not look at track automation. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} Name of the pattern, as visible in the pattern sequencer. -### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### number_of_lines : [`integer`](/API/builtins/integer.md) {#number_of_lines} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### tracks : [`renoise.PatternTrack`](/API/renoise/renoise.PatternTrack.md)`[]` {#tracks} +### 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. @@ -32,19 +32,19 @@ functions to it. --- ## Functions -### `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} +### `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/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`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_edited_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#PatternLineChangeCallbackWithContext), obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md)) {#has_line_notifier} -`->`[`boolean`](/API/builtins/boolean.md) +### `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 as soon as any of the pattern's lines have changed. @@ -68,10 +68,10 @@ 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`](#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/renoise.PatternTrack.md) +### `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/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. @@ -85,9 +85,9 @@ Line iterator position. --- ## Properties -### line : [`integer`](/API/builtins/integer.md) {#line} -### pattern : [`integer`](/API/builtins/integer.md) {#pattern} -### track : [`integer`](/API/builtins/integer.md) {#track} +### line : [`integer`](../../API/builtins/integer.md) {#line} +### pattern : [`integer`](../../API/builtins/integer.md) {#pattern} +### track : [`integer`](../../API/builtins/integer.md) {#track} @@ -97,7 +97,7 @@ Line iterator position. --- ## Aliases # alias PatternLineChangeCallbackWithContext {#PatternLineChangeCallbackWithContext} -(obj : [`table`](/API/builtins/table.md) | [`userdata`](/API/builtins/userdata.md), pos : [`PatternLinePosition`](#patternlineposition)) +(obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md), pos : [`PatternLinePosition`](#patternlineposition)) diff --git a/docs/API/renoise/renoise.PatternIterator.md b/docs/API/renoise/renoise.PatternIterator.md index 085b5df..55c4feb 100644 --- a/docs/API/renoise/renoise.PatternIterator.md +++ b/docs/API/renoise/renoise.PatternIterator.md @@ -20,50 +20,50 @@ 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`](#patterncolumnposition), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) 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`](#patterncolumnposition), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) -### `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`](#patterncolumnposition), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) 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`](#patterncolumnposition), [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) -### `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`](#patternlineposition), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) +### `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`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) 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`](#patternlineposition), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) +### `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`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) 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`](#patternlineposition), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) +### `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`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) 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`](#patternlineposition), [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) +### `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`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) 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`](#patterncolumnposition), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) 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`](#patterncolumnposition), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) 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`](#patterncolumnposition), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) 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`](#patterncolumnposition), [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) +### `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`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) Iterate over all note/effect columns in the specified track. @@ -76,10 +76,10 @@ Note/Effect column iterator position. --- ## Properties -### column : [`integer`](/API/builtins/integer.md) {#column} -### line : [`integer`](/API/builtins/integer.md) {#line} -### pattern : [`integer`](/API/builtins/integer.md) {#pattern} -### track : [`integer`](/API/builtins/integer.md) {#track} +### column : [`integer`](../../API/builtins/integer.md) {#column} +### line : [`integer`](../../API/builtins/integer.md) {#line} +### pattern : [`integer`](../../API/builtins/integer.md) {#pattern} +### track : [`integer`](../../API/builtins/integer.md) {#track} @@ -88,9 +88,9 @@ Line iterator position. --- ## Properties -### line : [`integer`](/API/builtins/integer.md) {#line} -### pattern : [`integer`](/API/builtins/integer.md) {#pattern} -### track : [`integer`](/API/builtins/integer.md) {#track} +### line : [`integer`](../../API/builtins/integer.md) {#line} +### pattern : [`integer`](../../API/builtins/integer.md) {#pattern} +### track : [`integer`](../../API/builtins/integer.md) {#track} diff --git a/docs/API/renoise/renoise.PatternLine.md b/docs/API/renoise/renoise.PatternLine.md index fc25b44..ee2b292 100644 --- a/docs/API/renoise/renoise.PatternLine.md +++ b/docs/API/renoise/renoise.PatternLine.md @@ -2,41 +2,41 @@ --- ## Properties -### EMPTY_DELAY : [`integer`](/API/builtins/integer.md) {#EMPTY_DELAY} -### EMPTY_EFFECT_AMOUNT : [`integer`](/API/builtins/integer.md) {#EMPTY_EFFECT_AMOUNT} -### EMPTY_EFFECT_NUMBER : [`integer`](/API/builtins/integer.md) {#EMPTY_EFFECT_NUMBER} -### EMPTY_INSTRUMENT : [`integer`](/API/builtins/integer.md) {#EMPTY_INSTRUMENT} -### EMPTY_NOTE : [`integer`](/API/builtins/integer.md) {#EMPTY_NOTE} -### 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/renoise.EffectColumn.md)`[]` {#effect_columns} +### EMPTY_DELAY : [`integer`](../../API/builtins/integer.md) {#EMPTY_DELAY} +### EMPTY_EFFECT_AMOUNT : [`integer`](../../API/builtins/integer.md) {#EMPTY_EFFECT_AMOUNT} +### EMPTY_EFFECT_NUMBER : [`integer`](../../API/builtins/integer.md) {#EMPTY_EFFECT_NUMBER} +### EMPTY_INSTRUMENT : [`integer`](../../API/builtins/integer.md) {#EMPTY_INSTRUMENT} +### EMPTY_NOTE : [`integer`](../../API/builtins/integer.md) {#EMPTY_NOTE} +### 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/renoise.EffectColumn.md)`[]` {#effect_columns} **READ-ONLY** -### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} +### is_empty : [`boolean`](../../API/builtins/boolean.md) {#is_empty} **READ-ONLY** -### note_columns : [`renoise.NoteColumn`](/API/renoise/renoise.NoteColumn.md)`[]` {#note_columns} +### note_columns : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md)`[]` {#note_columns} **READ-ONLY** --- ## Functions -### `clear`([*self*](/API/builtins/self.md)) {#clear} +### `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/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/renoise.EffectColumn.md) +### `effect_column`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#effect_column} +`->`[`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. 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/renoise.NoteColumn.md) +### `note_column`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#note_column} +`->`[`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/renoise.PatternSequencer.md b/docs/API/renoise/renoise.PatternSequencer.md index 97cde89..222c4cc 100644 --- a/docs/API/renoise/renoise.PatternSequencer.md +++ b/docs/API/renoise/renoise.PatternSequencer.md @@ -3,36 +3,36 @@ Pattern sequencer component of the Renoise song. --- ## Properties -### keep_sequence_sorted : [`boolean`](/API/builtins/boolean.md) {#keep_sequence_sorted} +### 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/renoise.Document.Observable.md) {#keep_sequence_sorted_observable} +### keep_sequence_sorted_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#keep_sequence_sorted_observable} Track changes to document properties or general states by attaching listener functions to it. -### pattern_assignments_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#pattern_assignments_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. -### pattern_sequence : [`integer`](/API/builtins/integer.md)`[]` {#pattern_sequence} +### pattern_sequence : [`integer`](../../API/builtins/integer.md)`[]` {#pattern_sequence} 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/renoise.Document.ObservableList.md) {#pattern_sequence_observable} +### pattern_sequence_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#pattern_sequence_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### pattern_slot_mutes_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#pattern_slot_mutes_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. -### selection_range : [`integer`](/API/builtins/integer.md)`[]` {#selection_range} +### selection_range : [`integer`](../../API/builtins/integer.md)`[]` {#selection_range} 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/renoise.Document.Observable.md) {#selection_range_observable} +### selection_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selection_range_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -40,72 +40,72 @@ functions to it. --- ## Functions -### `clone_range`([*self*](/API/builtins/self.md), from_sequence_index : [`integer`](/API/builtins/integer.md), to_sequence_index : [`integer`](/API/builtins/integer.md)) {#clone_range} +### `clone_range`([*self*](../../API/builtins/self.md), from_sequence_index : [`integer`](../../API/builtins/integer.md), to_sequence_index : [`integer`](../../API/builtins/integer.md)) {#clone_range} Clone a sequence range, appending it right after to_sequence_index. Slot muting is copied as well. -### `delete_sequence_at`([*self*](/API/builtins/self.md), sequence_index : [`any`](/API/builtins/any.md)) {#delete_sequence_at} +### `delete_sequence_at`([*self*](../../API/builtins/self.md), sequence_index : [`any`](../../API/builtins/any.md)) {#delete_sequence_at} Delete an existing position in the sequence. Renoise needs at least one sequence in the song for playback. Completely removing all sequence positions is not allowed. -### `insert_new_pattern_at`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#insert_new_pattern_at} -`->`new_pattern_index : [`integer`](/API/builtins/integer.md) +### `insert_new_pattern_at`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#insert_new_pattern_at} +`->`new_pattern_index : [`integer`](../../API/builtins/integer.md) Insert an empty, unreferenced pattern at the given position. -### `insert_sequence_at`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md), pattern_index : [`integer`](/API/builtins/integer.md)) {#insert_sequence_at} +### `insert_sequence_at`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md), pattern_index : [`integer`](../../API/builtins/integer.md)) {#insert_sequence_at} Insert the specified pattern at the given position in the sequence. -### `make_range_unique`([*self*](/API/builtins/self.md), from_sequence_index : [`integer`](/API/builtins/integer.md), to_sequence_index : [`integer`](/API/builtins/integer.md)) {#make_range_unique} +### `make_range_unique`([*self*](../../API/builtins/self.md), from_sequence_index : [`integer`](../../API/builtins/integer.md), to_sequence_index : [`integer`](../../API/builtins/integer.md)) {#make_range_unique} Make patterns in the given sequence pos range unique, if needed. -### `pattern`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#pattern} -`->`pattern_index : [`integer`](/API/builtins/integer.md) +### `pattern`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#pattern} +`->`pattern_index : [`integer`](../../API/builtins/integer.md) Access to a single sequence by index (the pattern number). Use property `pattern_sequence` to iterate over the whole sequence and to query the sequence count. -### `sequence_is_end_of_section`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#sequence_is_end_of_section} -`->`[`boolean`](/API/builtins/boolean.md) +### `sequence_is_end_of_section`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#sequence_is_end_of_section} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true if the given sequence pos is the end of a section, else false -### `sequence_is_part_of_section`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#sequence_is_part_of_section} -`->`[`boolean`](/API/builtins/boolean.md) +### `sequence_is_part_of_section`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#sequence_is_part_of_section} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true if the given sequence pos is part of a section, else false. -### `sequence_is_start_of_section`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#sequence_is_start_of_section} -`->`[`boolean`](/API/builtins/boolean.md), [`boolean`](/API/builtins/boolean.md) +### `sequence_is_start_of_section`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#sequence_is_start_of_section} +`->`[`boolean`](../../API/builtins/boolean.md), [`boolean`](../../API/builtins/boolean.md) 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/renoise.Document.Observable.md) +### `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/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) +### `sequence_section_name`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#sequence_section_name} +`->`[`string`](../../API/builtins/string.md) 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/renoise.Document.Observable.md) +### `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/renoise.Document.Observable.md) -### `sequence_sections_changed_observable`([*self*](/API/builtins/self.md)) {#sequence_sections_changed_observable} -`->`[`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/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 -### `set_sequence_is_start_of_section`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md), is_section : [`boolean`](/API/builtins/boolean.md)) {#set_sequence_is_start_of_section} -### `set_sequence_section_name`([*self*](/API/builtins/self.md), sequence_index : [`integer`](/API/builtins/integer.md), name : [`string`](/API/builtins/string.md)) {#set_sequence_section_name} -### `set_track_sequence_slot_is_muted`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), sequence_index : [`integer`](/API/builtins/integer.md), muted : [`any`](/API/builtins/any.md)) {#set_track_sequence_slot_is_muted} -### `set_track_sequence_slot_is_selected`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), sequence_index : [`integer`](/API/builtins/integer.md), selected : [`any`](/API/builtins/any.md)) {#set_track_sequence_slot_is_selected} -### `sort`([*self*](/API/builtins/self.md)) {#sort} +### `set_sequence_is_start_of_section`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md), is_section : [`boolean`](../../API/builtins/boolean.md)) {#set_sequence_is_start_of_section} +### `set_sequence_section_name`([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md), name : [`string`](../../API/builtins/string.md)) {#set_sequence_section_name} +### `set_track_sequence_slot_is_muted`([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md), muted : [`any`](../../API/builtins/any.md)) {#set_track_sequence_slot_is_muted} +### `set_track_sequence_slot_is_selected`([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md), selected : [`any`](../../API/builtins/any.md)) {#set_track_sequence_slot_is_selected} +### `sort`([*self*](../../API/builtins/self.md)) {#sort} Sort patterns in the sequence in ascending order, keeping the old pattern data in place. This will only change the visual order of patterns, but not change the song's structure. -### `track_sequence_slot_is_muted`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#track_sequence_slot_is_muted} -`->`[`boolean`](/API/builtins/boolean.md) +### `track_sequence_slot_is_muted`([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#track_sequence_slot_is_muted} +`->`[`boolean`](../../API/builtins/boolean.md) Access to sequencer slot mute states. Mute slots are memorized in the sequencer and not in the patterns. -### `track_sequence_slot_is_selected`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), sequence_index : [`integer`](/API/builtins/integer.md)) {#track_sequence_slot_is_selected} -`->`[`boolean`](/API/builtins/boolean.md) +### `track_sequence_slot_is_selected`([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md)) {#track_sequence_slot_is_selected} +`->`[`boolean`](../../API/builtins/boolean.md) Access to sequencer slot selection states. diff --git a/docs/API/renoise/renoise.PatternTrack.md b/docs/API/renoise/renoise.PatternTrack.md index 1ca1b98..6420ae7 100644 --- a/docs/API/renoise/renoise.PatternTrack.md +++ b/docs/API/renoise/renoise.PatternTrack.md @@ -2,39 +2,39 @@ --- ## Properties -### alias_pattern_index : [`integer`](/API/builtins/integer.md) {#alias_pattern_index} +### 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/renoise.Document.Observable.md) {#alias_pattern_index_observable} +### alias_pattern_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#alias_pattern_index_observable} Track changes to document properties or general states by attaching listener functions to it. -### automation : [`renoise.PatternTrackAutomation`](/API/renoise/renoise.PatternTrackAutomation.md)`[]` {#automation} +### automation : [`renoise.PatternTrackAutomation`](../../API/renoise/renoise.PatternTrackAutomation.md)`[]` {#automation} Automation. -### automation_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#automation_observable} +### automation_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#automation_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### color : [`RGBColor`](#RGBColor)[`?`](/API/builtins/nil.md) {#color} +### 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/renoise.Document.Observable.md) {#color_observable} +### color_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#color_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_alias : [`boolean`](/API/builtins/boolean.md) {#is_alias} +### is_alias : [`boolean`](../../API/builtins/boolean.md) {#is_alias} **READ-ONLY** -### is_empty : [`boolean`](/API/builtins/boolean.md) {#is_empty} +### 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/renoise.Document.Observable.md) {#is_empty_observable} +### is_empty_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_empty_observable} Track changes to document properties or general states by attaching listener functions to it. -### lines : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md)`[]` {#lines} +### 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. @@ -42,33 +42,33 @@ Use `renoise.Pattern:add/remove_line_notifier` for change notifications. --- ## Functions -### `clear`([*self*](/API/builtins/self.md)) {#clear} +### `clear`([*self*](../../API/builtins/self.md)) {#clear} Deletes all lines & automation. -### `copy_from`([*self*](/API/builtins/self.md), other : [`renoise.PatternTrack`](/API/renoise/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/renoise.DeviceParameter.md)) {#create_automation} -`->`[`renoise.PatternTrackAutomation`](/API/renoise/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/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/renoise.DeviceParameter.md)) {#find_automation} -`->`[`renoise.PatternTrackAutomation`](/API/renoise/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/renoise.PatternLine.md) +### `line`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#line} +`->`[`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/renoise.PatternLine.md)`[]` +### `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/renoise.PatternLine.md)`[]` Get a specific line range. Index must be Range: (1 - Pattern.MAX_NUMBER_OF_LINES) @@ -77,7 +77,7 @@ Get a specific line range. Index must be Range: (1 - Pattern.MAX_NUMBER_OF_LINES --- ## Aliases # alias RGBColor {#RGBColor} -{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +{ 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 diff --git a/docs/API/renoise/renoise.PatternTrackAutomation.md b/docs/API/renoise/renoise.PatternTrackAutomation.md index 6e073bb..ba19555 100644 --- a/docs/API/renoise/renoise.PatternTrackAutomation.md +++ b/docs/API/renoise/renoise.PatternTrackAutomation.md @@ -18,21 +18,21 @@ For example a time of 1.5 means: line 1 with a note column delay of 128 --- ## Properties -### dest_device : [`renoise.AudioDevice`](/API/renoise/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/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. -### length : [`integer`](/API/builtins/integer.md) {#length} +### length : [`integer`](../../API/builtins/integer.md) {#length} 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/renoise.Document.Observable.md) {#playmode_observable} +### playmode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#playmode_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -43,31 +43,31 @@ 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/renoise.Document.ObservableList.md) {#points_observable} +### points_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#points_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### selection_end : [`integer`](/API/builtins/integer.md) {#selection_end} +### selection_end : [`integer`](../../API/builtins/integer.md) {#selection_end} Range: (1 - automation.length + 1) -### selection_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_end_observable} +### selection_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selection_end_observable} Track changes to document properties or general states by attaching listener functions to it. -### selection_range : [`integer`](/API/builtins/integer.md)`[]` {#selection_range} +### 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/renoise.Document.Observable.md) {#selection_range_observable} +### selection_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selection_range_observable} Track changes to document properties or general states by attaching listener functions to it. -### selection_start : [`integer`](/API/builtins/integer.md) {#selection_start} +### selection_start : [`integer`](../../API/builtins/integer.md) {#selection_start} Range: (1 - automation.length + 1) -### selection_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_start_observable} +### selection_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selection_start_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -75,23 +75,23 @@ functions to it. --- ## Functions -### `add_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md), value : [`number`](/API/builtins/number.md), scaling : [`number`](/API/builtins/number.md)[`?`](/API/builtins/nil.md)) {#add_point_at} +### `add_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md), scaling : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) {#add_point_at} Insert a new point, or change an existing one, if a point in time already exists. -### `clear`([*self*](/API/builtins/self.md)) {#clear} +### `clear`([*self*](../../API/builtins/self.md)) {#clear} Removes all points from the automation. Will not delete the automation from tracks[]:automation, instead the resulting automation will not do 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} +### `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/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) +### `has_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) {#has_point_at} +`->`[`boolean`](../../API/builtins/boolean.md) Test if a point exists at the given time -### `remove_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md)) {#remove_point_at} +### `remove_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) {#remove_point_at} Removes a point at the given time. Point must exist. @@ -103,13 +103,13 @@ Single point within a pattern track automation envelope. --- ## Properties -### scaling : [`number`](/API/builtins/number.md) {#scaling} +### scaling : [`number`](../../API/builtins/number.md) {#scaling} Automation point scaling. Used in 'lines' playback mode only - 0.0 is linear. -### time : [`integer`](/API/builtins/integer.md) {#time} +### time : [`integer`](../../API/builtins/integer.md) {#time} Automation point's time in pattern lines in Range: (1 - NUM_LINES_IN_PATTERN). -### value : [`number`](/API/builtins/number.md) {#value} +### value : [`number`](../../API/builtins/number.md) {#value} Automation point value in Range: (0 - 1.0) diff --git a/docs/API/renoise/renoise.Sample.md b/docs/API/renoise/renoise.Sample.md index 8c405da..a3cb8be 100644 --- a/docs/API/renoise/renoise.Sample.md +++ b/docs/API/renoise/renoise.Sample.md @@ -38,165 +38,165 @@ --- ## Properties -### autofade : [`boolean`](/API/builtins/boolean.md) {#autofade} -### autofade_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#autofade_observable} +### autofade : [`boolean`](../../API/builtins/boolean.md) {#autofade} +### autofade_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#autofade_observable} Track changes to document properties or general states by attaching listener functions to it. -### autoseek : [`boolean`](/API/builtins/boolean.md) {#autoseek} -### autoseek_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#autoseek_observable} +### autoseek : [`boolean`](../../API/builtins/boolean.md) {#autoseek} +### autoseek_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#autoseek_observable} Track changes to document properties or general states by attaching listener functions to it. -### beat_sync_enabled : [`boolean`](/API/builtins/boolean.md) {#beat_sync_enabled} +### beat_sync_enabled : [`boolean`](../../API/builtins/boolean.md) {#beat_sync_enabled} Beat sync. -### beat_sync_enabled_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### beat_sync_lines : [`integer`](/API/builtins/integer.md) {#beat_sync_lines} +### beat_sync_lines : [`integer`](../../API/builtins/integer.md) {#beat_sync_lines} Range: (1 - 512) -### beat_sync_lines_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. ### beat_sync_mode : [`renoise.Sample.BeatSyncMode`](renoise.Sample.md#BeatSyncMode) {#beat_sync_mode} -### beat_sync_mode_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### device_chain_index : [`integer`](/API/builtins/integer.md) {#device_chain_index} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### fine_tune : [`integer`](/API/builtins/integer.md) {#fine_tune} +### fine_tune : [`integer`](../../API/builtins/integer.md) {#fine_tune} Range: (-127 - 127) -### fine_tune_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#fine_tune_observable} +### fine_tune_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#fine_tune_observable} Track changes to document properties or general states by attaching listener functions to it. ### 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/renoise.Document.Observable.md) {#interpolation_mode_observable} +### interpolation_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#interpolation_mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_slice_alias : [`boolean`](/API/builtins/boolean.md) {#is_slice_alias} +### 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 slice list. -### loop_end : [`integer`](/API/builtins/integer.md) {#loop_end} +### loop_end : [`integer`](../../API/builtins/integer.md) {#loop_end} Range: (1 - num_sample_frames) -### loop_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_end_observable} Track changes to document properties or general states by attaching listener functions to it. ### loop_mode : [`renoise.Sample.LoopMode`](renoise.Sample.md#LoopMode) {#loop_mode} Loops. -### loop_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_mode_observable} +### loop_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_release : [`boolean`](/API/builtins/boolean.md) {#loop_release} -### loop_release_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_release_observable} +### loop_release : [`boolean`](../../API/builtins/boolean.md) {#loop_release} +### loop_release_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_release_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} +### loop_start : [`integer`](../../API/builtins/integer.md) {#loop_start} Range: (1 - num_sample_frames) -### loop_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_start_observable} Track changes to document properties or general states by attaching listener functions to it. -### modulation_set_index : [`integer`](/API/builtins/integer.md) {#modulation_set_index} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### mute_group : [`integer`](/API/builtins/integer.md) {#mute_group} +### 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/renoise.Document.Observable.md) {#mute_group_observable} +### mute_group_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#mute_group_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} Name. -### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. ### new_note_action : [`renoise.Sample.NewNoteActionMode`](renoise.Sample.md#NewNoteActionMode) {#new_note_action} -### new_note_action_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### oneshot : [`boolean`](/API/builtins/boolean.md) {#oneshot} -### oneshot_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#oneshot_observable} +### oneshot : [`boolean`](../../API/builtins/boolean.md) {#oneshot} +### oneshot_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#oneshot_observable} Track changes to document properties or general states by attaching listener functions to it. -### oversample_enabled : [`boolean`](/API/builtins/boolean.md) {#oversample_enabled} -### oversample_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#oversample_enabled_observable} +### oversample_enabled : [`boolean`](../../API/builtins/boolean.md) {#oversample_enabled} +### oversample_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#oversample_enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### panning : [`number`](/API/builtins/number.md) {#panning} +### panning : [`number`](../../API/builtins/number.md) {#panning} Range: (0.0 - 1.0) -### panning_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_observable} +### panning_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#panning_observable} Track changes to document properties or general states by attaching listener functions to it. -### sample_buffer : [`renoise.SampleBuffer`](/API/renoise/renoise.SampleBuffer.md) {#sample_buffer} +### sample_buffer : [`renoise.SampleBuffer`](../../API/renoise/renoise.SampleBuffer.md) {#sample_buffer} **READ-ONLY** -### sample_buffer_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sample_buffer_observable} +### sample_buffer_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#sample_buffer_observable} Track changes to document properties or general states by attaching listener functions to it. -### sample_mapping : [`renoise.SampleMapping`](/API/renoise/renoise.SampleMapping.md) {#sample_mapping} +### 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} +### slice_markers : [`integer`](../../API/builtins/integer.md)`[]` {#slice_markers} Read/write access to the slice marker list of a sample. When new markers are set or existing ones unset, existing 0S effects or notes to existing slices 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/renoise.Document.ObservableList.md) {#slice_markers_observable} +### slice_markers_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#slice_markers_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### transpose : [`integer`](/API/builtins/integer.md) {#transpose} +### transpose : [`integer`](../../API/builtins/integer.md) {#transpose} Range: (-120 - 120) -### transpose_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#transpose_observable} +### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#transpose_observable} Track changes to document properties or general states by attaching listener functions to it. -### volume : [`number`](/API/builtins/number.md) {#volume} +### volume : [`number`](../../API/builtins/number.md) {#volume} Range: (0.0 - 4.0) -### volume_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_observable} +### volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#volume_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -204,16 +204,16 @@ functions to it. --- ## Functions -### `clear`([*self*](/API/builtins/self.md)) {#clear} +### `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/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_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 marker. See also property 'samples[].slice_markers'. Existing 0S effects or notes will be updated to ensure that the old slices are played back just as before. -### `insert_slice_marker`([*self*](/API/builtins/self.md), marker_sample_pos : [`integer`](/API/builtins/integer.md)) {#insert_slice_marker} +### `insert_slice_marker`([*self*](../../API/builtins/self.md), marker_sample_pos : [`integer`](../../API/builtins/integer.md)) {#insert_slice_marker} Insert a new slice marker at the given sample position. Only samples in the first sample slot may use slices. Creating slices will automatically create sample aliases in the following slots: read-only sample slots that @@ -222,7 +222,7 @@ be modified manually then. To update such aliases, modify the slice marker list instead. Existing 0S effects or notes will be updated to ensure that the old slices are played back just as before. -### `move_slice_marker`([*self*](/API/builtins/self.md), old_marker_pos : [`integer`](/API/builtins/integer.md), new_marker_pos : [`integer`](/API/builtins/integer.md)) {#move_slice_marker} +### `move_slice_marker`([*self*](../../API/builtins/self.md), old_marker_pos : [`integer`](../../API/builtins/integer.md), new_marker_pos : [`integer`](../../API/builtins/integer.md)) {#move_slice_marker} Change the sample position of an existing slice marker. see also property 'samples[].slice_markers'. When moving a marker behind or before an existing other marker, existing 0S diff --git a/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md b/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md index 971dfa8..6f6464c 100644 --- a/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md +++ b/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md @@ -2,90 +2,90 @@ --- ## Properties -### attack : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#attack} +### attack : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#attack} with range (0-1) -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### duration : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#duration} +### 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/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### hold : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#hold} +### hold : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#hold} with range (0-1) -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### release : [`renoise.DeviceParameter`](/API/renoise/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} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** -### sustain : [`renoise.DeviceParameter`](/API/renoise/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} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -93,13 +93,13 @@ functions to it. --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/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} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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.SampleBuffer.md b/docs/API/renoise/renoise.SampleBuffer.md index 4741240..82c3bb8 100644 --- a/docs/API/renoise/renoise.SampleBuffer.md +++ b/docs/API/renoise/renoise.SampleBuffer.md @@ -14,79 +14,79 @@ NOTE: All properties are invalid when no sample data is present, --- ## Properties -### bit_depth : [`integer`](/API/builtins/integer.md) {#bit_depth} +### bit_depth : [`integer`](../../API/builtins/integer.md) {#bit_depth} **READ-ONLY** The current bit depth, like 32, 16, 8. -### display_length : [`integer`](/API/builtins/integer.md) {#display_length} +### display_length : [`integer`](../../API/builtins/integer.md) {#display_length} Range: (1 - number_of_frames) -### display_length_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_length_observable} +### display_length_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_length_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_range : [`integer`](/API/builtins/integer.md)`[]` {#display_range} +### display_range : [`integer`](../../API/builtins/integer.md)`[]` {#display_range} Range: (1 - number_of_frames) -### display_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_range_observable} +### display_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_range_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_start : [`integer`](/API/builtins/integer.md) {#display_start} +### display_start : [`integer`](../../API/builtins/integer.md) {#display_start} Range: (1 - number_of_frames) -### display_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_start_observable} +### display_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_start_observable} Track changes to document properties or general states by attaching listener functions to it. -### has_sample_data : [`boolean`](/API/builtins/boolean.md) {#has_sample_data} +### has_sample_data : [`boolean`](../../API/builtins/boolean.md) {#has_sample_data} **READ-ONLY** Check this before accessing properties -### number_of_channels : [`integer`](/API/builtins/integer.md) {#number_of_channels} +### number_of_channels : [`integer`](../../API/builtins/integer.md) {#number_of_channels} **READ-ONLY** The integer of sample channels (1 or 2) -### number_of_frames : [`integer`](/API/builtins/integer.md) {#number_of_frames} +### number_of_frames : [`integer`](../../API/builtins/integer.md) {#number_of_frames} **READ-ONLY** The sample frame count (integer of samples per channel) -### read_only : [`boolean`](/API/builtins/boolean.md) {#read_only} +### read_only : [`boolean`](../../API/builtins/boolean.md) {#read_only} **READ-ONLY** True, when the sample buffer can only be read, but not be modified. true for sample aliases of sliced samples. To modify such sample buffers, modify the sliced master sample buffer instead. -### sample_rate : [`integer`](/API/builtins/integer.md) {#sample_rate} +### sample_rate : [`integer`](../../API/builtins/integer.md) {#sample_rate} **READ-ONLY** The current sample rate in Hz, like 44100. ### selected_channel : [`renoise.SampleBuffer.Channel`](renoise.SampleBuffer.md#Channel) {#selected_channel} The selected channel. -### selected_channel_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_channel_observable} +### selected_channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_channel_observable} Track changes to document properties or general states by attaching listener functions to it. -### selection_end : [`integer`](/API/builtins/integer.md) {#selection_end} +### selection_end : [`integer`](../../API/builtins/integer.md) {#selection_end} Range: (1 - number_of_frames) -### selection_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_end_observable} +### selection_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selection_end_observable} Track changes to document properties or general states by attaching listener functions to it. -### selection_range : [`integer`](/API/builtins/integer.md)`[]` {#selection_range} +### selection_range : [`integer`](../../API/builtins/integer.md)`[]` {#selection_range} Range: (1 - number_of_frames) -### selection_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_range_observable} +### selection_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selection_range_observable} Track changes to document properties or general states by attaching listener functions to it. -### selection_start : [`integer`](/API/builtins/integer.md) {#selection_start} +### selection_start : [`integer`](../../API/builtins/integer.md) {#selection_start} Range: (1 - number_of_frames) -### selection_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selection_start_observable} +### selection_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selection_start_observable} Track changes to document properties or general states by attaching listener functions to it. -### vertical_zoom_factor : [`number`](/API/builtins/number.md) {#vertical_zoom_factor} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. @@ -94,37 +94,37 @@ functions to it. --- ## Functions -### `create_sample_data`([*self*](/API/builtins/self.md), sample_rate : [`integer`](/API/builtins/integer.md), bit_depth : [`integer`](/API/builtins/integer.md), num_channels : [`integer`](/API/builtins/integer.md), num_frames : [`integer`](/API/builtins/integer.md)) {#create_sample_data} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `create_sample_data`([*self*](../../API/builtins/self.md), sample_rate : [`integer`](../../API/builtins/integer.md), bit_depth : [`integer`](../../API/builtins/integer.md), num_channels : [`integer`](../../API/builtins/integer.md), num_frames : [`integer`](../../API/builtins/integer.md)) {#create_sample_data} +`->`success : [`boolean`](../../API/builtins/boolean.md) Create new sample data with the given rate, bit-depth, channel and frame count. Will trash existing sample data. Initial buffer is all zero. Will only return false when memory allocation fails (you're running out of memory). All other errors are fired as usual. -### `delete_sample_data`([*self*](/API/builtins/self.md)) {#delete_sample_data} +### `delete_sample_data`([*self*](../../API/builtins/self.md)) {#delete_sample_data} Delete existing sample data. -### `finalize_sample_data_changes`([*self*](/API/builtins/self.md)) {#finalize_sample_data_changes} +### `finalize_sample_data_changes`([*self*](../../API/builtins/self.md)) {#finalize_sample_data_changes} To be called once AFTER the sample data is manipulated via 'set_sample_data'. This will create undo/redo data for the whole sample, and also update the sample view caches for the sample. The reason this isn't automatically invoked is to avoid performance overhead when changing sample data 'sample by sample'. Don't forget to call this after any data changes, or changes may not be visible in the GUI and can not be un/redone! -### `load_from`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_from} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `load_from`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_from} +`->`success : [`boolean`](../../API/builtins/boolean.md) Load sample data from a file. Files can be any audio format Renoise supports. Possible errors are shown to the user, otherwise success is returned. -### `prepare_sample_data_changes`([*self*](/API/builtins/self.md)) {#prepare_sample_data_changes} +### `prepare_sample_data_changes`([*self*](../../API/builtins/self.md)) {#prepare_sample_data_changes} To be called once BEFORE sample data gets manipulated via 'set_sample_data'. This will prepare undo/redo data for the whole sample. See also 'finalize_sample_data_changes'. -### `sample_data`([*self*](/API/builtins/self.md), channel_index : [`integer`](/API/builtins/integer.md), frame_index : [`integer`](/API/builtins/integer.md)) {#sample_data} -`->`values : [`number`](/API/builtins/number.md)`[]` +### `sample_data`([*self*](../../API/builtins/self.md), channel_index : [`integer`](../../API/builtins/integer.md), frame_index : [`integer`](../../API/builtins/integer.md)) {#sample_data} +`->`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`](#SampleBuffer.ExportType)) {#save_as} -`->`success : [`boolean`](/API/builtins/boolean.md) +### `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, otherwise success is returned. @@ -134,7 +134,7 @@ format: | "wav" | "flac" ``` -### `set_sample_data`([*self*](/API/builtins/self.md), channel_index : [`integer`](/API/builtins/integer.md), frame_index : [`integer`](/API/builtins/integer.md), sample_value : [`integer`](/API/builtins/integer.md)) {#set_sample_data} +### `set_sample_data`([*self*](../../API/builtins/self.md), channel_index : [`integer`](../../API/builtins/integer.md), frame_index : [`integer`](../../API/builtins/integer.md), sample_value : [`integer`](../../API/builtins/integer.md)) {#set_sample_data} Write access to samples in a sample data buffer. New samples values must be within [-1, 1] and will be clipped automatically. Sample buffers may be read-only (see property 'read_only'). Attempts to write on such buffers diff --git a/docs/API/renoise/renoise.SampleDeviceChain.md b/docs/API/renoise/renoise.SampleDeviceChain.md index d1f983d..d21d213 100644 --- a/docs/API/renoise/renoise.SampleDeviceChain.md +++ b/docs/API/renoise/renoise.SampleDeviceChain.md @@ -6,31 +6,31 @@ **READ-ONLY** Returns a list of tables containing more information about the devices. -### available_devices : [`string`](/API/builtins/string.md)`[]` {#available_devices} +### available_devices : [`string`](../../API/builtins/string.md)`[]` {#available_devices} **READ-ONLY** Allowed, available devices for 'insert_device_at'. -### available_output_routings : [`string`](/API/builtins/string.md)`[]` {#available_output_routings} +### available_output_routings : [`string`](../../API/builtins/string.md)`[]` {#available_output_routings} **READ-ONLY** Output routing. -### devices : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md)`[]` {#devices} +### devices : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md)`[]` {#devices} **READ-ONLY** Device access. -### devices_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#devices_observable} +### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#devices_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} Name of the audio effect chain. -### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### output_routing : [`string`](/API/builtins/string.md) {#output_routing} +### output_routing : [`string`](../../API/builtins/string.md) {#output_routing} One of 'available_output_routings' -### output_routing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_routing_observable} +### output_routing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#output_routing_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -38,19 +38,19 @@ functions to it. --- ## Functions -### `delete_device_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_device_at} +### `delete_device_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#delete_device_at} 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/renoise.AudioDevice.md) +### `device`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#device} +`->`[`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/renoise.AudioDevice.md) +### `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/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) -### `swap_devices_at`([*self*](/API/builtins/self.md), index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md)) {#swap_devices_at} +### `swap_devices_at`([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) {#swap_devices_at} Swap the positions of two devices in the device chain. The mixer device at index 1 can not be swapped or moved. @@ -63,22 +63,22 @@ Audio device info --- ## Properties -### favorite_name : [`string`](/API/builtins/string.md) {#favorite_name} +### favorite_name : [`string`](../../API/builtins/string.md) {#favorite_name} The device's name as displayed in favorites -### is_bridged : [`boolean`](/API/builtins/boolean.md) {#is_bridged} +### is_bridged : [`boolean`](../../API/builtins/boolean.md) {#is_bridged} true if the device is a bridged plugin -### is_favorite : [`boolean`](/API/builtins/boolean.md) {#is_favorite} +### is_favorite : [`boolean`](../../API/builtins/boolean.md) {#is_favorite} true if the device is a favorite -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The device's name -### path : [`string`](/API/builtins/string.md) {#path} +### path : [`string`](../../API/builtins/string.md) {#path} The device's path used by `renoise.Track:insert_device_at` -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} The device's name as displayed in shortened lists diff --git a/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md b/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md index 2969759..bed011c 100644 --- a/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md +++ b/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md @@ -21,102 +21,102 @@ --- ## Properties -### MAX_NUMBER_OF_POINTS : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_POINTS} -### MIN_NUMBER_OF_POINTS : [`integer`](/API/builtins/integer.md) {#MIN_NUMBER_OF_POINTS} -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### MAX_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_POINTS} +### MIN_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) {#MIN_NUMBER_OF_POINTS} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### external_editor_visible : [`boolean`](/API/builtins/boolean.md) {#external_editor_visible} +### 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 -### fade_amount : [`integer`](/API/builtins/integer.md) {#fade_amount} +### fade_amount : [`integer`](../../API/builtins/integer.md) {#fade_amount} Range: (0 - 4095) -### fade_amount_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#fade_amount_observable} +### fade_amount_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#fade_amount_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### length : [`integer`](/API/builtins/integer.md) {#length} +### length : [`integer`](../../API/builtins/integer.md) {#length} Range: (6 - 1000) -### length_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#length_observable} +### length_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#length_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_end : [`integer`](/API/builtins/integer.md) {#loop_end} +### loop_end : [`integer`](../../API/builtins/integer.md) {#loop_end} Range: (1 - envelope.length) -### loop_end_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_end_observable} +### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_end_observable} Track changes to document properties or general states by attaching listener functions to it. ### loop_mode : [`renoise.SampleEnvelopeModulationDevice.LoopMode`](renoise.SampleEnvelopeModulationDevice.md#LoopMode) {#loop_mode} Loop. -### loop_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_mode_observable} +### loop_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_start : [`integer`](/API/builtins/integer.md) {#loop_start} +### loop_start : [`integer`](../../API/builtins/integer.md) {#loop_start} Range: (1 - envelope.length) -### loop_start_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_start_observable} +### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_start_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### 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/renoise.Document.Observable.md) {#play_mode_observable} +### play_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#play_mode_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -127,25 +127,25 @@ 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/renoise.Document.ObservableList.md) {#points_observable} +### points_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#points_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** -### sustain_enabled : [`boolean`](/API/builtins/boolean.md) {#sustain_enabled} +### sustain_enabled : [`boolean`](../../API/builtins/boolean.md) {#sustain_enabled} Sustain. -### sustain_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sustain_enabled_observable} +### sustain_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#sustain_enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### sustain_position : [`integer`](/API/builtins/integer.md) {#sustain_position} +### sustain_position : [`integer`](../../API/builtins/integer.md) {#sustain_position} Range: (1 - envelope.length) -### sustain_position_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#sustain_position_observable} +### sustain_position_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#sustain_position_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -153,17 +153,17 @@ functions to it. **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -171,28 +171,28 @@ functions to it. --- ## Functions -### `add_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md), value : [`number`](/API/builtins/number.md), scaling : [`number`](/API/builtins/number.md)[`?`](/API/builtins/nil.md)) {#add_point_at} +### `add_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md), scaling : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) {#add_point_at} Add a new point value (or replace any existing value) at time. -### `clear_points`([*self*](/API/builtins/self.md)) {#clear_points} +### `clear_points`([*self*](../../API/builtins/self.md)) {#clear_points} 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} +### `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/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/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) +### `has_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) {#has_point_at} +`->`[`boolean`](../../API/builtins/boolean.md) Test if a point exists at the given time. -### `init`([*self*](/API/builtins/self.md)) {#init} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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. -### `remove_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md)) {#remove_point_at} +### `remove_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) {#remove_point_at} Removes a point at the given time. Point must exist. @@ -203,13 +203,13 @@ Removes a point at the given time. Point must exist. --- ## Properties -### scaling : [`number`](/API/builtins/number.md) {#scaling} +### scaling : [`number`](../../API/builtins/number.md) {#scaling} Range: (-1.0 - 1.0) -### time : [`integer`](/API/builtins/integer.md) {#time} +### time : [`integer`](../../API/builtins/integer.md) {#time} Range: (1 - envelope.length) -### value : [`number`](/API/builtins/number.md) {#value} +### value : [`number`](../../API/builtins/number.md) {#value} Range: (0.0 - 1.0) diff --git a/docs/API/renoise/renoise.SampleFaderModulationDevice.md b/docs/API/renoise/renoise.SampleFaderModulationDevice.md index 811621f..691f573 100644 --- a/docs/API/renoise/renoise.SampleFaderModulationDevice.md +++ b/docs/API/renoise/renoise.SampleFaderModulationDevice.md @@ -14,108 +14,108 @@ --- ## Properties -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### delay : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#delay} +### delay : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#delay} Delay. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### duration : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#duration} +### duration : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#duration} Duration. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### from : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#from} +### from : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#from} Start value. -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### 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/renoise.Document.Observable.md) {#scaling_observable} +### scaling_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#scaling_observable} Track changes to document properties or general states by attaching listener functions to it. -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. -### to : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#to} +### 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/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} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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.SampleKeyTrackingModulationDevice.md b/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md index 84cfd95..aec0419 100644 --- a/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md +++ b/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md @@ -2,81 +2,81 @@ --- ## Properties -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### max : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#max} +### max : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#max} with range (0-119) -### min : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#min} +### min : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#min} with range (0-119) -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -84,13 +84,13 @@ functions to it. --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/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} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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.SampleLfoModulationDevice.md b/docs/API/renoise/renoise.SampleLfoModulationDevice.md index 38a9a0b..bfa4d95 100644 --- a/docs/API/renoise/renoise.SampleLfoModulationDevice.md +++ b/docs/API/renoise/renoise.SampleLfoModulationDevice.md @@ -13,90 +13,90 @@ --- ## Properties -### amount : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#amount} +### amount : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#amount} with range (0-1) -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### delay : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#delay} +### delay : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#delay} Delay. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### frequency : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#frequency} +### frequency : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#frequency} with range (0-1) -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. ### mode : [`renoise.SampleLfoModulationDevice.Mode`](renoise.SampleLfoModulationDevice.md#Mode) {#mode} LFO mode. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### phase : [`renoise.DeviceParameter`](/API/renoise/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} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -104,13 +104,13 @@ functions to it. --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/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} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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.SampleMapping.md b/docs/API/renoise/renoise.SampleMapping.md index 7280b9c..fdbd3a3 100644 --- a/docs/API/renoise/renoise.SampleMapping.md +++ b/docs/API/renoise/renoise.SampleMapping.md @@ -4,50 +4,50 @@ modified. See `sample_mappings[].read_only` --- ## Properties -### base_note : [`integer`](/API/builtins/integer.md) {#base_note} +### base_note : [`integer`](../../API/builtins/integer.md) {#base_note} Range: (0-119, c-4=48)] -### base_note_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#base_note_observable} +### base_note_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#base_note_observable} Track changes to document properties or general states by attaching listener functions to it. ### 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/renoise.Document.Observable.md) {#layer_observable} +### layer_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#layer_observable} Track changes to document properties or general states by attaching listener functions to it. -### map_key_to_pitch : [`boolean`](/API/builtins/boolean.md) {#map_key_to_pitch} -### map_key_to_pitch_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#map_key_to_pitch_observable} +### map_key_to_pitch : [`boolean`](../../API/builtins/boolean.md) {#map_key_to_pitch} +### map_key_to_pitch_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#map_key_to_pitch_observable} Track changes to document properties or general states by attaching listener functions to it. -### map_velocity_to_volume : [`boolean`](/API/builtins/boolean.md) {#map_velocity_to_volume} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### note_range : [`integer`](/API/builtins/integer.md)`[]` {#note_range} +### 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/renoise.Document.Observable.md) {#note_range_observable} +### note_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#note_range_observable} Track changes to document properties or general states by attaching listener functions to it. -### read_only : [`boolean`](/API/builtins/boolean.md) {#read_only} +### 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/renoise.Sample.md) {#sample} +### sample : [`renoise.Sample`](../../API/renoise/renoise.Sample.md) {#sample} Linked sample. -### velocity_range : [`integer`](/API/builtins/integer.md)`[]` {#velocity_range} +### velocity_range : [`integer`](../../API/builtins/integer.md)`[]` {#velocity_range} Range: (0 - 127) -### velocity_range_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#velocity_range_observable} +### velocity_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#velocity_range_observable} Track changes to document properties or general states by attaching listener functions to it. diff --git a/docs/API/renoise/renoise.SampleModulationDevice.md b/docs/API/renoise/renoise.SampleModulationDevice.md index 6830ba5..e94e8f3 100644 --- a/docs/API/renoise/renoise.SampleModulationDevice.md +++ b/docs/API/renoise/renoise.SampleModulationDevice.md @@ -24,75 +24,75 @@ --- ## Properties -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -100,13 +100,13 @@ functions to it. --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/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} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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 index 21e815b..6d9c40d 100644 --- a/docs/API/renoise/renoise.SampleModulationSet.md +++ b/docs/API/renoise/renoise.SampleModulationSet.md @@ -2,87 +2,87 @@ --- ## Properties -### available_devices : [`string`](/API/builtins/string.md)`[]` {#available_devices} +### 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} +### 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} +### 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} +### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#devices_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### drive_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#drive_input} +### 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_type_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#filter_type_observable} Track changes to document properties or general states by attaching listener functions to it. ### 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} +### filter_version_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#filter_version_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### panning_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#panning_input} +### 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} +### 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} +### 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} +### pitch_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#pitch_range_observable} Track changes to document properties or general states by attaching listener functions to it. -### resonance_input : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#resonance_input} +### 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} +### 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_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_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) +### `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} +### `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_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_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/renoise.SampleOperandModulationDevice.md b/docs/API/renoise/renoise.SampleOperandModulationDevice.md index 08d6d67..b9b060b 100644 --- a/docs/API/renoise/renoise.SampleOperandModulationDevice.md +++ b/docs/API/renoise/renoise.SampleOperandModulationDevice.md @@ -2,92 +2,92 @@ --- ## Properties -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. -### value : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#value} +### 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/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} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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.SampleStepperModulationDevice.md b/docs/API/renoise/renoise.SampleStepperModulationDevice.md index a1432bd..bb35dbe 100644 --- a/docs/API/renoise/renoise.SampleStepperModulationDevice.md +++ b/docs/API/renoise/renoise.SampleStepperModulationDevice.md @@ -12,81 +12,81 @@ --- ## Properties -### MAX_NUMBER_OF_POINTS : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_POINTS} -### MIN_NUMBER_OF_POINTS : [`integer`](/API/builtins/integer.md) {#MIN_NUMBER_OF_POINTS} -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### MAX_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_POINTS} +### MIN_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) {#MIN_NUMBER_OF_POINTS} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### external_editor_visible : [`boolean`](/API/builtins/boolean.md) {#external_editor_visible} +### 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 -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### length : [`integer`](/API/builtins/integer.md) {#length} +### length : [`integer`](../../API/builtins/integer.md) {#length} Range: (1 - 256) -### length_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#length_observable} +### length_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#length_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### 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/renoise.Document.Observable.md) {#play_mode_observable} +### play_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#play_mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### play_step : [`integer`](/API/builtins/integer.md) {#play_step} +### play_step : [`integer`](../../API/builtins/integer.md) {#play_step} Range: (-1 - 16) -### play_step_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#play_step_observable} +### play_step_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#play_step_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -97,29 +97,29 @@ 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/renoise.Document.ObservableList.md) {#points_observable} +### points_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#points_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -127,28 +127,28 @@ functions to it. --- ## Functions -### `add_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md), value : [`number`](/API/builtins/number.md), scaling : [`number`](/API/builtins/number.md)[`?`](/API/builtins/nil.md)) {#add_point_at} +### `add_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md), scaling : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) {#add_point_at} Add a new point value (or replace any existing value) at time. -### `clear_points`([*self*](/API/builtins/self.md)) {#clear_points} +### `clear_points`([*self*](../../API/builtins/self.md)) {#clear_points} 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} +### `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/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/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) +### `has_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) {#has_point_at} +`->`[`boolean`](../../API/builtins/boolean.md) Test if a point exists at the given time. -### `init`([*self*](/API/builtins/self.md)) {#init} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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. -### `remove_point_at`([*self*](/API/builtins/self.md), time : [`integer`](/API/builtins/integer.md)) {#remove_point_at} +### `remove_point_at`([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) {#remove_point_at} Removes a point at the given time. Point must exist. @@ -159,13 +159,13 @@ Removes a point at the given time. Point must exist. --- ## Properties -### scaling : [`number`](/API/builtins/number.md) {#scaling} +### scaling : [`number`](../../API/builtins/number.md) {#scaling} Range: (-1.0 - 1.0) -### time : [`integer`](/API/builtins/integer.md) {#time} +### time : [`integer`](../../API/builtins/integer.md) {#time} Range: (1 - envelope.length) -### value : [`number`](/API/builtins/number.md) {#value} +### value : [`number`](../../API/builtins/number.md) {#value} Range: (0.0 - 1.0) diff --git a/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md b/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md index d255dcf..400ce18 100644 --- a/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md +++ b/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md @@ -11,88 +11,88 @@ --- ## Properties -### bipolar : [`boolean`](/API/builtins/boolean.md) {#bipolar} +### bipolar : [`boolean`](../../API/builtins/boolean.md) {#bipolar} 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/renoise.Document.Observable.md) {#bipolar_observable} +### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bipolar_observable} Track changes to document properties or general states by attaching listener functions to it. -### display_name : [`string`](/API/builtins/string.md) {#display_name} +### display_name : [`string`](../../API/builtins/string.md) {#display_name} Configurable device display name. -### display_name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#display_name_observable} +### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#display_name_observable} Track changes to document properties or general states by attaching listener functions to it. -### enabled : [`boolean`](/API/builtins/boolean.md) {#enabled} -### enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#enabled_observable} +### enabled : [`boolean`](../../API/builtins/boolean.md) {#enabled} +### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active : [`boolean`](/API/builtins/boolean.md) {#is_active} +### is_active : [`boolean`](../../API/builtins/boolean.md) {#is_active} not active = bypassed -### is_active_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_active_observable} +### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_active_observable} Track changes to document properties or general states by attaching listener functions to it. -### is_active_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#is_active_parameter} +### 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} +### is_maximized : [`boolean`](../../API/builtins/boolean.md) {#is_maximized} Maximize state in modulation chain. -### is_maximized_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} +### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#is_maximized_observable} Track changes to document properties or general states by attaching listener functions to it. -### max : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#max} +### max : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#max} with range (0-127) -### min : [`renoise.DeviceParameter`](/API/renoise/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/renoise.Document.Observable.md) {#mode_observable} +### mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### 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/renoise.Document.Observable.md) {#operator_observable} +### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#operator_observable} Track changes to document properties or general states by attaching listener functions to it. -### parameters : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} +### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)`[]` {#parameters} **READ-ONLY** -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} **READ-ONLY** ### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) {#target} **READ-ONLY** Where the modulation gets applied (Volume, Pan, Pitch, Cutoff, Resonance). -### tempo_sync_switching_allowed : [`boolean`](/API/builtins/boolean.md) {#tempo_sync_switching_allowed} +### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) {#tempo_sync_switching_allowed} **READ-ONLY** When true, the device has one of more time parameters, which can be switched to operate in synced or unsynced mode. see also field tempo_synced. -### tempo_synced : [`boolean`](/API/builtins/boolean.md) {#tempo_synced} +### tempo_synced : [`boolean`](../../API/builtins/boolean.md) {#tempo_synced} 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/renoise.Document.Observable.md) {#tempo_synced_observable} +### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tempo_synced_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -100,13 +100,13 @@ functions to it. --- ## Functions -### `copy_from`([*self*](/API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](/API/renoise/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} +### `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/renoise.DeviceParameter.md) +### `parameter`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#parameter} +`->`[`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.ScriptingTool.MidiMessage.md b/docs/API/renoise/renoise.ScriptingTool.MidiMessage.md index b021b66..00a6b42 100644 --- a/docs/API/renoise/renoise.ScriptingTool.MidiMessage.md +++ b/docs/API/renoise/renoise.ScriptingTool.MidiMessage.md @@ -3,10 +3,10 @@ MIDI message as passed to the `invoke` callback in tool midi_mappings. --- ## Properties -### boolean_value : [`boolean`](/API/builtins/boolean.md)[`?`](/API/builtins/nil.md) {#boolean_value} +### boolean_value : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) {#boolean_value} valid [true OR false] when `is_switch()` returns true, else undefined -### int_value : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#int_value} +### int_value : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#int_value} Range: (0S - 127) for abs values, Range: (-63 - 63) for relative values valid when `is_rel_value()` or `is_abs_value()` returns true, else undefined @@ -14,16 +14,16 @@ valid when `is_rel_value()` or `is_abs_value()` returns true, else undefined --- ## Functions -### `is_abs_value`([*self*](/API/builtins/self.md)) {#is_abs_value} -`->`[`boolean`](/API/builtins/boolean.md) +### `is_abs_value`([*self*](../../API/builtins/self.md)) {#is_abs_value} +`->`[`boolean`](../../API/builtins/boolean.md) check if the int_value property is valid -### `is_rel_value`([*self*](/API/builtins/self.md)) {#is_rel_value} -`->`[`boolean`](/API/builtins/boolean.md) +### `is_rel_value`([*self*](../../API/builtins/self.md)) {#is_rel_value} +`->`[`boolean`](../../API/builtins/boolean.md) check if the int_value property is valid -### `is_switch`([*self*](/API/builtins/self.md)) {#is_switch} +### `is_switch`([*self*](../../API/builtins/self.md)) {#is_switch} check if the boolean_value property is valid -### `is_trigger`([*self*](/API/builtins/self.md)) {#is_trigger} +### `is_trigger`([*self*](../../API/builtins/self.md)) {#is_trigger} returns if action should be invoked diff --git a/docs/API/renoise/renoise.ScriptingTool.md b/docs/API/renoise/renoise.ScriptingTool.md index a808625..09fa426 100644 --- a/docs/API/renoise/renoise.ScriptingTool.md +++ b/docs/API/renoise/renoise.ScriptingTool.md @@ -5,12 +5,12 @@ attaching it to some common tool related notifiers. --- ## Properties -### app_became_active_observable : [`renoise.Document.Observable`](/API/renoise/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/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 @@ -18,30 +18,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/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/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/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/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} +### 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/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 @@ -77,14 +77,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/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/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. @@ -93,15 +93,15 @@ to other devices here if necessary. --- ## Functions -### `add_file_import_hook`([*self*](/API/builtins/self.md), file_import_hook : [`ToolFileImportHook`](#toolfileimporthook)) {#add_file_import_hook} +### `add_file_import_hook`([*self*](../../API/builtins/self.md), file_import_hook : [`ToolFileImportHook`](#toolfileimporthook)) {#add_file_import_hook} Add a new file import hook as described above. -### `add_keybinding`([*self*](/API/builtins/self.md), keybinding : [`ToolKeybindingEntry`](#toolkeybindingentry)) {#add_keybinding} +### `add_keybinding`([*self*](../../API/builtins/self.md), keybinding : [`ToolKeybindingEntry`](#toolkeybindingentry)) {#add_keybinding} Register key bindings somewhere in Renoise's existing set of bindings. -### `add_menu_entry`([*self*](/API/builtins/self.md), entry : [`ToolMenuEntry`](#toolmenuentry)) {#add_menu_entry} +### `add_menu_entry`([*self*](../../API/builtins/self.md), entry : [`ToolMenuEntry`](#toolmenuentry)) {#add_menu_entry} Add a new menu entry. -### `add_midi_mapping`([*self*](/API/builtins/self.md), midi_mapping : [`ToolMidiMappingEntry`](#toolmidimappingentry)) {#add_midi_mapping} +### `add_midi_mapping`([*self*](../../API/builtins/self.md), midi_mapping : [`ToolMidiMappingEntry`](#toolmidimappingentry)) {#add_midi_mapping} Add a new midi_mapping entry. -### `add_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction), 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. @@ -111,8 +111,8 @@ 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`](#FileHookCategory), extensions_table : [`string`](/API/builtins/string.md)`[]`) {#has_file_import_hook} -`->`[`boolean`](/API/builtins/boolean.md) +### `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. @@ -127,23 +127,23 @@ category: | "sample" | "theme" ``` -### `has_keybinding`([*self*](/API/builtins/self.md), keybinding_name : [`string`](/API/builtins/string.md)) {#has_keybinding} -`->`[`boolean`](/API/builtins/boolean.md) +### `has_keybinding`([*self*](../../API/builtins/self.md), keybinding_name : [`string`](../../API/builtins/string.md)) {#has_keybinding} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true when the given keybinging already exists, otherwise false. -### `has_menu_entry`([*self*](/API/builtins/self.md), entry_name : [`string`](/API/builtins/string.md)) {#has_menu_entry} -`->`[`boolean`](/API/builtins/boolean.md) +### `has_menu_entry`([*self*](../../API/builtins/self.md), entry_name : [`string`](../../API/builtins/string.md)) {#has_menu_entry} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true if the given entry already exists, otherwise false. -### `has_midi_mapping`([*self*](/API/builtins/self.md), midi_mapping_name : [`string`](/API/builtins/string.md)) {#has_midi_mapping} -`->`[`boolean`](/API/builtins/boolean.md) +### `has_midi_mapping`([*self*](../../API/builtins/self.md), midi_mapping_name : [`string`](../../API/builtins/string.md)) {#has_midi_mapping} +`->`[`boolean`](../../API/builtins/boolean.md) Returns true when the given mapping already exists, otherwise false. -### `has_timer`([*self*](/API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction)) {#has_timer} -`->`[`boolean`](/API/builtins/boolean.md) +### `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`](#FileHookCategory), 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) @@ -158,13 +158,13 @@ category: | "sample" | "theme" ``` -### `remove_keybinding`([*self*](/API/builtins/self.md), keybinding_name : [`string`](/API/builtins/string.md)) {#remove_keybinding} +### `remove_keybinding`([*self*](../../API/builtins/self.md), keybinding_name : [`string`](../../API/builtins/string.md)) {#remove_keybinding} Remove a previously added key binding by specifying its name and path. -### `remove_menu_entry`([*self*](/API/builtins/self.md), entry_name : [`string`](/API/builtins/string.md)) {#remove_menu_entry} +### `remove_menu_entry`([*self*](../../API/builtins/self.md), entry_name : [`string`](../../API/builtins/string.md)) {#remove_menu_entry} 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_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`](#TimerFunction)) {#remove_timer} +### `remove_timer`([*self*](../../API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction)) {#remove_timer} Remove a previously registered timer. @@ -190,11 +190,11 @@ Preloading/prehearing sample files is not supported via tools. In which disk browser category the file type shows up. One of -### extensions : [`string`](/API/builtins/string.md)`[]` {#extensions} +### extensions : [`string`](../../API/builtins/string.md)`[]` {#extensions} A list of strings, file extensions, that will invoke your hook, like for example {"txt", "s_wave"} -### invoke : (file_name : [`string`](/API/builtins/string.md)) `->` [`boolean`](/API/builtins/boolean.md) {#invoke} +### invoke : (file_name : [`string`](../../API/builtins/string.md)) `->` [`boolean`](../../API/builtins/boolean.md) {#invoke} function that is called to do the import. return true when the import succeeded, else false. @@ -211,11 +211,11 @@ Renoise. --- ## Properties -### invoke : (repeated : [`boolean`](/API/builtins/boolean.md)) {#invoke} +### invoke : (repeated : [`boolean`](../../API/builtins/boolean.md)) {#invoke} A function that is called as soon as the mapped key is pressed. The callback parameter "repeated", indicates if its a virtual key repeat. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The scope, name and category of the key binding use the form: `$scope:$topic_name:$binding_name`: @@ -301,7 +301,7 @@ more dashes to the name, like "--- Main Menu:Tools:My Tool Group Starts Here" --- ## Properties -### active : () `->` [`boolean`](/API/builtins/boolean.md) {#active} +### active : () `->` [`boolean`](../../API/builtins/boolean.md) {#active} A function that should return true or false. When returning false, the action will not be invoked and will be "greyed out" in menus. This function is always called before "invoke", and every time prior to a menu becoming visible. @@ -309,11 +309,11 @@ called before "invoke", and every time prior to a menu becoming visible. ### invoke : fun() {#invoke} A function that is called as soon as the entry is clicked -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} Name and 'path' of the entry as shown in the global menus or context menus to the user. -### selected : () `->` [`boolean`](/API/builtins/boolean.md) {#selected} +### selected : () `->` [`boolean`](../../API/builtins/boolean.md) {#selected} A function that should return true or false. When returning true, the entry will be marked as "this is a selected option" @@ -334,10 +334,10 @@ messages. --- ## Properties -### invoke : (message : [`renoise.ScriptingTool.MidiMessage`](/API/renoise/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} +### name : [`string`](../../API/builtins/string.md) {#name} The group, name of the midi mapping; as visible to the user. The scope, name and category of the midi mapping use the form: diff --git a/docs/API/renoise/renoise.Socket.SocketBase.md b/docs/API/renoise/renoise.Socket.SocketBase.md index 5cdab8e..8e631fe 100644 --- a/docs/API/renoise/renoise.Socket.SocketBase.md +++ b/docs/API/renoise/renoise.Socket.SocketBase.md @@ -4,24 +4,24 @@ SocketBase properties and functions are available for servers and clients. --- ## Properties -### is_open : [`boolean`](/API/builtins/boolean.md) {#is_open} +### is_open : [`boolean`](../../API/builtins/boolean.md) {#is_open} **READ-ONLY** Returns true when the socket object is valid and connected. Sockets can manually be closed (see socket:close()). Client sockets can also actively be closed/refused by the server. In this case the client:receive() calls will fail and return an error. -### local_address : [`string`](/API/builtins/string.md) {#local_address} +### local_address : [`string`](../../API/builtins/string.md) {#local_address} **READ-ONLY** The socket's resolved local address (for example "127.0.0.1" when a socket is bound to "localhost") -### local_port : [`integer`](/API/builtins/integer.md) {#local_port} +### local_port : [`integer`](../../API/builtins/integer.md) {#local_port} **READ-ONLY** The socket's local port number, as specified when instantiated. --- ## Functions -### `close`([*self*](/API/builtins/self.md)) {#close} +### `close`([*self*](../../API/builtins/self.md)) {#close} Closes the socket connection and releases all resources. This will make 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 diff --git a/docs/API/renoise/renoise.Socket.SocketClient.md b/docs/API/renoise/renoise.Socket.SocketClient.md index 100ffe4..09ecafd 100644 --- a/docs/API/renoise/renoise.Socket.SocketClient.md +++ b/docs/API/renoise/renoise.Socket.SocketClient.md @@ -14,24 +14,24 @@ messages it will not block or timeout. --- ## Properties -### is_open : [`boolean`](/API/builtins/boolean.md) {#is_open} +### is_open : [`boolean`](../../API/builtins/boolean.md) {#is_open} **READ-ONLY** Returns true when the socket object is valid and connected. Sockets can manually be closed (see socket:close()). Client sockets can also actively be closed/refused by the server. In this case the client:receive() calls will fail and return an error. -### local_address : [`string`](/API/builtins/string.md) {#local_address} +### local_address : [`string`](../../API/builtins/string.md) {#local_address} **READ-ONLY** The socket's resolved local address (for example "127.0.0.1" when a socket is bound to "localhost") -### local_port : [`integer`](/API/builtins/integer.md) {#local_port} +### local_port : [`integer`](../../API/builtins/integer.md) {#local_port} **READ-ONLY** The socket's local port number, as specified when instantiated. -### peer_address : [`string`](/API/builtins/string.md) {#peer_address} +### peer_address : [`string`](../../API/builtins/string.md) {#peer_address} **READ-ONLY** Address of the socket's peer, the socket address this client is connected to. -### peer_port : [`integer`](/API/builtins/integer.md) {#peer_port} +### peer_port : [`integer`](../../API/builtins/integer.md) {#peer_port} **READ-ONLY** Port of the socket's peer, the socket this client is connected to. @@ -39,14 +39,14 @@ connected to. --- ## Functions -### `close`([*self*](/API/builtins/self.md)) {#close} +### `close`([*self*](../../API/builtins/self.md)) {#close} Closes the socket connection and releases all resources. This will make 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`](#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`([*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 timeout in milliseconds. Mode can be one of "*line", "*all" or a number > 0, @@ -86,8 +86,8 @@ mode: | "*line" | "*all" ``` -### `send`([*self*](/API/builtins/self.md), message : [`string`](/API/builtins/string.md)) {#send} -`->`success : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `send`([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) {#send} +`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) Send a message string (or OSC messages or bundles) to the connected server. When sending fails, "success" return value will be false and "error_message" @@ -101,7 +101,7 @@ So, when necessary, do this manually by your own please. --- ## Aliases # alias SocketReceiveMode {#SocketReceiveMode} -[`integer`](/API/builtins/integer.md) | `"*all"` | `"*line"` +[`integer`](../../API/builtins/integer.md) | `"*all"` | `"*line"` ```lua SocketReceiveMode: | "*line" diff --git a/docs/API/renoise/renoise.Socket.SocketServer.md b/docs/API/renoise/renoise.Socket.SocketServer.md index ef2de69..09e5c9d 100644 --- a/docs/API/renoise/renoise.Socket.SocketServer.md +++ b/docs/API/renoise/renoise.Socket.SocketServer.md @@ -10,38 +10,38 @@ callbacks are invoked to respond to messages. --- ## Properties -### is_open : [`boolean`](/API/builtins/boolean.md) {#is_open} +### is_open : [`boolean`](../../API/builtins/boolean.md) {#is_open} **READ-ONLY** Returns true when the socket object is valid and connected. Sockets can manually be closed (see socket:close()). Client sockets can also actively be closed/refused by the server. In this case the client:receive() calls will fail and return an error. -### is_running : [`boolean`](/API/builtins/boolean.md) {#is_running} +### is_running : [`boolean`](../../API/builtins/boolean.md) {#is_running} **READ-ONLY** true while the server is running, else false. -### local_address : [`string`](/API/builtins/string.md) {#local_address} +### local_address : [`string`](../../API/builtins/string.md) {#local_address} **READ-ONLY** The socket's resolved local address (for example "127.0.0.1" when a socket is bound to "localhost") -### local_port : [`integer`](/API/builtins/integer.md) {#local_port} +### local_port : [`integer`](../../API/builtins/integer.md) {#local_port} **READ-ONLY** The socket's local port number, as specified when instantiated. --- ## Functions -### `close`([*self*](/API/builtins/self.md)) {#close} +### `close`([*self*](../../API/builtins/self.md)) {#close} Closes the socket connection and releases all resources. This will make 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. -### `run`([*self*](/API/builtins/self.md), notifier_table : [`NotifierClass`](#notifierclass) | [`NotifierTable`](#notifiertable)) {#run} +### `run`([*self*](../../API/builtins/self.md), notifier_table : [`NotifierClass`](#notifierclass) | [`NotifierTable`](#notifiertable)) {#run} Start running the server by specifying a class or table which defines the callback functions for the server. -### `stop`([*self*](/API/builtins/self.md)) {#stop} +### `stop`([*self*](../../API/builtins/self.md)) {#stop} Stop a running server. -### `wait`([*self*](/API/builtins/self.md), timeout : [`number`](/API/builtins/number.md)) {#wait} +### `wait`([*self*](../../API/builtins/self.md), timeout : [`number`](../../API/builtins/number.md)) {#wait} Suspends the calling thread by the given timeout, and calls the server's callback methods as soon as something has happened in the server while waiting. Should be avoided whenever possible. @@ -76,9 +76,9 @@ end --- ## Properties -### 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/renoise.Socket.SocketClient.md), message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_message} +### 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/renoise.Socket.SocketClient.md), message : [`string`](../../API/builtins/string.md))[`?`](../../API/builtins/nil.md) {#socket_message} @@ -105,15 +105,15 @@ All callback properties are optional. So you can, for example, skip specifying --- ## Properties -### socket_accepted : (client : [`renoise.Socket.SocketClient`](/API/renoise/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. -### socket_error : (error_message : [`string`](/API/builtins/string.md))[`?`](/API/builtins/nil.md) {#socket_error} +### 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/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/renoise/renoise.Socket.md b/docs/API/renoise/renoise.Socket.md index 63d1254..9c3376d 100644 --- a/docs/API/renoise/renoise.Socket.md +++ b/docs/API/renoise/renoise.Socket.md @@ -16,8 +16,8 @@ protocol, so both are easily interchangeable when needed. --- ## 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/renoise.Socket.SocketClient.md)[`?`](/API/builtins/nil.md), error : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `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/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 @@ -25,8 +25,8 @@ Create a connected UPD or TCP client. `timeout` is the time in ms to wait until the connection is established (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/renoise.Socket.SocketServer.md)[`?`](/API/builtins/nil.md), [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) +### `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/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/renoise.Song.md b/docs/API/renoise/renoise.Song.md index e56e43d..57424ae 100644 --- a/docs/API/renoise/renoise.Song.md +++ b/docs/API/renoise/renoise.Song.md @@ -19,181 +19,181 @@ Renoise's main document - the song. --- ## Properties -### MAX_NUMBER_OF_INSTRUMENTS : [`integer`](/API/builtins/integer.md) {#MAX_NUMBER_OF_INSTRUMENTS} -### artist : [`string`](/API/builtins/string.md) {#artist} +### MAX_NUMBER_OF_INSTRUMENTS : [`integer`](../../API/builtins/integer.md) {#MAX_NUMBER_OF_INSTRUMENTS} +### artist : [`string`](../../API/builtins/string.md) {#artist} Song Comments -### artist_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#artist_observable} +### artist_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#artist_observable} Track changes to document properties or general states by attaching listener functions to it. -### comments : [`string`](/API/builtins/string.md)`[]` {#comments} +### 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/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/renoise.Document.ObservableList.md) {#comments_observable} +### comments_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#comments_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### file_name : [`string`](/API/builtins/string.md) {#file_name} +### 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/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/renoise.Document.ObservableList.md) {#instruments_observable} +### instruments_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#instruments_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### name : [`string`](/API/builtins/string.md) {#name} -### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### name : [`string`](../../API/builtins/string.md) {#name} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### pattern_iterator : [`renoise.PatternIterator`](/API/renoise/renoise.PatternIterator.md) {#pattern_iterator} +### pattern_iterator : [`renoise.PatternIterator`](../../API/renoise/renoise.PatternIterator.md) {#pattern_iterator} **READ-ONLY** -### patterns : [`renoise.Pattern`](/API/renoise/renoise.Pattern.md)`[]` {#patterns} -### patterns_observable : [`renoise.Document.ObservableList`](/API/renoise/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} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### rendering : [`boolean`](/API/builtins/boolean.md) {#rendering} +### rendering : [`boolean`](../../API/builtins/boolean.md) {#rendering} **READ-ONLY** True while rendering is in progress. -### rendering_progress : [`number`](/API/builtins/number.md) {#rendering_progress} +### rendering_progress : [`number`](../../API/builtins/number.md) {#rendering_progress} Range: (0.0 - 1.0) -### selected_automation_device : [`renoise.AudioDevice`](/API/renoise/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/renoise.Document.Observable.md) {#selected_automation_device_observable} +### selected_automation_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_automation_device_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_automation_parameter : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#selected_automation_parameter} +### 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/renoise.Document.Observable.md) {#selected_automation_parameter_observable} +### selected_automation_parameter_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_automation_parameter_observable} Track changes to document properties or general states by attaching listener functions to it. -### 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/renoise.Document.Observable.md) {#selected_device_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/renoise.Document.Observable.md) {#selected_device_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_effect_column : [`renoise.EffectColumn`](/API/renoise/renoise.EffectColumn.md) {#selected_effect_column} +### 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/renoise.Instrument.md) {#selected_instrument} +### selected_effect_column_index : [`integer`](../../API/builtins/integer.md) {#selected_effect_column_index} +### 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/renoise.Document.Observable.md) {#selected_instrument_index_observable} +### selected_instrument_index : [`integer`](../../API/builtins/integer.md) {#selected_instrument_index} +### selected_instrument_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_instrument_index_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_instrument_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_instrument_observable} +### selected_instrument_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_instrument_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_line : [`renoise.PatternLine`](/API/renoise/renoise.PatternLine.md) {#selected_line} +### 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/renoise.NoteColumn.md) {#selected_note_column} +### selected_line_index : [`integer`](../../API/builtins/integer.md) {#selected_line_index} +### 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/renoise.DeviceParameter.md) {#selected_parameter} -### selected_parameter_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_parameter_observable} +### selected_note_column_index : [`integer`](../../API/builtins/integer.md) {#selected_note_column_index} +### 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} Track changes to document properties or general states by attaching listener functions to it. -### selected_pattern : [`renoise.Pattern`](/API/renoise/renoise.Pattern.md) {#selected_pattern} +### 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} +### 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/renoise.Document.Observable.md) {#selected_pattern_index_observable} +### selected_pattern_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_pattern_index_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_pattern_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_pattern_observable} +### selected_pattern_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_pattern_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_pattern_track : [`renoise.PatternTrack`](/API/renoise/renoise.PatternTrack.md) {#selected_pattern_track} +### 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/renoise.Document.Observable.md) {#selected_pattern_track_observable} +### selected_pattern_track_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_pattern_track_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_phrase : [`renoise.InstrumentPhrase`](/API/renoise/renoise.InstrumentPhrase.md) {#selected_phrase} +### 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/renoise.Document.Observable.md) {#selected_phrase_observable} +### selected_phrase_index : [`integer`](../../API/builtins/integer.md) {#selected_phrase_index} +### selected_phrase_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_phrase_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_sample : [`renoise.Sample`](/API/renoise/renoise.Sample.md) {#selected_sample} +### 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/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/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/renoise.Document.Observable.md) {#selected_sample_device_chain_observable} +### 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/renoise.Document.Observable.md) {#selected_sample_device_chain_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_sample_device_index : [`integer`](/API/builtins/integer.md) {#selected_sample_device_index} -### selected_sample_device_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_sample_device_observable} +### selected_sample_device_index : [`integer`](../../API/builtins/integer.md) {#selected_sample_device_index} +### selected_sample_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_sample_device_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_sample_index : [`integer`](/API/builtins/integer.md) {#selected_sample_index} -### selected_sample_modulation_set : [`renoise.SampleModulationSet`](/API/renoise/renoise.SampleModulationSet.md) {#selected_sample_modulation_set} +### selected_sample_index : [`integer`](../../API/builtins/integer.md) {#selected_sample_index} +### 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/renoise.Document.Observable.md) {#selected_sample_modulation_set_observable} +### 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/renoise.Document.Observable.md) {#selected_sample_modulation_set_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_sample_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_sample_observable} +### selected_sample_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_sample_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_sequence_index : [`integer`](/API/builtins/integer.md) {#selected_sequence_index} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. @@ -201,27 +201,27 @@ functions to it. **READ-ONLY** The currently edited sub column type within the selected note/effect column. -### selected_track : [`renoise.Track`](/API/renoise/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/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/renoise.Document.Observable.md) {#selected_track_device_observable} +### selected_track_device_index : [`integer`](../../API/builtins/integer.md) {#selected_track_device_index} +### selected_track_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_track_device_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_track_index : [`integer`](/API/builtins/integer.md) {#selected_track_index} -### selected_track_index_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_track_index_observable} +### selected_track_index : [`integer`](../../API/builtins/integer.md) {#selected_track_index} +### selected_track_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_track_index_observable} Track changes to document properties or general states by attaching listener functions to it. -### selected_track_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#selected_track_observable} +### selected_track_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#selected_track_observable} Track changes to document properties or general states by attaching listener functions to it. -### selection_in_pattern : [`PatternSelection`](#patternselection)[`?`](/API/builtins/nil.md) {#selection_in_pattern} +### selection_in_pattern : [`PatternSelection`](#patternselection)[`?`](../../API/builtins/nil.md) {#selection_in_pattern} Read/write access to the selection in the pattern editor. Line indexes are valid from 1 to patterns[].number_of_lines @@ -244,26 +244,26 @@ renoise.song().selection_in_pattern = --> select line 1 to 4, in the first track only ``` -### selection_in_phrase : [`PhraseSelection`](#phraseselection)[`?`](/API/builtins/nil.md) {#selection_in_phrase} +### selection_in_phrase : [`PhraseSelection`](#phraseselection)[`?`](../../API/builtins/nil.md) {#selection_in_phrase} Same as `selection_in_pattern` but for the currently selected phrase (if any). -### send_track_count : [`integer`](/API/builtins/integer.md) {#send_track_count} +### send_track_count : [`integer`](../../API/builtins/integer.md) {#send_track_count} -**READ-ONLY** number of send tracks in song. -### sequencer : [`renoise.PatternSequencer`](/API/renoise/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} +### sequencer_track_count : [`integer`](../../API/builtins/integer.md) {#sequencer_track_count} **READ-ONLY** number of normal playback tracks (non-master or sends) in song. -### show_comments_after_loading : [`boolean`](/API/builtins/boolean.md) {#show_comments_after_loading} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### tool_data : [`string`](/API/builtins/string.md)[`?`](/API/builtins/nil.md) {#tool_data} +### 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 access the data from e.g. the scripting terminal will result in an error. @@ -276,61 +276,61 @@ 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/renoise.Track.md)`[]` {#tracks} -### tracks_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#tracks_observable} +### tracks : [`renoise.Track`](../../API/renoise/renoise.Track.md)`[]` {#tracks} +### tracks_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#tracks_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### transport : [`renoise.Transport`](/API/renoise/renoise.Transport.md) {#transport} +### transport : [`renoise.Transport`](../../API/renoise/renoise.Transport.md) {#transport} **READ-ONLY** --- ## Functions -### `add_track_to_group`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md), group_index : [`integer`](/API/builtins/integer.md)) {#add_track_to_group} +### `add_track_to_group`([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), group_index : [`integer`](../../API/builtins/integer.md)) {#add_track_to_group} Add track at track_index to group at group_index by first moving it to the right spot to the left of the group track, and then adding it. If group_index is not a group track, a new group track will be created and both tracks will be added to it. -### `can_redo`([*self*](/API/builtins/self.md)) {#can_redo} -`->`[`boolean`](/API/builtins/boolean.md) +### `can_redo`([*self*](../../API/builtins/self.md)) {#can_redo} +`->`[`boolean`](../../API/builtins/boolean.md) Test if something in the song can be redone. -### `can_undo`([*self*](/API/builtins/self.md)) {#can_undo} -`->`[`boolean`](/API/builtins/boolean.md) +### `can_undo`([*self*](../../API/builtins/self.md)) {#can_undo} +`->`[`boolean`](../../API/builtins/boolean.md) Test if something in the song can be undone. -### `cancel_rendering`([*self*](/API/builtins/self.md)) {#cancel_rendering} +### `cancel_rendering`([*self*](../../API/builtins/self.md)) {#cancel_rendering} When rendering (see rendering, renoise.song().rendering_progress), the current render process is canceled. Otherwise, nothing is done. -### `capture_instrument_from_pattern`([*self*](/API/builtins/self.md)) {#capture_instrument_from_pattern} +### `capture_instrument_from_pattern`([*self*](../../API/builtins/self.md)) {#capture_instrument_from_pattern} Captures the current instrument (selects the instrument) from the current note column at the current cursor pos. Changes the selected instrument accordingly, but does not return the result. When no instrument is present at the current cursor pos, nothing will be done. -### `capture_nearest_instrument_from_pattern`([*self*](/API/builtins/self.md)) {#capture_nearest_instrument_from_pattern} +### `capture_nearest_instrument_from_pattern`([*self*](../../API/builtins/self.md)) {#capture_nearest_instrument_from_pattern} Tries to captures the nearest instrument from the current pattern track, starting to look at the cursor pos, then advancing until an instrument is found. Changes the selected instrument accordingly, but does not return the result. When no instruments (notes) are present in the current pattern track, nothing will be done. -### `clear_midi_mappings`([*self*](/API/builtins/self.md)) {#clear_midi_mappings} +### `clear_midi_mappings`([*self*](../../API/builtins/self.md)) {#clear_midi_mappings} clear all MIDI mappings in the song -### `delete_group_at`([*self*](/API/builtins/self.md), group_index : [`integer`](/API/builtins/integer.md)) {#delete_group_at} +### `delete_group_at`([*self*](../../API/builtins/self.md), group_index : [`integer`](../../API/builtins/integer.md)) {#delete_group_at} Delete the group with the given index and all its member tracks. Index must be that of a group or a track that is a member of a group. -### `delete_instrument_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_instrument_at} +### `delete_instrument_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#delete_instrument_at} Delete an existing instrument at the given index. Renoise needs at least one instrument, thus trying to completely remove all instruments is not allowed. This will remap all existing notes in all patterns and update all other instrument links in the song. -### `delete_track_at`([*self*](/API/builtins/self.md), index : [`integer`](/API/builtins/integer.md)) {#delete_track_at} +### `delete_track_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#delete_track_at} Delete an existing track. The Master track can not be deleted, but all Sends can. Renoise needs at least one regular track to work, thus trying to delete all regular tracks will fire an error. -### `describe_undo`([*self*](/API/builtins/self.md), description : [`any`](/API/builtins/any.md)) {#describe_undo} +### `describe_undo`([*self*](../../API/builtins/self.md), description : [`any`](../../API/builtins/any.md)) {#describe_undo} When modifying the song, Renoise will automatically add descriptions for undo/redo by looking at what first changed (a track was inserted, a pattern line changed, and so on). When the song is changed from an action in a menu @@ -339,45 +339,45 @@ undo description. 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/renoise.GroupTrack.md) +### `insert_group_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#insert_group_at} +`->`[`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/renoise.Instrument.md) +### `insert_instrument_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#insert_instrument_at} +`->`[`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/renoise.Track.md) +### `insert_track_at`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#insert_track_at} +`->`[`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/renoise.Instrument.md) +### `instrument`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#instrument} +`->`[`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. -### `load_midi_mappings`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#load_midi_mappings} -`->`success : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md) +### `load_midi_mappings`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#load_midi_mappings} +`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md) 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/renoise.Pattern.md) +### `pattern`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#pattern} +`->`[`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. -### `redo`([*self*](/API/builtins/self.md)) {#redo} +### `redo`([*self*](../../API/builtins/self.md)) {#redo} Redo a previously undo action. Will do nothing if nothing can be redone. -### `remove_track_from_group`([*self*](/API/builtins/self.md), track_index : [`integer`](/API/builtins/integer.md)) {#remove_track_from_group} +### `remove_track_from_group`([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md)) {#remove_track_from_group} Removes track from its immediate parent group and places it outside it to the left. Can only be called for tracks that are actually part of a group. -### `render`([*self*](/API/builtins/self.md), options : [`RenderOptions`](#renderoptions), filename : [`string`](/API/builtins/string.md), rendering_done_callback : fun()) {#render} -`->`success : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md) +### `render`([*self*](../../API/builtins/self.md), options : [`RenderOptions`](#renderoptions), filename : [`string`](../../API/builtins/string.md), rendering_done_callback : fun()) {#render} +`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md) Start rendering a section of the song or the whole song to a WAV file. @@ -403,30 +403,30 @@ automatically add a ".wav" extension to the file_name, if missing. Parameter `rendering_done_callback` is ONLY called when rendering has succeeded. You can do something with the file you've passed to the renderer here, like for example loading the file into a sample buffer. -### `save_midi_mappings`([*self*](/API/builtins/self.md), filename : [`string`](/API/builtins/string.md)) {#save_midi_mappings} -`->`success : [`boolean`](/API/builtins/boolean.md), error : [`string`](/API/builtins/string.md) +### `save_midi_mappings`([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) {#save_midi_mappings} +`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md) Save all global MIDI mappings in the song into a XRNM file. Returns true when loading/saving succeeded, else false and the error message. -### `select_next_track`([*self*](/API/builtins/self.md)) {#select_next_track} +### `select_next_track`([*self*](../../API/builtins/self.md)) {#select_next_track} Set the selected track to next relative to the current track. Takes care of skipping over hidden tracks and wrapping around at the edges. -### `select_previous_track`([*self*](/API/builtins/self.md)) {#select_previous_track} +### `select_previous_track`([*self*](../../API/builtins/self.md)) {#select_previous_track} Set the selected track to prev relative to the current track. Takes care of skipping over hidden tracks and wrapping around at the edges. -### `swap_instruments_at`([*self*](/API/builtins/self.md), index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md)) {#swap_instruments_at} +### `swap_instruments_at`([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) {#swap_instruments_at} Swap the position of two instruments. Will remap all existing notes in all patterns and update all other instrument links in the song. -### `swap_tracks_at`([*self*](/API/builtins/self.md), index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md)) {#swap_tracks_at} +### `swap_tracks_at`([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) {#swap_tracks_at} 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/renoise.Track.md) +### `track`([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) {#track} +`->`[`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. -### `undo`([*self*](/API/builtins/self.md)) {#undo} +### `undo`([*self*](../../API/builtins/self.md)) {#undo} Undo the last performed action. Will do nothing if nothing can be undone. @@ -438,22 +438,22 @@ Selection range in the current pattern --- ## Properties -### end_column : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#end_column} +### end_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#end_column} End column index within end_track -### end_line : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#end_line} +### end_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#end_line} End pattern line index -### end_track : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#end_track} +### end_track : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#end_track} End track index -### start_column : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#start_column} +### start_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#start_column} Start column index within start_track -### start_line : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#start_line} +### start_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#start_line} Start pattern line index -### start_track : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#start_track} +### start_track : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#start_track} Start track index @@ -464,16 +464,16 @@ Selection range in the current phrase --- ## Properties -### end_column : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#end_column} +### end_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#end_column} End column index within end_track -### end_line : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#end_line} +### end_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#end_line} End pattern line index -### start_column : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#start_column} +### start_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#start_column} Start column index within start_track -### start_line : [`integer`](/API/builtins/integer.md)[`?`](/API/builtins/nil.md) {#start_line} +### start_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) {#start_line} Start pattern line index @@ -486,7 +486,7 @@ Start pattern line index ### bit_depth : `16` | `24` | `32` {#bit_depth} by default 32. -### end_pos : [`renoise.SongPos`](/API/renoise/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} @@ -498,7 +498,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/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/renoise/renoise.SongPos.md b/docs/API/renoise/renoise.SongPos.md index eb73637..1e6809d 100644 --- a/docs/API/renoise/renoise.SongPos.md +++ b/docs/API/renoise/renoise.SongPos.md @@ -3,10 +3,10 @@ Helper class used in Transport and Song, representing a position in the song. --- ## Properties -### line : [`integer`](/API/builtins/integer.md) {#line} +### line : [`integer`](../../API/builtins/integer.md) {#line} Position in the pattern at the given pattern sequence. -### sequence : [`integer`](/API/builtins/integer.md) {#sequence} +### sequence : [`integer`](../../API/builtins/integer.md) {#sequence} Position in the pattern sequence. diff --git a/docs/API/renoise/renoise.Track.md b/docs/API/renoise/renoise.Track.md index ffcb257..177a861 100644 --- a/docs/API/renoise/renoise.Track.md +++ b/docs/API/renoise/renoise.Track.md @@ -25,16 +25,16 @@ Track component of a Renoise song. ### available_device_infos : [`AudioDeviceInfo`](#audiodeviceinfo)`[]` {#available_device_infos} **READ-ONLY** Array of tables containing information about the devices. -### available_devices : [`string`](/API/builtins/string.md)`[]` {#available_devices} +### available_devices : [`string`](../../API/builtins/string.md)`[]` {#available_devices} **READ-ONLY** FX devices this track can handle. -### available_output_routings : [`string`](/API/builtins/string.md)`[]` {#available_output_routings} +### available_output_routings : [`string`](../../API/builtins/string.md)`[]` {#available_output_routings} **READ-ONLY** -### collapsed : [`boolean`](/API/builtins/boolean.md) {#collapsed} +### collapsed : [`boolean`](../../API/builtins/boolean.md) {#collapsed} Collapsed/expanded visual appearance. -### collapsed_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#collapsed_observable} +### collapsed_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#collapsed_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -44,122 +44,122 @@ 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 -### color_blend : [`integer`](/API/builtins/integer.md) {#color_blend} +### color_blend : [`integer`](../../API/builtins/integer.md) {#color_blend} Range: (0 - 100) Color blend in percent -### color_blend_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_blend_observable} +### color_blend_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#color_blend_observable} Track changes to document properties or general states by attaching listener functions to it. -### color_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#color_observable} +### color_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#color_observable} Track changes to document properties or general states by attaching listener functions to it. -### delay_column_visible : [`boolean`](/API/builtins/boolean.md) {#delay_column_visible} -### delay_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} +### delay_column_visible : [`boolean`](../../API/builtins/boolean.md) {#delay_column_visible} +### delay_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#delay_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### devices : [`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md)`[]` {#devices} +### devices : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md)`[]` {#devices} **READ-ONLY** List of audio DSP FX. -### devices_observable : [`renoise.Document.ObservableList`](/API/renoise/renoise.Document.ObservableList.md) {#devices_observable} +### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) {#devices_observable} Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists **layout** (items got added, removed, swapped). -### group_parent : [`renoise.GroupTrack`](/API/renoise/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} +### max_effect_columns : [`integer`](../../API/builtins/integer.md) {#max_effect_columns} **READ-ONLY** 8 OR 0 depending on the track type -### max_note_columns : [`integer`](/API/builtins/integer.md) {#max_note_columns} +### max_note_columns : [`integer`](../../API/builtins/integer.md) {#max_note_columns} **READ-ONLY** 12 OR 0 depending on the track type -### min_effect_columns : [`integer`](/API/builtins/integer.md) {#min_effect_columns} +### min_effect_columns : [`integer`](../../API/builtins/integer.md) {#min_effect_columns} **READ-ONLY** 1 OR 0 depending on the track type -### min_note_columns : [`integer`](/API/builtins/integer.md) {#min_note_columns} +### min_note_columns : [`integer`](../../API/builtins/integer.md) {#min_note_columns} **READ-ONLY** 1 OR 0 depending on the track type ### 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/renoise.Document.Observable.md) {#mute_state_observable} +### mute_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#mute_state_observable} Track changes to document properties or general states by attaching listener functions to it. -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} Name, as visible in track headers -### name_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#name_observable} +### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#name_observable} Track changes to document properties or general states by attaching listener functions to it. -### output_delay : [`number`](/API/builtins/number.md) {#output_delay} +### output_delay : [`number`](../../API/builtins/number.md) {#output_delay} Range: (-100.0-100.0) in ms -### output_delay_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_delay_observable} +### output_delay_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#output_delay_observable} Track changes to document properties or general states by attaching listener functions to it. -### output_routing : [`string`](/API/builtins/string.md) {#output_routing} +### output_routing : [`string`](../../API/builtins/string.md) {#output_routing} One of `available_output_routings` -### output_routing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#output_routing_observable} +### output_routing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#output_routing_observable} Track changes to document properties or general states by attaching listener functions to it. -### panning_column_visible : [`boolean`](/API/builtins/boolean.md) {#panning_column_visible} -### panning_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} +### panning_column_visible : [`boolean`](../../API/builtins/boolean.md) {#panning_column_visible} +### panning_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#panning_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### postfx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_panning} +### postfx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#postfx_panning} **READ-ONLY** -### postfx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#postfx_volume} +### postfx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#postfx_volume} **READ-ONLY** -### prefx_panning : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_panning} +### prefx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#prefx_panning} **READ-ONLY** -### prefx_volume : [`renoise.DeviceParameter`](/API/renoise/renoise.DeviceParameter.md) {#prefx_volume} +### prefx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) {#prefx_volume} **READ-ONLY** -### prefx_width : [`renoise.DeviceParameter`](/API/renoise/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/renoise.Document.Observable.md) {#sample_effects_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/renoise.Document.Observable.md) {#sample_effects_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. -### solo_state : [`boolean`](/API/builtins/boolean.md) {#solo_state} -### solo_state_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#solo_state_observable} +### solo_state : [`boolean`](../../API/builtins/boolean.md) {#solo_state} +### solo_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#solo_state_observable} Track changes to document properties or general states by attaching listener functions to it. ### type : [`renoise.Track.TrackType`](renoise.Track.md#TrackType) {#type} **READ-ONLY** -### visible_effect_columns : [`integer`](/API/builtins/integer.md) {#visible_effect_columns} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### visible_note_columns : [`integer`](/API/builtins/integer.md) {#visible_note_columns} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### volume_column_visible : [`boolean`](/API/builtins/boolean.md) {#volume_column_visible} -### volume_column_visible_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} +### volume_column_visible : [`boolean`](../../API/builtins/boolean.md) {#volume_column_visible} +### volume_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#volume_column_visible_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -167,45 +167,45 @@ functions to it. --- ## Functions -### `column_is_muted`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md)) {#column_is_muted} -`->`[`boolean`](/API/builtins/boolean.md) +### `column_is_muted`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) {#column_is_muted} +`->`[`boolean`](../../API/builtins/boolean.md) 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/renoise.Document.Observable.md) +### `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/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) +### `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/renoise.Document.Observable.md) +### `column_name_observable`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) {#column_name_observable} +`->`[`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_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. -### `device`([*self*](/API/builtins/self.md), device_index : [`integer`](/API/builtins/integer.md)) {#device} -`->`[`renoise.AudioDevice`](/API/renoise/renoise.AudioDevice.md) +### `device`([*self*](../../API/builtins/self.md), device_index : [`integer`](../../API/builtins/integer.md)) {#device} +`->`[`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. -### `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/renoise.AudioDevice.md) +### `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/renoise.AudioDevice.md) Insert a new device at the given position. `device_path` must be one of `renoise.Track.available_devices`. -### `mute`([*self*](/API/builtins/self.md)) {#mute} +### `mute`([*self*](../../API/builtins/self.md)) {#mute} Uses default mute state from the prefs. Not for the master track. -### `set_column_is_muted`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md), muted : [`boolean`](/API/builtins/boolean.md)) {#set_column_is_muted} -### `set_column_name`([*self*](/API/builtins/self.md), column_index : [`integer`](/API/builtins/integer.md), name : [`string`](/API/builtins/string.md)) {#set_column_name} -### `solo`([*self*](/API/builtins/self.md)) {#solo} -### `swap_devices_at`([*self*](/API/builtins/self.md), device_index1 : [`integer`](/API/builtins/integer.md), device_index2 : [`integer`](/API/builtins/integer.md)) {#swap_devices_at} +### `set_column_is_muted`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), muted : [`boolean`](../../API/builtins/boolean.md)) {#set_column_is_muted} +### `set_column_name`([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), name : [`string`](../../API/builtins/string.md)) {#set_column_name} +### `solo`([*self*](../../API/builtins/self.md)) {#solo} +### `swap_devices_at`([*self*](../../API/builtins/self.md), device_index1 : [`integer`](../../API/builtins/integer.md), device_index2 : [`integer`](../../API/builtins/integer.md)) {#swap_devices_at} Swap the positions of two devices in the device chain. The mixer device at index 1 can not be swapped or moved. -### `swap_effect_columns_at`([*self*](/API/builtins/self.md), column_index1 : [`integer`](/API/builtins/integer.md), column_index2 : [`integer`](/API/builtins/integer.md)) {#swap_effect_columns_at} -### `swap_note_columns_at`([*self*](/API/builtins/self.md), column_index1 : [`integer`](/API/builtins/integer.md), column_index2 : [`integer`](/API/builtins/integer.md)) {#swap_note_columns_at} +### `swap_effect_columns_at`([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) {#swap_effect_columns_at} +### `swap_note_columns_at`([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) {#swap_note_columns_at} Swap the positions of two note or effect columns within a track. -### `unmute`([*self*](/API/builtins/self.md)) {#unmute} +### `unmute`([*self*](../../API/builtins/self.md)) {#unmute} @@ -216,22 +216,22 @@ Audio device info --- ## Properties -### favorite_name : [`string`](/API/builtins/string.md) {#favorite_name} +### favorite_name : [`string`](../../API/builtins/string.md) {#favorite_name} The device's name as displayed in favorites -### is_bridged : [`boolean`](/API/builtins/boolean.md) {#is_bridged} +### is_bridged : [`boolean`](../../API/builtins/boolean.md) {#is_bridged} true if the device is a bridged plugin -### is_favorite : [`boolean`](/API/builtins/boolean.md) {#is_favorite} +### is_favorite : [`boolean`](../../API/builtins/boolean.md) {#is_favorite} true if the device is a favorite -### name : [`string`](/API/builtins/string.md) {#name} +### name : [`string`](../../API/builtins/string.md) {#name} The device's name -### path : [`string`](/API/builtins/string.md) {#path} +### path : [`string`](../../API/builtins/string.md) {#path} The device's path used by `renoise.Track:insert_device_at` -### short_name : [`string`](/API/builtins/string.md) {#short_name} +### short_name : [`string`](../../API/builtins/string.md) {#short_name} The device's name as displayed in shortened lists @@ -243,7 +243,7 @@ The device's name as displayed in shortened lists --- ## Aliases # alias RGBColor {#RGBColor} -{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +{ 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 diff --git a/docs/API/renoise/renoise.Transport.md b/docs/API/renoise/renoise.Transport.md index e06e6a0..afcf945 100644 --- a/docs/API/renoise/renoise.Transport.md +++ b/docs/API/renoise/renoise.Transport.md @@ -26,202 +26,202 @@ Transport component of the Renoise song. --- ## Properties -### bpm : [`number`](/API/builtins/number.md) {#bpm} +### bpm : [`number`](../../API/builtins/number.md) {#bpm} Range: (32 - 999) Beats per Minute -### bpm_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#bpm_observable} +### bpm_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#bpm_observable} Track changes to document properties or general states by attaching listener functions to it. -### edit_mode : [`boolean`](/API/builtins/boolean.md) {#edit_mode} +### edit_mode : [`boolean`](../../API/builtins/boolean.md) {#edit_mode} Edit modes -### edit_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#edit_mode_observable} +### edit_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#edit_mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### edit_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#edit_pos} +### edit_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) {#edit_pos} Edit position -### edit_pos_beats : [`number`](/API/builtins/number.md) {#edit_pos_beats} +### edit_pos_beats : [`number`](../../API/builtins/number.md) {#edit_pos_beats} Range: (0 - song_end_beats) Song position in beats -### edit_step : [`integer`](/API/builtins/integer.md) {#edit_step} +### edit_step : [`integer`](../../API/builtins/integer.md) {#edit_step} Range: (0 - 64) -### edit_step_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#edit_step_observable} +### edit_step_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#edit_step_observable} Track changes to document properties or general states by attaching listener functions to it. -### follow_player : [`boolean`](/API/builtins/boolean.md) {#follow_player} +### follow_player : [`boolean`](../../API/builtins/boolean.md) {#follow_player} Follow, wrapped pattern, single track modes -### follow_player_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#follow_player_observable} +### follow_player_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#follow_player_observable} Track changes to document properties or general states by attaching listener functions to it. -### groove_amounts : [`number`](/API/builtins/number.md)`[]` {#groove_amounts} +### 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/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_enabled : [`boolean`](../../API/builtins/boolean.md) {#groove_enabled} Groove. (aka Shuffle) -### groove_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#groove_enabled_observable} +### groove_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#groove_enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### keyboard_velocity : [`integer`](/API/builtins/integer.md) {#keyboard_velocity} +### keyboard_velocity : [`integer`](../../API/builtins/integer.md) {#keyboard_velocity} Range: (0 - 127) -### keyboard_velocity_enabled : [`boolean`](/API/builtins/boolean.md) {#keyboard_velocity_enabled} +### keyboard_velocity_enabled : [`boolean`](../../API/builtins/boolean.md) {#keyboard_velocity_enabled} Computer Keyboard Velocity. -### keyboard_velocity_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#keyboard_velocity_enabled_observable} +### keyboard_velocity_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#keyboard_velocity_enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### keyboard_velocity_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#keyboard_velocity_observable} +### keyboard_velocity_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#keyboard_velocity_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_block_enabled : [`boolean`](/API/builtins/boolean.md) {#loop_block_enabled} +### 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} +### loop_block_range_coeff : [`integer`](../../API/builtins/integer.md) {#loop_block_range_coeff} Range: (2 - 16) -### loop_block_start_pos : [`renoise.SongPos`](/API/renoise/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/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} +### loop_end_beats : [`number`](../../API/builtins/number.md) {#loop_end_beats} **READ-ONLY** Range: (0 - song_end_beats) -### loop_pattern : [`boolean`](/API/builtins/boolean.md) {#loop_pattern} +### loop_pattern : [`boolean`](../../API/builtins/boolean.md) {#loop_pattern} Pattern Loop On/Off -### loop_pattern_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#loop_pattern_observable} +### loop_pattern_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#loop_pattern_observable} Track changes to document properties or general states by attaching listener functions to it. -### loop_range : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md)`[]` {#loop_range} +### 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} +### loop_range_beats : [`number`](../../API/builtins/number.md)`[]` {#loop_range_beats} {loop start beats, loop end beats} -### loop_sequence_end : [`integer`](/API/builtins/integer.md) {#loop_sequence_end} +### loop_sequence_end : [`integer`](../../API/builtins/integer.md) {#loop_sequence_end} **READ-ONLY** 0 or Range: (1 - sequence length) -### loop_sequence_range : [`integer`](/API/builtins/integer.md)`[]` {#loop_sequence_range} +### loop_sequence_range : [`integer`](../../API/builtins/integer.md)`[]` {#loop_sequence_range} {} or Range(sequence start, sequence end) -### loop_sequence_start : [`integer`](/API/builtins/integer.md) {#loop_sequence_start} +### 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/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} +### loop_start_beats : [`number`](../../API/builtins/number.md) {#loop_start_beats} **READ-ONLY** Range: (0 - song_end_beats) -### lpb : [`integer`](/API/builtins/integer.md) {#lpb} +### lpb : [`integer`](../../API/builtins/integer.md) {#lpb} Range: (1 - 256) Lines per Beat -### lpb_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#lpb_observable} +### lpb_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#lpb_observable} Track changes to document properties or general states by attaching listener functions to it. -### metronome_beats_per_bar : [`integer`](/API/builtins/integer.md) {#metronome_beats_per_bar} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### metronome_enabled : [`boolean`](/API/builtins/boolean.md) {#metronome_enabled} +### metronome_enabled : [`boolean`](../../API/builtins/boolean.md) {#metronome_enabled} Metronome -### metronome_enabled_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#metronome_enabled_observable} +### metronome_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#metronome_enabled_observable} Track changes to document properties or general states by attaching listener functions to it. -### metronome_lines_per_beat : [`integer`](/API/builtins/integer.md) {#metronome_lines_per_beat} +### 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/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} Track changes to document properties or general states by attaching listener functions to it. -### metronome_precount_bars : [`integer`](/API/builtins/integer.md) {#metronome_precount_bars} +### metronome_precount_bars : [`integer`](../../API/builtins/integer.md) {#metronome_precount_bars} Range: (1 - 4) -### metronome_precount_bars_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### metronome_precount_enabled : [`boolean`](/API/builtins/boolean.md) {#metronome_precount_enabled} +### metronome_precount_enabled : [`boolean`](../../API/builtins/boolean.md) {#metronome_precount_enabled} Metronome precount -### metronome_precount_enabled_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### octave : [`integer`](/API/builtins/integer.md) {#octave} +### octave : [`integer`](../../API/builtins/integer.md) {#octave} Range: (0 - 8) -### octave_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#octave_observable} +### octave_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#octave_observable} Track changes to document properties or general states by attaching listener functions to it. -### playback_pos : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#playback_pos} +### playback_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) {#playback_pos} Playback position -### playback_pos_beats : [`number`](/API/builtins/number.md) {#playback_pos_beats} +### playback_pos_beats : [`number`](../../API/builtins/number.md) {#playback_pos_beats} Range: (0 - song_end_beats) Song position in beats -### playing : [`boolean`](/API/builtins/boolean.md) {#playing} +### playing : [`boolean`](../../API/builtins/boolean.md) {#playing} Playing -### playing_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#playing_observable} +### playing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#playing_observable} Track changes to document properties or general states by attaching listener functions to it. ### record_parameter_mode : [`renoise.Transport.RecordParameterMode`](renoise.Transport.md#RecordParameterMode) {#record_parameter_mode} Record parameter -### record_parameter_mode_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### record_quantize_enabled : [`boolean`](/API/builtins/boolean.md) {#record_quantize_enabled} +### record_quantize_enabled : [`boolean`](../../API/builtins/boolean.md) {#record_quantize_enabled} Quantize -### record_quantize_enabled_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### record_quantize_lines : [`integer`](/API/builtins/integer.md) {#record_quantize_lines} +### record_quantize_lines : [`integer`](../../API/builtins/integer.md) {#record_quantize_lines} Range: (1 - 32) -### record_quantize_lines_observable : [`renoise.Document.Observable`](/API/renoise/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} Track changes to document properties or general states by attaching listener functions to it. -### single_track_edit_mode : [`boolean`](/API/builtins/boolean.md) {#single_track_edit_mode} -### single_track_edit_mode_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#single_track_edit_mode_observable} +### single_track_edit_mode : [`boolean`](../../API/builtins/boolean.md) {#single_track_edit_mode} +### single_track_edit_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#single_track_edit_mode_observable} Track changes to document properties or general states by attaching listener functions to it. -### song_length : [`renoise.SongPos`](/API/renoise/renoise.SongPos.md) {#song_length} +### song_length : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) {#song_length} **READ-ONLY** -### song_length_beats : [`number`](/API/builtins/number.md) {#song_length_beats} +### song_length_beats : [`number`](../../API/builtins/number.md) {#song_length_beats} **READ-ONLY** ### timing_model : [`renoise.Transport.TimingModel`](renoise.Transport.md#TimingModel) {#timing_model} @@ -230,22 +230,22 @@ With `TIMING_MODEL_SPEED`, tpl is used as speed factor. The lpb property is unused then. With `TIMING_MODEL_LPB`, tpl is used as event rate for effects only and lpb defines relationship between pattern lines and beats. -### tpl : [`integer`](/API/builtins/integer.md) {#tpl} +### tpl : [`integer`](../../API/builtins/integer.md) {#tpl} Range: (1 - 16) Ticks per Line -### tpl_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#tpl_observable} +### tpl_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#tpl_observable} Track changes to document properties or general states by attaching listener functions to it. -### track_headroom : [`number`](/API/builtins/number.md) {#track_headroom} +### track_headroom : [`number`](../../API/builtins/number.md) {#track_headroom} Range: (math.db2lin(-12) - math.db2lin(0)) -### track_headroom_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#track_headroom_observable} +### track_headroom_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#track_headroom_observable} Track changes to document properties or general states by attaching listener functions to it. -### wrapped_pattern_edit : [`boolean`](/API/builtins/boolean.md) {#wrapped_pattern_edit} -### wrapped_pattern_edit_observable : [`renoise.Document.Observable`](/API/renoise/renoise.Document.Observable.md) {#wrapped_pattern_edit_observable} +### wrapped_pattern_edit : [`boolean`](../../API/builtins/boolean.md) {#wrapped_pattern_edit} +### wrapped_pattern_edit_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) {#wrapped_pattern_edit_observable} Track changes to document properties or general states by attaching listener functions to it. @@ -253,31 +253,31 @@ functions to it. --- ## Functions -### `add_scheduled_sequence`([*self*](/API/builtins/self.md), sequence_pos : [`integer`](/API/builtins/integer.md)) {#add_scheduled_sequence} +### `add_scheduled_sequence`([*self*](../../API/builtins/self.md), sequence_pos : [`integer`](../../API/builtins/integer.md)) {#add_scheduled_sequence} Append the sequence to the scheduled sequence list. Scheduled playback positions will apply as soon as the currently playing pattern play to end. -### `cancel_sample_recording`([*self*](/API/builtins/self.md)) {#cancel_sample_recording} +### `cancel_sample_recording`([*self*](../../API/builtins/self.md)) {#cancel_sample_recording} Cancel a currently running sample recording when the sample dialog is visible, otherwise do nothing. -### `loop_block_move_backwards`([*self*](/API/builtins/self.md)) {#loop_block_move_backwards} +### `loop_block_move_backwards`([*self*](../../API/builtins/self.md)) {#loop_block_move_backwards} Move the block loop one segment backwards, when possible. -### `loop_block_move_forwards`([*self*](/API/builtins/self.md)) {#loop_block_move_forwards} +### `loop_block_move_forwards`([*self*](../../API/builtins/self.md)) {#loop_block_move_forwards} Move the block loop one segment forwards, when possible. -### `panic`([*self*](/API/builtins/self.md)) {#panic} +### `panic`([*self*](../../API/builtins/self.md)) {#panic} Panic. -### `set_scheduled_sequence`([*self*](/API/builtins/self.md), sequence_pos : [`integer`](/API/builtins/integer.md)) {#set_scheduled_sequence} +### `set_scheduled_sequence`([*self*](../../API/builtins/self.md), sequence_pos : [`integer`](../../API/builtins/integer.md)) {#set_scheduled_sequence} Replace the scheduled sequence list with the given sequence. -### `start`([*self*](/API/builtins/self.md), mode : [`renoise.Transport.PlayMode`](renoise.Transport.md#PlayMode)) {#start} +### `start`([*self*](../../API/builtins/self.md), mode : [`renoise.Transport.PlayMode`](renoise.Transport.md#PlayMode)) {#start} Start playing in song or pattern mode. -### `start_at`([*self*](/API/builtins/self.md), line : [`integer`](/API/builtins/integer.md)) {#start_at} +### `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/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_stop_sample_recording`([*self*](../../API/builtins/self.md)) {#start_stop_sample_recording} Start a new sample recording when the sample dialog is visible, otherwise stop and finish it. -### `stop`([*self*](/API/builtins/self.md)) {#stop} +### `stop`([*self*](../../API/builtins/self.md)) {#stop} Stop playing. When already stopped this just stops all playing notes. -### `trigger_sequence`([*self*](/API/builtins/self.md), sequence_pos : [`integer`](/API/builtins/integer.md)) {#trigger_sequence} +### `trigger_sequence`([*self*](../../API/builtins/self.md), sequence_pos : [`integer`](../../API/builtins/integer.md)) {#trigger_sequence} Immediately start playing at the given sequence position. diff --git a/docs/API/renoise/renoise.ViewBuilder.md b/docs/API/renoise/renoise.ViewBuilder.md index d914d9c..56b8413 100644 --- a/docs/API/renoise/renoise.ViewBuilder.md +++ b/docs/API/renoise/renoise.ViewBuilder.md @@ -2,25 +2,25 @@ --- ## Properties -### DEFAULT_CONTROL_HEIGHT : [`integer`](/API/builtins/integer.md) {#DEFAULT_CONTROL_HEIGHT} +### DEFAULT_CONTROL_HEIGHT : [`integer`](../../API/builtins/integer.md) {#DEFAULT_CONTROL_HEIGHT} The default height for control views -### DEFAULT_CONTROL_MARGIN : [`integer`](/API/builtins/integer.md) {#DEFAULT_CONTROL_MARGIN} +### DEFAULT_CONTROL_MARGIN : [`integer`](../../API/builtins/integer.md) {#DEFAULT_CONTROL_MARGIN} The default margin for all control views -### DEFAULT_CONTROL_SPACING : [`integer`](/API/builtins/integer.md) {#DEFAULT_CONTROL_SPACING} +### DEFAULT_CONTROL_SPACING : [`integer`](../../API/builtins/integer.md) {#DEFAULT_CONTROL_SPACING} The default spacing for all control views -### DEFAULT_DIALOG_BUTTON_HEIGHT : [`integer`](/API/builtins/integer.md) {#DEFAULT_DIALOG_BUTTON_HEIGHT} +### DEFAULT_DIALOG_BUTTON_HEIGHT : [`integer`](../../API/builtins/integer.md) {#DEFAULT_DIALOG_BUTTON_HEIGHT} The default height for buttons -### DEFAULT_DIALOG_MARGIN : [`integer`](/API/builtins/integer.md) {#DEFAULT_DIALOG_MARGIN} +### DEFAULT_DIALOG_MARGIN : [`integer`](../../API/builtins/integer.md) {#DEFAULT_DIALOG_MARGIN} The default margin for dialogs -### DEFAULT_DIALOG_SPACING : [`integer`](/API/builtins/integer.md) {#DEFAULT_DIALOG_SPACING} +### DEFAULT_DIALOG_SPACING : [`integer`](../../API/builtins/integer.md) {#DEFAULT_DIALOG_SPACING} The default spacing for dialogs -### DEFAULT_MINI_CONTROL_HEIGHT : [`integer`](/API/builtins/integer.md) {#DEFAULT_MINI_CONTROL_HEIGHT} +### DEFAULT_MINI_CONTROL_HEIGHT : [`integer`](../../API/builtins/integer.md) {#DEFAULT_MINI_CONTROL_HEIGHT} The default height for mini-sliders diff --git a/docs/API/renoise/renoise.Views.Aligner.md b/docs/API/renoise/renoise.Views.Aligner.md index 300f64e..a0e1d2b 100644 --- a/docs/API/renoise/renoise.Views.Aligner.md +++ b/docs/API/renoise/renoise.Views.Aligner.md @@ -31,7 +31,7 @@ rows, vertically in columns). 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/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 @@ -51,9 +51,9 @@ 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/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/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. @@ -75,30 +75,30 @@ AlignerMode: ``` # alias RackMargin {#RackMargin} -[`integer`](/API/builtins/integer.md) +[`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) +[`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 ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Bitmap.md b/docs/API/renoise/renoise.Views.Bitmap.md index 38b17a0..2c1b3b1 100644 --- a/docs/API/renoise/renoise.Views.Bitmap.md +++ b/docs/API/renoise/renoise.Views.Bitmap.md @@ -48,7 +48,7 @@ Setup how the bitmap should be drawn, recolored. Available modes are: 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/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 @@ -68,13 +68,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_notifier} Add mouse click notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#remove_notifier} Remove mouse click notifier @@ -82,7 +82,7 @@ Remove mouse click notifier --- ## Aliases # alias BitmapImagePath {#BitmapImagePath} -[`string`](/API/builtins/string.md) +[`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" @@ -118,14 +118,14 @@ BitmapMode: Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -138,19 +138,19 @@ fun() # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Button.md b/docs/API/renoise/renoise.Views.Button.md index 7bddc4f..a4f6d52 100644 --- a/docs/API/renoise/renoise.Views.Button.md +++ b/docs/API/renoise/renoise.Views.Button.md @@ -52,7 +52,7 @@ The text label of the button 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/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 @@ -72,26 +72,26 @@ 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/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. -### `add_pressed_notifier`([*self*](/API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_pressed_notifier} +### `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_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/renoise.Views.View.md)) {#remove_child} +### `add_released_notifier`([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) {#add_released_notifier} +### `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. -### `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} +### `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) +[`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" @@ -128,19 +128,19 @@ always visible. Set color {0,0,0} to enable the theme colors for the button again. # alias ButtonLabel {#ButtonLabel} -[`string`](/API/builtins/string.md) +[`string`](../../API/builtins/string.md) The text label of the button * Default: "" # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -153,26 +153,26 @@ fun() # alias RGBColor {#RGBColor} -{ 1 : [`integer`](/API/builtins/integer.md), 2 : [`integer`](/API/builtins/integer.md), 3 : [`integer`](/API/builtins/integer.md) } +{ 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 # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.CheckBox.md b/docs/API/renoise/renoise.Views.CheckBox.md index c9f0582..3f483f0 100644 --- a/docs/API/renoise/renoise.Views.CheckBox.md +++ b/docs/API/renoise/renoise.Views.CheckBox.md @@ -37,7 +37,7 @@ A tooltip text that should be shown for this view on mouse hover. The current state of the checkbox, expressed as boolean. * Default: false -### views : [`renoise.Views.View`](/API/renoise/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 @@ -57,13 +57,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -71,23 +71,23 @@ Remove value change notifier --- ## Aliases # alias BooleanValueNotifierFunction {#BooleanValueNotifierFunction} -(value : [`boolean`](/API/builtins/boolean.md)) +(value : [`boolean`](../../API/builtins/boolean.md)) # alias CheckBoxBoolean {#CheckBoxBoolean} -[`boolean`](/API/builtins/boolean.md) +[`boolean`](../../API/builtins/boolean.md) The current state of the checkbox, expressed as boolean. * Default: false # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -96,19 +96,19 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Chooser.md b/docs/API/renoise/renoise.Views.Chooser.md index 77a1b99..57bdbd3 100644 --- a/docs/API/renoise/renoise.Views.Chooser.md +++ b/docs/API/renoise/renoise.Views.Chooser.md @@ -39,7 +39,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SelectedItem`](#SelectedItem) {#value} The currently selected item's index -### views : [`renoise.Views.View`](/API/renoise/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 @@ -59,13 +59,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} Add index change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} Remove index change notifier @@ -73,14 +73,14 @@ Remove index change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -89,31 +89,31 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} -(value : [`integer`](/API/builtins/integer.md)) +(value : [`integer`](../../API/builtins/integer.md)) # alias ItemLabels {#ItemLabels} -[`string`](/API/builtins/string.md)`[]` +[`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) +[`integer`](../../API/builtins/integer.md) The currently selected item's index # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Control.md b/docs/API/renoise/renoise.Views.Control.md index 301e611..87a2429 100644 --- a/docs/API/renoise/renoise.Views.Control.md +++ b/docs/API/renoise/renoise.Views.Control.md @@ -28,7 +28,7 @@ message will do nothing and no error is fired. 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/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 @@ -48,9 +48,9 @@ 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/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/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. @@ -58,14 +58,14 @@ Remove a child view from this view. --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -74,19 +74,19 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.MiniSlider.md b/docs/API/renoise/renoise.Views.MiniSlider.md index 10aeae0..40e8536 100644 --- a/docs/API/renoise/renoise.Views.MiniSlider.md +++ b/docs/API/renoise/renoise.Views.MiniSlider.md @@ -46,7 +46,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SliderNumberValue`](#SliderNumberValue) {#value} The current value of the view -### views : [`renoise.Views.View`](/API/renoise/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 @@ -66,13 +66,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -80,14 +80,14 @@ Remove value change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -96,41 +96,41 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) +(value : [`number`](../../API/builtins/number.md)) # alias SliderDefaultValue {#SliderDefaultValue} -[`number`](/API/builtins/number.md) +[`number`](../../API/builtins/number.md) The default value that will be re-applied on double-click # alias SliderMaxValue {#SliderMaxValue} -[`number`](/API/builtins/number.md) +[`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) +[`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) +[`number`](../../API/builtins/number.md) The current value of the view # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.MultiLineText.md b/docs/API/renoise/renoise.Views.MultiLineText.md index 410b132..8dc2a08 100644 --- a/docs/API/renoise/renoise.Views.MultiLineText.md +++ b/docs/API/renoise/renoise.Views.MultiLineText.md @@ -41,7 +41,7 @@ paragraphs. 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/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 @@ -61,18 +61,18 @@ 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/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. -### `add_line`([*self*](/API/builtins/self.md), text : [`string`](/API/builtins/string.md)) {#add_line} +### `add_line`([*self*](../../API/builtins/self.md), text : [`string`](../../API/builtins/string.md)) {#add_line} Append text to the existing text. Newlines in the text will create new paragraphs, just like in the "text" property. -### `clear`([*self*](/API/builtins/self.md)) {#clear} +### `clear`([*self*](../../API/builtins/self.md)) {#clear} Clear the whole text, same as multiline_text.text="". -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `scroll_to_first_line`([*self*](/API/builtins/self.md)) {#scroll_to_first_line} +### `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} +### `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. @@ -102,31 +102,31 @@ TextFontStyle: ``` # alias TextMultilineString {#TextMultilineString} -[`string`](/API/builtins/string.md) +[`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)`[]` +[`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 ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.MultiLineTextField.md b/docs/API/renoise/renoise.Views.MultiLineTextField.md index 5475d41..0c50b29 100644 --- a/docs/API/renoise/renoise.Views.MultiLineTextField.md +++ b/docs/API/renoise/renoise.Views.MultiLineTextField.md @@ -51,7 +51,7 @@ The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs. -### views : [`renoise.Views.View`](/API/renoise/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 @@ -71,22 +71,22 @@ 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/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. -### `add_line`([*self*](/API/builtins/self.md), text : [`string`](/API/builtins/string.md)) {#add_line} +### `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_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`([*self*](../../API/builtins/self.md)) {#clear} Clear the whole text. -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#remove_notifier} +### `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} +### `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} +### `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. @@ -94,11 +94,11 @@ When a scroll bar is visible, scroll the text to show the last line. --- ## Aliases # alias StringValueNotifierFunction {#StringValueNotifierFunction} -(value : [`string`](/API/builtins/string.md)) +(value : [`string`](../../API/builtins/string.md)) # alias TextActive {#TextActive} -[`boolean`](/API/builtins/boolean.md) +[`boolean`](../../API/builtins/boolean.md) When false, text is displayed but can not be entered/modified by the user. * Default: true @@ -113,7 +113,7 @@ TextBackgroundStyle: ``` # alias TextEditMode {#TextEditMode} -[`boolean`](/API/builtins/boolean.md) +[`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 @@ -131,36 +131,36 @@ TextFontStyle: ``` # alias TextMultilineString {#TextMultilineString} -[`string`](/API/builtins/string.md) +[`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)`[]` +[`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) +[`string`](../../API/builtins/string.md) Exactly the same as "value"; provided for consistency. * Default: "" # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Popup.md b/docs/API/renoise/renoise.Views.Popup.md index 7015e36..f4f4273 100644 --- a/docs/API/renoise/renoise.Views.Popup.md +++ b/docs/API/renoise/renoise.Views.Popup.md @@ -40,7 +40,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SelectedItem`](#SelectedItem) {#value} The currently selected item's index -### views : [`renoise.Views.View`](/API/renoise/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 @@ -60,13 +60,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} Add index change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} Remove index change notifier @@ -74,14 +74,14 @@ Remove index change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -90,32 +90,32 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} -(value : [`integer`](/API/builtins/integer.md)) +(value : [`integer`](../../API/builtins/integer.md)) # alias PopupItemLabels {#PopupItemLabels} -[`string`](/API/builtins/string.md)`[]` +[`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) +[`integer`](../../API/builtins/integer.md) The currently selected item's index # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Rack.md b/docs/API/renoise/renoise.Views.Rack.md index 2409ad4..99ec3d8 100644 --- a/docs/API/renoise/renoise.Views.Rack.md +++ b/docs/API/renoise/renoise.Views.Rack.md @@ -35,7 +35,7 @@ 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 -### views : [`renoise.Views.View`](/API/renoise/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 @@ -55,9 +55,9 @@ 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/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/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. @@ -65,18 +65,18 @@ Remove a child view from this view. --- ## Aliases # alias RackMargin {#RackMargin} -[`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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 @@ -98,19 +98,19 @@ ViewBackgroundStyle: ``` # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.RotaryEncoder.md b/docs/API/renoise/renoise.Views.RotaryEncoder.md index ed36485..c1a9add 100644 --- a/docs/API/renoise/renoise.Views.RotaryEncoder.md +++ b/docs/API/renoise/renoise.Views.RotaryEncoder.md @@ -51,7 +51,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SliderNumberValue`](#SliderNumberValue) {#value} The current value of the view -### views : [`renoise.Views.View`](/API/renoise/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 @@ -71,13 +71,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -85,14 +85,14 @@ Remove value change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -101,41 +101,41 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) +(value : [`number`](../../API/builtins/number.md)) # alias SliderDefaultValue {#SliderDefaultValue} -[`number`](/API/builtins/number.md) +[`number`](../../API/builtins/number.md) The default value that will be re-applied on double-click # alias SliderMaxValue {#SliderMaxValue} -[`number`](/API/builtins/number.md) +[`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) +[`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) +[`number`](../../API/builtins/number.md) The current value of the view # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Slider.md b/docs/API/renoise/renoise.Views.Slider.md index b9e546f..2c81b05 100644 --- a/docs/API/renoise/renoise.Views.Slider.md +++ b/docs/API/renoise/renoise.Views.Slider.md @@ -54,7 +54,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SliderNumberValue`](#SliderNumberValue) {#value} The current value of the view -### views : [`renoise.Views.View`](/API/renoise/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 @@ -74,13 +74,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -88,14 +88,14 @@ Remove value change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -104,48 +104,48 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) +(value : [`number`](../../API/builtins/number.md)) # alias SliderDefaultValue {#SliderDefaultValue} -[`number`](/API/builtins/number.md) +[`number`](../../API/builtins/number.md) The default value that will be re-applied on double-click # alias SliderMaxValue {#SliderMaxValue} -[`number`](/API/builtins/number.md) +[`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) +[`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) +[`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) } +{ 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 ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Switch.md b/docs/API/renoise/renoise.Views.Switch.md index 2161180..19a068c 100644 --- a/docs/API/renoise/renoise.Views.Switch.md +++ b/docs/API/renoise/renoise.Views.Switch.md @@ -39,7 +39,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SelectedItem`](#SelectedItem) {#value} The currently selected item's index -### views : [`renoise.Views.View`](/API/renoise/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 @@ -59,13 +59,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#add_notifier} Add index change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) {#remove_notifier} Remove index change notifier @@ -73,14 +73,14 @@ Remove index change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -89,31 +89,31 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias IntegerValueNotifierFunction {#IntegerValueNotifierFunction} -(value : [`integer`](/API/builtins/integer.md)) +(value : [`integer`](../../API/builtins/integer.md)) # alias ItemLabels {#ItemLabels} -[`string`](/API/builtins/string.md)`[]` +[`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) +[`integer`](../../API/builtins/integer.md) The currently selected item's index # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Text.md b/docs/API/renoise/renoise.Views.Text.md index cd43a08..f7c7326 100644 --- a/docs/API/renoise/renoise.Views.Text.md +++ b/docs/API/renoise/renoise.Views.Text.md @@ -34,7 +34,7 @@ the view in order to make the text fully visible (expanding only). 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/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 @@ -54,9 +54,9 @@ 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/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/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. @@ -87,7 +87,7 @@ TextFontStyle: ``` # alias TextSingleLineString {#TextSingleLineString} -[`string`](/API/builtins/string.md) +[`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: "" @@ -103,19 +103,19 @@ TextStyle: ``` # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.TextField.md b/docs/API/renoise/renoise.Views.TextField.md index 0649035..fa11f34 100644 --- a/docs/API/renoise/renoise.Views.TextField.md +++ b/docs/API/renoise/renoise.Views.TextField.md @@ -39,7 +39,7 @@ 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: "" -### views : [`renoise.Views.View`](/API/renoise/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 @@ -59,13 +59,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#add_notifier} Add value change (text change) notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) {#remove_notifier} Remove value change (text change) notifier @@ -73,11 +73,11 @@ Remove value change (text change) notifier --- ## Aliases # alias StringValueNotifierFunction {#StringValueNotifierFunction} -(value : [`string`](/API/builtins/string.md)) +(value : [`string`](../../API/builtins/string.md)) # alias TextActive {#TextActive} -[`boolean`](/API/builtins/boolean.md) +[`boolean`](../../API/builtins/boolean.md) When false, text is displayed but can not be entered/modified by the user. * Default: true @@ -93,36 +93,36 @@ TextAlignment: ``` # alias TextEditMode {#TextEditMode} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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) +[`string`](../../API/builtins/string.md) Exactly the same as "value"; provided for consistency. * Default: "" # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.Value.md b/docs/API/renoise/renoise.Views.Value.md index 5beef18..e99f1da 100644 --- a/docs/API/renoise/renoise.Views.Value.md +++ b/docs/API/renoise/renoise.Views.Value.md @@ -29,7 +29,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SliderNumberValue`](#SliderNumberValue) {#value} The current value of the view -### views : [`renoise.Views.View`](/API/renoise/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 @@ -49,13 +49,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -63,11 +63,11 @@ Remove value change notifier --- ## Aliases # alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) +(value : [`number`](../../API/builtins/number.md)) # alias SliderNumberValue {#SliderNumberValue} -[`number`](/API/builtins/number.md) +[`number`](../../API/builtins/number.md) The current value of the view # alias TextAlignment {#TextAlignment} @@ -94,19 +94,19 @@ TextFontStyle: ``` # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.ValueBox.md b/docs/API/renoise/renoise.Views.ValueBox.md index 7d510f4..aaf0399 100644 --- a/docs/API/renoise/renoise.Views.ValueBox.md +++ b/docs/API/renoise/renoise.Views.ValueBox.md @@ -50,7 +50,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SliderNumberValue`](#SliderNumberValue) {#value} The current value of the view -### views : [`renoise.Views.View`](/API/renoise/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 @@ -70,13 +70,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -84,14 +84,14 @@ Remove value change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -100,44 +100,44 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) +(value : [`number`](../../API/builtins/number.md)) # alias SliderNumberValue {#SliderNumberValue} -[`number`](/API/builtins/number.md) +[`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) } +{ 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) +[`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) +[`number`](../../API/builtins/number.md) The minimum value that can be set using the view * Default: 0 # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.ValueField.md b/docs/API/renoise/renoise.Views.ValueField.md index db2b0fc..5628c27 100644 --- a/docs/API/renoise/renoise.Views.ValueField.md +++ b/docs/API/renoise/renoise.Views.ValueField.md @@ -49,7 +49,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`SliderNumberValue`](#SliderNumberValue) {#value} The current value of the view -### views : [`renoise.Views.View`](/API/renoise/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 @@ -69,13 +69,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -83,14 +83,14 @@ Remove value change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -99,21 +99,21 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias NumberValueNotifierFunction {#NumberValueNotifierFunction} -(value : [`number`](/API/builtins/number.md)) +(value : [`number`](../../API/builtins/number.md)) # alias SliderMaxValue {#SliderMaxValue} -[`number`](/API/builtins/number.md) +[`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) +[`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) +[`number`](../../API/builtins/number.md) The current value of the view # alias TextAlignment {#TextAlignment} @@ -128,19 +128,19 @@ TextAlignment: ``` # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.View.md b/docs/API/renoise/renoise.Views.View.md index b45d5f5..6ad5bf4 100644 --- a/docs/API/renoise/renoise.Views.View.md +++ b/docs/API/renoise/renoise.Views.View.md @@ -14,7 +14,7 @@ relative to the view's parent size and will automatically update on size changes 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/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 @@ -34,9 +34,9 @@ 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/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/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. @@ -44,19 +44,19 @@ Remove a child view from this view. --- ## Aliases # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). diff --git a/docs/API/renoise/renoise.Views.XYPad.md b/docs/API/renoise/renoise.Views.XYPad.md index ff3825c..6b5d185 100644 --- a/docs/API/renoise/renoise.Views.XYPad.md +++ b/docs/API/renoise/renoise.Views.XYPad.md @@ -44,7 +44,7 @@ message will do nothing and no error is fired. A table of allowed minimum values for each axis * Default: {x: 0.0, y: 0.0} -### snapback : [`XYPadSnapbackValues`](#XYPadSnapbackValues)[`?`](/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. @@ -58,7 +58,7 @@ A tooltip text that should be shown for this view on mouse hover. ### value : [`XYPadValues`](#XYPadValues) {#value} A table of the XYPad's current values on each axis -### views : [`renoise.Views.View`](/API/renoise/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 @@ -78,13 +78,13 @@ 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/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. -### `add_notifier`([*self*](/API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) {#add_notifier} +### `add_notifier`([*self*](../../API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) {#add_notifier} Add value change notifier -### `remove_child`([*self*](/API/builtins/self.md), child : [`renoise.Views.View`](/API/renoise/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. -### `remove_notifier`([*self*](/API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) {#remove_notifier} +### `remove_notifier`([*self*](../../API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) {#remove_notifier} Remove value change notifier @@ -92,14 +92,14 @@ Remove value change notifier --- ## Aliases # alias ControlActive {#ControlActive} -[`boolean`](/API/builtins/boolean.md) +[`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) +[`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 @@ -108,19 +108,19 @@ Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired. # alias ViewDimension {#ViewDimension} -[`string`](/API/builtins/string.md) | [`integer`](/API/builtins/integer.md) +[`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) +[`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) +[`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). @@ -137,7 +137,7 @@ A table of allowed minimum values for each axis * Default: {x: 0.0, y: 0.0} # alias XYPadSnapbackValues {#XYPadSnapbackValues} -{ x : [`number`](/API/builtins/number.md), y : [`number`](/API/builtins/number.md) } +{ 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. diff --git a/docs/guide/README.md b/docs/guide/README.md index 6c76801..b8b14ea 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -1,3 +1,3 @@ # Guides to the Renoise API -In this section you can learn about different aspects of the API. These guides will assume you've already read the chapters in [our introduction](../start/Development.md) and you are able to package and install tools. +In this section you can learn about different aspects of the API. These guides will assume you've already read the chapters in [our introduction](../start/development.md) and you are able to package and install tools. diff --git a/docs/start/possibilities.md b/docs/start/possibilities.md index 93e09a1..8dd4804 100644 --- a/docs/start/possibilities.md +++ b/docs/start/possibilities.md @@ -40,7 +40,7 @@ There are a few ways tool creators can make the functionality they provide avail * [Add new entries to menus](../guide/TODO.md#menus) like the *Tools* menu or one of the right-click context menus * [Create custom views](../guide/TODO.md#views) that do things on button presses, slider drags and so on * [Listen to MIDI, OSC or WebSocket messages](../guide/TODO.md#midi) to execute actions -* [React to events inside Renoise](../guide/observables_and_preferences.md) like "do something any time a new song is loaded" +* [React to events inside Renoise](../guide/observables.md) like "do something any time a new song is loaded"