IObsApi

Interface

TheOmenDen.StreamPulse.Scripting.IObsApiOBS control + read operations available inside a script handler, bound to the bot's single obs-websocket connection. Every method is failure-safe: a disconnected OBS, a request error, or an unexpected throw is logged (only a stable message — never confidential data) and surfaced as a benign no-op (writes) or default (null / false for reads). A failing call can never propagate out of a node.

Members

GetCurrentSceneAsync
method
```
Task<string> GetCurrentSceneAsync(CancellationToken cancellationToken = default)
```
The current OBS program scene, or null when unknown / disconnected.
IsStreamingAsync
method
```
Task<bool> IsStreamingAsync(CancellationToken cancellationToken = default)
```
True when OBS streaming output is active; false otherwise (or when disconnected).

SetSceneAsync

method

Task SetSceneAsync(string sceneName, CancellationToken cancellationToken = default)

Switches the OBS program scene. A blank name no-ops.

SetSourceVisibilityAsync

method

Task SetSourceVisibilityAsync(string sceneName, string sourceName, bool visible, CancellationToken cancellationToken = default)

Shows or hides a source within a scene.

SetTextAsync

method

Task SetTextAsync(string sourceName, string text, CancellationToken cancellationToken = default)

Sets the text of a text input source.

StartRecordAsync

method

Task StartRecordAsync(CancellationToken cancellationToken = default)

Starts the recording output.

StartStreamAsync

method

Task StartStreamAsync(CancellationToken cancellationToken = default)

Starts the streaming output.

StopRecordAsync

method

Task StopRecordAsync(CancellationToken cancellationToken = default)

Stops the recording output.

StopStreamAsync

method

Task StopStreamAsync(CancellationToken cancellationToken = default)

Stops the streaming output.