-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit provides documentation updates, release notes and updated download links for the upcoming v1.2.0 release.
- Loading branch information
Showing
161 changed files
with
3,103 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
|
|
||
| name: Deploy Docs to Doc (Pascal) | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main_pascal | ||
|
|
||
| workflow_dispatch: | ||
|
|
||
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
| jobs: | ||
| # This workflow contains a single job called "build" | ||
| BuildAndMakeLive: | ||
| name: Build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Fetch repo | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Install docusaurus | ||
| run: yarn install | ||
|
|
||
| - name: Build docusaurus | ||
| run: yarn build | ||
|
|
||
| - name: Send build to doc | ||
| uses: appleboy/scp-action@master | ||
| with: | ||
| host: doc.net.fourieraudio.com | ||
| username: fourier | ||
| port: 22 | ||
| key: ${{ secrets.SSH_DOC_FOURIER }} | ||
| source: "/home/runner/work/pascal/pascal/build" | ||
| target: "/home/fourier" | ||
|
|
||
| - name: Copy to staging docusaurus directory | ||
| uses: appleboy/ssh-action@master | ||
| with: | ||
| host: doc.net.fourieraudio.com | ||
| username: fourier | ||
| key: ${{ secrets.SSH_DOC_FOURIER }} | ||
| port: 22 | ||
| script: | | ||
| sudo cp -r /home/fourier/github/workspace/build/* /var/www/docusaurus_staging/live |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| sidebar_label: Release Notes v1.2.0 | ||
| --- | ||
|
|
||
| # transform.engine v1.2.0 release notes | ||
|
|
||
| - **Engine Version**: `1.2.0` | ||
| - **Windows Client Version**: `1.2.0` | ||
| - **macOS Client Version**: `1.2.0` | ||
|
|
||
| ## Summary | ||
|
|
||
| We’re excited to release **transform**.engine v1.2, featuring: | ||
|
|
||
| * **🔥 Store and recall plugin data in Cuelists:** store and recall Cues, which snapshot the entire state of all currently loaded plugins | ||
| * **🤖 MIDI Control:** use MIDI to fire Cues | ||
| * **⏰ 512-sample periods:** for latency-hungry plugins | ||
|
|
||
| …as well as a number of other goodies and bugfixes. | ||
|
|
||
| We encourage all users to update to this fully backwards-compatible release as soon as possible. | ||
|
|
||
| ## New In This Release | ||
|
|
||
| - **TF-90: Record and Fire Cues**: It is now possible to record and fire Cues, which snapshot the | ||
| entire state of all currently loaded plugins. [read more](../../manual/transform.client/cuelists) | ||
| - **TF-70, TF-156: Create Cuelists with Recall Filters**: It is now possible to create multiple | ||
| Cuelists, each of which can be filtered to affect different chains when Cues in the list are | ||
| recalled by different clients. [read more](../../manual/transform.client/cuelists/filters) | ||
| - **TF-98: Copy & paste plugin states**: there are now buttons in the detail pane for a plugin | ||
| instance which allow you to copy and paste the state of a plugin between instances of the same | ||
| plugin type | ||
| - **TF-100: Fire Cues via MIDI**: You can now send MIDI messages to the transform.engine which will | ||
| cause a Cue to be fired. [read more](../../manual/transform.engine/midi) | ||
| - TF-944: Link-Local IP addressing is now supported on the Dante Secondary interface | ||
| - TF-1946: 512-sample periods are now available, supporting processing of plugins which require that much latency | ||
| - TF-2093: Maximised plugin view mode, helping you see more plugin on small screens | ||
| - TF-2113: Delete operations now require confirmation | ||
| - TF-2029: Move chains left and right | ||
| - TF-2048: Re-number chains | ||
| - TF-1804: Rename showfiles | ||
| - TF-1897, TF-2075: Bypass and Smite buttons are now more obvious when selected, along with other toggle buttons | ||
|
|
||
| ## Bugs Fixed In This Release | ||
|
|
||
| - TF-1893: Plugins could show as offline for extended periods of time when loading chains when different chains were previously loaded | ||
| - TF-1810: Plugin scanner can show endless spinner | ||
| - TF-1919: Improve chain startup times | ||
| - TF-1902: Selecting current period size causes renderer to restart | ||
| - TF-2139: Plugin host access handshake is now unique per-device | ||
| - TF-2232: After loading hundreds of showfiles, further loads could have no effect | ||
| - TF-2212: Latency group changes made by one client not shown on others | ||
| - TF-2181: **transform**.client: Disconnection warning could occasionally flicker into view | ||
| - TF-1970: **transform**.client: Improve performance by fiddling with scrollbar implementation | ||
|
|
||
| ## Compatibility Notes | ||
| This release introduces no compatibility changes from [v1.1.0](v1-1-0.md). | ||
|
|
||
| Showfiles are fully backwards- and forwards-compatible with transform.engine v1.1. | ||
|
|
||
| transform.engine v1.2 is fully backwards compatible with transform.client v1.0-v1.1, and vice-versa; | ||
| you can connect to an engine running v1.1 from a client running v1.2, and to an engine running v1.2 | ||
| from a client running v1.1. | ||
|
|
||
| ## Known Issues | ||
|
|
||
| Users should be aware of the following [known issues](/manual/known-issues) in this release, which | ||
| we hope to address in a future update: | ||
|
|
||
| - TF-1891: DSP load meter can occasionally jump to 100% load, before returning to normal. We believe | ||
| these occasional jumps are spurious and can be safely ignored. | ||
| - TF-2148: When **transform**.engine is the PTP clock leader, changing the sample rate from 96 kHz | ||
| to 48 kHz in Dante Controller can result in the Dante audio transport stalling if transform.engine | ||
| is the PTP clock leader. Restarting the **transform**.engine after changing sample rate resolves | ||
| the issue. | ||
|
|
||
| For more details and workarounds for these issues, see the [known issues list](/manual/known-issues). | ||
|
|
||
| A small number of plugins may experience compatibility issues running on transform.engine. | ||
| For details, see our plugin compatibility database at https://plugins.fourieraudio.com . | ||
|
|
||
| ## Docs, Support & Bug Requests | ||
|
|
||
| We would warmly welcome any bug reports you may have on our discussion site: | ||
| https://discourse.fourieraudio.com . We’ll also be happy to chat and answer any questions you may | ||
| have there! | ||
|
|
||
| To learn more about how to use transform.engine, please check out our docs at | ||
| https://docs.fourieraudio.com , where you can also find handy walkthrough videos showing how to get | ||
| started. | ||
|
|
||
| If you need support with transform.engine, please feel free to reach out to your local dealer or | ||
| distributor, or contact us directly at support@fourieraudio.com . | ||
|
|
||
| ## Upcoming Release Schedule | ||
|
|
||
| We are hoping to release transform.engine v1.3 later this year. For information on what’s | ||
| coming up, see our product roadmap here: https://go.fourieraudio.com/future . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| label: 'Cuelists' | ||
| collapsed: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # Cuelists | ||
|
|
||
| Cuelists each contain multiple Cues, and can be found in the Cuelists tab at the top left of the **transform**.client. | ||
|  | ||
|
|
||
| Cuelists have the following key features: | ||
| * It is possible to have multiple Cuelists, all containing multiple Cues. | ||
| * Each Cuelist can be triggered by a different MIDI personality and channel, enabling you to trigger **transform**.engine Cues remotely. | ||
| * Each Cuelist can have a recall filter, enabling you to select which chains you wish each Cuelist to target. | ||
|
|
||
| Each Cuelist has two special Cues: | ||
| * The **Active Cue** is the Cue that was most recently fired in that Cuelist. It is shown in green. | ||
| * The **Pending Cue** is the Cue that will be fired if you execute a "Fire" operation on this | ||
| Cuelist. It is shown in orange. | ||
|
|
||
| Click a Cue to select it, or double click a Cue to set it as pending. | ||
|
|
||
| ## Primary Cuelist | ||
|
|
||
| The Primary Cuelist serves two key functions: | ||
|
|
||
| * It is the Cuelist that is displayed at all times in the Transport Control (in the bottom right-hand | ||
| corner of the UI). Pushing the "Fire" button will always fire the Pending Cue on the Primary | ||
| Cuelist. | ||
| * If the system is in Auto-Update mode and there is no Live Cue loaded on a given Plugin Instance | ||
| (so the system has no way of knowing where the change should be saved), the change will be saved | ||
| into the currently loaded Cue of the Primary Cuelist. | ||
|
|
||
| You can change the Primary Cuelist using the drop-down selector in the Transport Control (in the | ||
| bottom right-hand corner of the UI), or by selecting the Cuelist and choosing "Set As Primary" in | ||
| the action menu. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| import autoupdate from '/static/img/transformclient/auto-update.png'; | ||
| import pendingchanges from '/static/img/transformclient/pending-changes.png'; | ||
| import recordCue from '/static/img/transformclient/record-cue.png'; | ||
|
|
||
|
|
||
| # Cues | ||
|
|
||
| Cues store the state of every Instance in the system at the point at which they are recorded, including: | ||
|
|
||
| * **Plugin Data** - the configuration of all of the Plugin Instance's parameters. | ||
| * **Bypass** - the state of the Bypass toggle for the Plugin Instance. | ||
|
|
||
| Cues do not store anything about the "structure" of the Showfile: the configured Chains, or which | ||
| Plugin Instances are loaded into which Chain. | ||
|
|
||
| By selecting a Cuelist in the left-hand pane, you will be presented with all of the Cues in that Cuelist. | ||
|  | ||
|
|
||
| You can add a new Cue after the currently active Cue (or the first in the Cuelist) by clicking on the Record Cue button: | ||
|
|
||
| <img src={recordCue} alt="Record Cue Button" width="250" /> | ||
|
|
||
| This will record all currently-live Cue data into that Cue. | ||
|
|
||
| ## Cue Actions | ||
|
|
||
| Click on a Cue to select it. Once selected, the Action Menu on the right hand side of the UI | ||
| presents various exciting possibilities: | ||
|
|
||
| * **Fire Cue** - fire the selected Cue. | ||
| * **Set As Pending** - set the selected Cue as the Pending Cue (i.e. the Cue fired when you push | ||
| "Fire") | ||
| * **Rename Cue** - rename the currently selected Cue with a text string. | ||
| * **Renumber Cue** - change the number of the currently selected Cue with format #.# | ||
| * **Delete** - delete the currently selected Cue. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # Recall Filters | ||
|
|
||
| Cuelist Recall Filters can be set in the Detail Pane of a Cuelist: | ||
|
|
||
|  | ||
|
|
||
| You can add a Recall Filter to any Cuelist by picking a filter mode and selecting zero or more | ||
| Chains. The filter mode options are: | ||
|
|
||
| * **No Filter**: The Cuelist will apply to all Chains when a cue is fired. | ||
| * **Include Targets**: The Cuelist will **only** apply to the selected Chains when a Cue is fired. | ||
| * **Exclude Targets**: The Cuelist will **not** apply to the selected Chains when a Cue is fired. | ||
| :::tip | ||
|
|
||
| The filters are **recall filters**: in *exclude targets* mode, they act similarly to "recall safe" | ||
| in other products. | ||
|
|
||
| ::: |
Oops, something went wrong.