diff --git a/.github/workflows/archive.yml b/.github/workflows/archive.yml index 4a84481..ff55a8d 100644 --- a/.github/workflows/archive.yml +++ b/.github/workflows/archive.yml @@ -1,6 +1,14 @@ name: Build and Archive XRNX_Starter_Pack.zip -on: [push] +on: + pull_request: + branches: [ "master" ] + push: + branches: + - master + +env: + CARGO_TERM_COLOR: always jobs: build: @@ -13,12 +21,12 @@ jobs: - name: Install Rust uses: actions-rust-lang/setup-rust-toolchain@v1 - - - name: Install binstall - uses: cargo-bins/cargo-binstall@main + with: + cache-workspaces: "docs" + cache-key: "renoise-xrnx" - name: Install mdbook - run: cargo binstall -y --force mdbook mdbook-linkcheck mdbook-toc mdbook-alerts + run: cargo install mdbook@0.4.51 mdbook-linkcheck@0.7.5 mdbook-toc@0.14.2 mdbook-alerts@0.8.0 - name: Build the API run: cargo run diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index f41defd..467695f 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -16,12 +16,12 @@ jobs: - name: Install Rust uses: actions-rust-lang/setup-rust-toolchain@v1 - - - name: Install binstall - uses: cargo-bins/cargo-binstall@main + with: + cache-workspaces: "docs" + cache-key: "renoise-xrnx" - name: Install mdbook - run: cargo binstall -y --force mdbook mdbook-linkcheck mdbook-toc mdbook-alerts + run: cargo install mdbook@0.4.51 mdbook-linkcheck@0.7.5 mdbook-toc@0.14.2 mdbook-alerts@0.8.0 - name: Build the API run: cargo run diff --git a/definitions b/definitions index 08faaea..684c9e8 160000 --- a/definitions +++ b/definitions @@ -1 +1 @@ -Subproject commit 08faaea744156f2f7eddc898eb46fd972453a1af +Subproject commit 684c9e855362ea5be4300fd5179c1b2d3fb1a77a diff --git a/docs/API/renoise/renoise.Document.DocumentList.md b/docs/API/renoise/renoise.Document.DocumentList.md index 4e7343e..231cb9f 100644 --- a/docs/API/renoise/renoise.Document.DocumentList.md +++ b/docs/API/renoise/renoise.Document.DocumentList.md @@ -108,11 +108,11 @@ ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction diff --git a/docs/API/renoise/renoise.Document.DocumentNode.md b/docs/API/renoise/renoise.Document.DocumentNode.md index 11f2674..86bfbae 100644 --- a/docs/API/renoise/renoise.Document.DocumentNode.md +++ b/docs/API/renoise/renoise.Document.DocumentNode.md @@ -79,11 +79,11 @@ ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction diff --git a/docs/API/renoise/renoise.Document.ObservableBooleanList.md b/docs/API/renoise/renoise.Document.ObservableBooleanList.md index 2ff3c18..2e1e1b9 100644 --- a/docs/API/renoise/renoise.Document.ObservableBooleanList.md +++ b/docs/API/renoise/renoise.Document.ObservableBooleanList.md @@ -66,11 +66,11 @@ ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction diff --git a/docs/API/renoise/renoise.Document.ObservableList.md b/docs/API/renoise/renoise.Document.ObservableList.md index 5e151c7..7f54e22 100644 --- a/docs/API/renoise/renoise.Document.ObservableList.md +++ b/docs/API/renoise/renoise.Document.ObservableList.md @@ -38,11 +38,11 @@ ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction diff --git a/docs/API/renoise/renoise.Document.ObservableNumberList.md b/docs/API/renoise/renoise.Document.ObservableNumberList.md index 96983be..b701430 100644 --- a/docs/API/renoise/renoise.Document.ObservableNumberList.md +++ b/docs/API/renoise/renoise.Document.ObservableNumberList.md @@ -65,11 +65,11 @@ ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction diff --git a/docs/API/renoise/renoise.Document.ObservableStringList.md b/docs/API/renoise/renoise.Document.ObservableStringList.md index 2256356..0fac90c 100644 --- a/docs/API/renoise/renoise.Document.ObservableStringList.md +++ b/docs/API/renoise/renoise.Document.ObservableStringList.md @@ -65,11 +65,11 @@ ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction diff --git a/docs/API/renoise/renoise.Document.md b/docs/API/renoise/renoise.Document.md index 507fb8d..ce573f3 100644 --- a/docs/API/renoise/renoise.Document.md +++ b/docs/API/renoise/renoise.Document.md @@ -135,11 +135,11 @@ ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction diff --git a/docs/API/renoise/renoise.InstrumentMidiInputProperties.md b/docs/API/renoise/renoise.InstrumentMidiInputProperties.md index 9216c45..6f48517 100644 --- a/docs/API/renoise/renoise.InstrumentMidiInputProperties.md +++ b/docs/API/renoise/renoise.InstrumentMidiInputProperties.md @@ -7,9 +7,9 @@ ## Properties ### device_name : [`string`](../../API/builtins/string.md) > 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. +> `renoise.Midi.available_input_devices()` or "Renoise OSC Device". +> To close a device and disconnect it from the instrument, assign +> an empty string. ### device_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) > Track changes to document properties or general states by attaching listener diff --git a/docs/API/renoise/renoise.InstrumentPhraseScript.md b/docs/API/renoise/renoise.InstrumentPhraseScript.md index 9cd16fe..f8bcc87 100644 --- a/docs/API/renoise/renoise.InstrumentPhraseScript.md +++ b/docs/API/renoise/renoise.InstrumentPhraseScript.md @@ -71,14 +71,14 @@ > to iterate over all parameters and to query the parameter count. ### commit([*self*](../../API/builtins/self.md)) > Commit paragraph changes for playback. -### render_to_pattern([*self*](../../API/builtins/self.md), options : [`RenderScriptOptions`](#renderscriptoptions), rendering_done_callback : (string : [`any`](../../API/builtins/any.md)[`?`](../../API/builtins/nil.md), integer : [`any`](../../API/builtins/any.md), integer : [`any`](../../API/builtins/any.md))) +### render_to_pattern([*self*](../../API/builtins/self.md), options : [`RenderScriptOptions`](#renderscriptoptions), rendering_done_callback : [`RenderingDoneCallback`](#RenderingDoneCallback)) > Render script content with the given options to the phrase pattern. > Only committed content will be rendered, so make sure to commit changes first. -> Parameter `rendering_done_callback` carries along rendering results: -> - 1. optional error as string that happened while rendering. nil when succeeded. -> - 2. number of successfully rendered raw events (not pattern lines) or 0. -> - 3. number of skipped raw events, in case the pattern can't fit all events, or 0. -### render_to_clipboard([*self*](../../API/builtins/self.md), options : [`RenderScriptOptions`](#renderscriptoptions), rendering_done_callback : (string : [`any`](../../API/builtins/any.md)[`?`](../../API/builtins/nil.md), integer : [`any`](../../API/builtins/any.md), integer : [`any`](../../API/builtins/any.md))) +> Parameter `rendering_done_callback` is called with the results: +> * `error`: nil when the rendering succeeded, otherwise a string describing the error +> * `rendered_events`: number of successfully rendered raw events (not pattern lines) or 0 +> * `skipped_events`: number of skipped raw events, in case the pattern couldn't fit all events, or 0 +### render_to_clipboard([*self*](../../API/builtins/self.md), options : [`RenderScriptOptions`](#renderscriptoptions), rendering_done_callback : [`RenderingDoneCallback`](#RenderingDoneCallback)) > Same as `render_to_pattern`, but rendering into a temporary phrase object in the clipboard, > which can then be pasted by the user somewhere. @@ -102,3 +102,12 @@ + + +--- +## Aliases +### RenderingDoneCallback +(error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), rendered_events : [`integer`](../../API/builtins/integer.md), skipped_events : [`integer`](../../API/builtins/integer.md)) + + + diff --git a/docs/API/renoise/renoise.ViewBuilder.md b/docs/API/renoise/renoise.ViewBuilder.md index 2155667..cba703c 100644 --- a/docs/API/renoise/renoise.ViewBuilder.md +++ b/docs/API/renoise/renoise.ViewBuilder.md @@ -2993,11 +2993,11 @@ fun() ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction @@ -7659,11 +7659,11 @@ fun() ### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` } +{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } ### 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 : `"swap"` } ### ListNotifierFunction