Skip to content

Commit 9451b8c

Browse files
committed
feat: document the setFeedback and setFeedbackLayout serverbound events and the touchTap clientbound event
1 parent b3e6b42 commit 9451b8c

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

‎src/api/clientbound/encoder.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,28 @@ Fired on encoder dial up.
7272
}
7373
}
7474
```
75+
76+
### touchTap
77+
78+
Fired on encoder touch tap.
79+
80+
**Received by:** Plugin
81+
82+
```ts
83+
{
84+
event: string = "touchTap",
85+
action: string,
86+
context: string,
87+
device: string,
88+
payload: {
89+
settings: any,
90+
coordinates: {
91+
row: number,
92+
column: number
93+
},
94+
controller: string,
95+
tapPos: [number, number],
96+
hold: boolean
97+
}
98+
}
99+
```

‎src/api/serverbound/states.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,36 @@ Used to switch an action to a state.
5858
}
5959
}
6060
```
61+
62+
### setFeedback
63+
64+
Used to set the feedback of an instance's encoder layout.
65+
66+
See the [Stream Deck SDK documentation](https://docs.elgato.com/streamdeck/sdk/references/websocket/plugin#setfeedback) for more information on encoder layouts.
67+
68+
**Sent by:** Plugin
69+
70+
```ts
71+
{
72+
event: string = "setFeedback",
73+
context: string,
74+
payload: any
75+
}
76+
```
77+
78+
### setFeedbackLayout
79+
80+
Used to set the encoder layout of an instance.
81+
82+
**Sent by:** Plugin
83+
84+
```ts
85+
{
86+
event: string = "setFeedbackLayout",
87+
context: string,
88+
payload: {
89+
// A path to the layout file relative to the plugin directory or an ID of a built-in layout.
90+
layout: string
91+
}
92+
}
93+
```

0 commit comments

Comments
 (0)