Skip to content

Commit 1c17e72

Browse files
committed
chore(docs): add shuttlewebhid paragraph
1 parent 587ad1a commit 1c17e72

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

packages/documentation/docs/user-guide/features/prompter.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ The prompter can be controlled by different types of controllers. The control mo
4343
| `?mode=mouse` | Controlled by mouse only. [See configuration details](prompter.md#control-using-mouse-scroll-wheel) |
4444
| `?mode=keyboard` | Controlled by keyboard only. [See configuration details](prompter.md#control-using-keyboard) |
4545
| `?mode=shuttlekeyboard` | Controlled by a Contour Design ShuttleXpress, X-keys Jog and Shuttle or any compatible, configured as keyboard-ish device. [See configuration details](prompter.md#control-using-contour-shuttlexpress-or-x-keys) |
46+
| `?mode=shuttlewebhid` | Controlled by a Contour Design ShuttleXpress, using the browser's WebHID API [See configuration details](prompter.md#control-using-contour-shuttlexpress-via-webhid) |
4647
| `?mode=pedal` | Controlled by any MIDI device outputting note values between 0 - 127 of CC notes on channel 8. Analogue Expression pedals work well with TRS-USB midi-converters. [See configuration details](prompter.md#control-using-midi-input-mode-pedal) |
4748
| `?mode=joycon` | Controlled by Nintendo Switch Joycon, using the HTML5 GamePad API. [See configuration details](prompter.md#control-using-nintendo-joycon-gamepad) |
4849

@@ -94,6 +95,14 @@ Configuration files that can be used in their respective driver software:
9495
- [Contour ShuttleXpress](https://github.com/nrkno/sofie-core/blob/release26/resources/prompter_layout_shuttlexpress.pref)
9596
- [X-keys](https://github.com/nrkno/sofie-core/blob/release26/resources/prompter_layout_xkeys.mw3)
9697

98+
#### Control using Contour ShuttleXpress via WebHID
99+
100+
This mode uses a Contour ShuttleXpress (Multimedia Controller Xpress) through web browser's WebHID API.
101+
102+
When opening the Prompter View for the first time, it is necessary to press the _Connect to Contour Shuttle_ button in the top left corner of the screen, select the device, and press _Connect_.
103+
104+
![Contour ShuttleXpress input mapping](/img/docs/main/features/contour-shuttle-webhid.jpg)
105+
97106
####
98107

99108
#### Control using midi input \(_?mode=pedal_\)
41.7 KB
Loading

0 commit comments

Comments
 (0)