OBS Studio websocket backend for El Decko. Allow your Elgato Stream Deck to control OBS Studio using it's webscoket server
Project description
El Decko Backend OBS Studio Websocket
OBS Studio websocket based backend for El Decko.
First run
Upon running El Decko the first time with this backend installed it will create an empty default config to connect to
your local OBS Studio instance at: $XDG_CONFIG/eldecko/backend/obsws.json
.
Please update the generated default credentials with the actual port and password of what is shown inside your OBS
Studio Websocket Settings.
Use this backend
In order to use this backend you need to supply the streamdeck.json
generated
by El Decko Core with the following key_config
:
{
"STREAM_DECK_SERIAL_NUMBER": {
"brightness": 30,
"key_config": {
"0": {
"backend": "edb_obs_ws",
"event": "SetCurrentProgramScene",
"event_parameters": {"name":"S: Desktop"},
"image_idle": null,
"image_pressed": null
}
}
}
}
This will configure the very first key (0
) to use this plugin (edb_obs_ws
) and bind the event SwitchScene
to it.
The event will receive the parameter map defined by event_parameters
, name
defines the name of you scene within OBS
Studio.
More supported websocket events will follow.
Implemented websocket protocols
SetCurrentProgramScene
Tells OBS Studio to change the currently visible Scene to any other available scene.
Event name: SetCurrentProgramScene
Parameters: name
-> Name of your local OBS Studio Scene
GetSceneList
Returns a list with all available Scenes within OBS Studio.
Event name: GetSceneList
Parameters: None
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for el_decko_backend_obs_ws-2022.12.28.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2eba91cf3742f29dcdef424b6fdf51ff1321080f4a6850bf5ba64103de8937f6 |
|
MD5 | 9b50483ff50147a0d6b127f6b88c0438 |
|
BLAKE2b-256 | e75a4e683d3a8b23f57abc49483bfb8a0b4ae4748a675a228562fae3b8c1296c |
Hashes for el_decko_backend_obs_ws-2022.12.28.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f194f777017d6fa3a7aa049cfa465a3ea19d2a32d5be93198a5f589429f0a55b |
|
MD5 | e92a28c9e27d4c600a6635913f089cb7 |
|
BLAKE2b-256 | c55e69f224d96cf822b4cefe7756814319dfeee53e3e6f6df6fc97c0701fabcb |