-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
50 additions
and
3 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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 2 | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Use commands and feedback | ||
|
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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 0 | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Initialization and connection | ||
|
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,47 @@ | ||
--- | ||
sidebar_position: 0 | ||
--- | ||
|
||
# Quick Start | ||
|
||
**This Quick Start Guide will help you get started with this library by creating a simple Node.js script to toggle MUTE on a master channel.** | ||
|
||
First, ensure that the [Node.js runtime](https://nodejs.org/en) is installed on your machine. | ||
Create a new folder and initialize a new NPM project: | ||
|
||
```bash | ||
mkdir soundcraft-quickstart | ||
cd soundcraft-quickstart | ||
npm init -y | ||
``` | ||
|
||
Install the library: | ||
|
||
```bash | ||
npm install soundcraft-ui-connection | ||
``` | ||
|
||
Create an `index.mjs` file for your script. Import the `SoundcraftUI` class from the package and create an instance with the IP address of the mixer. Use the `conn.connect()` method to connect to the mixer, which returns a Promise that resolves when the connection is established. | ||
|
||
Finally, set an interval to toggle MUTE every 1000 ms: | ||
|
||
```javascript | ||
import { SoundcraftUI } from 'soundcraft-ui-connection'; | ||
|
||
const conn = new SoundcraftUI('192.168.1.111'); | ||
await conn.connect(); | ||
|
||
setInterval(() => { | ||
conn.master.input(2).toggleMute(); | ||
}, 1000); | ||
``` | ||
|
||
You can run the script from the command line: | ||
|
||
```bash | ||
node index.mjs | ||
``` | ||
|
||
Open the Soundcraft Web App to see Channel 2 mute and unmute every second. | ||
|
||
🎉 **Congratulations! You have successfully set up a new project with our library.** |
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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 1 | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Connection Status | ||
|