IStreamDeckApi

Interface

TheOmenDen.StreamPulse.Scripting.IStreamDeckApiReverse commands to an Elgato Stream Deck key available inside a script handler. Every method is failure-safe: a missing bridge, a stale action context, or a transport fault is logged (with confidential data stripped) and swallowed — it never throws, so a failing call can never crash the host or escape a node. The context argument is the Elgato action instance id (from Context) identifying which key to target.

Members

SetImageAsync
method
```
Task SetImageAsync(string context, string image, CancellationToken cancellationToken = default)
```
Sets the key image from a base64-encoded data URI (e.g. data:image/png;base64,…). A blank context or image no-ops.

SetStateAsync

method

Task SetStateAsync(string context, int state, CancellationToken cancellationToken = default)

Sets the state index of a multi-state action on the targeted key.

SetTitleAsync

method

Task SetTitleAsync(string context, string title, CancellationToken cancellationToken = default)

Sets the title text shown on the targeted key. A blank context no-ops.

ShowOkAsync
method
```
Task ShowOkAsync(string context, CancellationToken cancellationToken = default)
```
Flashes the green "OK" confirmation checkmark on the targeted key.