Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions .github/workflows/archive.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/API/renoise/renoise.Document.DocumentList.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/API/renoise/renoise.Document.DocumentNode.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/API/renoise/renoise.Document.ObservableBooleanList.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/API/renoise/renoise.Document.ObservableList.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/API/renoise/renoise.Document.ObservableNumberList.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/API/renoise/renoise.Document.ObservableStringList.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/API/renoise/renoise.Document.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,11 +135,11 @@


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down
6 changes: 3 additions & 3 deletions docs/API/renoise/renoise.InstrumentMidiInputProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
## Properties
### device_name : [`string`](../../API/builtins/string.md)<a name="device_name"></a>
> 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)<a name="device_name_observable"></a>
> Track changes to document properties or general states by attaching listener
Expand Down
21 changes: 15 additions & 6 deletions docs/API/renoise/renoise.InstrumentPhraseScript.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@
> to iterate over all parameters and to query the parameter count.
### commit([*self*](../../API/builtins/self.md))<a name="commit"></a>
> 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)))<a name="render_to_pattern"></a>
### render_to_pattern([*self*](../../API/builtins/self.md), options : [`RenderScriptOptions`](#renderscriptoptions), rendering_done_callback : [`RenderingDoneCallback`](#RenderingDoneCallback))<a name="render_to_pattern"></a>
> 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)))<a name="render_to_clipboard"></a>
> 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))<a name="render_to_clipboard"></a>
> Same as `render_to_pattern`, but rendering into a temporary phrase object in the clipboard,
> which can then be pasted by the user somewhere.

Expand All @@ -102,3 +102,12 @@





---
## Aliases
### RenderingDoneCallback<a name="RenderingDoneCallback"></a>
(error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), rendered_events : [`integer`](../../API/builtins/integer.md), skipped_events : [`integer`](../../API/builtins/integer.md))



8 changes: 4 additions & 4 deletions docs/API/renoise/renoise.ViewBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -2993,11 +2993,11 @@ fun()


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down Expand Up @@ -7659,11 +7659,11 @@ fun()


### ListElementRemoved<a name="ListElementRemoved"></a>
{ index : [`integer`](../../API/builtins/integer.md), type : `"removed"` }
{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` }


### ListElementsSwapped<a name="ListElementsSwapped"></a>
{ 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<a name="ListNotifierFunction"></a>
Expand Down