Module obws::client

source ·
Expand description

The client to the obs-websocket API and main entry point.

Structs

The client is the main entry point to access the obs-websocket API. It allows to call various functions to remote control an OBS instance as well as to listen to events caused by the user by interacting with OBS.
API functions related to OBS configuration.
Configuration for connecting to a obs-websocket instance.
API functions related to filters.
General functions of the API.
API functions related to hotkeys.
API functions related to inputs.
API functions related to media inputs.
API functions related to outputs.
API functions related to profiles.
API functions related to recording.
API functions related to the replay buffer.
API functions related to scene collections.
API functions related to scene items.
API functions related to scenes.
API functions related to sources.
API functions related to streaming.
API functions related to transitions.
API functions related to the user interface.
API functions related to the virtual camera.

Enums

Errors that can occur while performing the initial handshake with obs-websocket.