ELMA(1)

NAME ¶

elma - OSC to OBS WebSocket API adapter

SYNOPSIS ¶

elma [-v] [-k password] [-p port] [host [port]]

DESCRIPTION ¶

elma is an adapter to convert OSC messages into requests for the WebSocket API of OBS. Only a small subset of the API is supported.

The hostname and the port for connecting to the OBS client are specified after the options. The hostname defaults to 127.0.0.1 and the port defaults to 4455.

The options are as follows:

-k password

Set the password to use for authenticating at your OBS client. If this option is unset, no password will be used.

-p port

Set the port to use for listening to OSC messages (via UDP). (Default: 5056)

-v

Print the version information and exit.

The following OSC addresses are supported for making requests to OBS:

/previewScene name

Set the current preview scene to the scene with the supplied name (string). This only works if the studio mode is enabled within OBS.

/programScene name

Set the current program scene to the scene with the supplied name (string).

/transition name

Set the current scene transition to the transition with the supplied name (string).

/transitionDuration milliseconds

Set the duration of the current scene transition (int32).

AUTHORS ¶

Created and maintained by Hannes Braun <hannes@hannesbraun.net>. Up-to-date sources can be found at https://git.sr.ht/~hannes/elma. Bugs and patches can be submitted by email to ~hannes/public-inbox@lists.sr.ht.