Web api integration

[justibro]

Is your feature request related to a problem? Please describe.
Not a problem but would be nice be able to use streamdecks and similar devices to quickly use labeled buttons to apply effects without having to remember all the keyboard commands. I thought since AI is creating more things it might be easier to implement.

Describe the solution you'd like
Primary use is companion by bitfocus to send api commands to xlights. This would require xlights to have a webport open, similar to fpp to accept commands. The api url could follow the key binding setup.

Examples:

localhost:3000/api/sequencer/effect/on/string/E_TEXTCTRL_Eff_On_End=100,E_TEXTCTRL_Eff_On_Start=100
localhost:3000/api/sequencer/applysetting/T_TEXTCTRL_Fadein=1.00,T_TEXTCTRL_Fadeout=1.00
localhost:3000/api/sequencer/effect_align_start

Basically all the types in keybindings can be after the "api" and which scope, and if there needs to be a string add a string.

This would apply to what is selected on screen.

Describe alternatives you've considered
In companion, I had it connected to virceo listener and that app so it will virtually press the keyboard shortcuts in xlights and I setup all the commands in there. Alot of time spent to configure and find non system shortcut keys to use to make alot of effects and apply effects

Additional context
Also a virtual button emulator in companion can be used. An ipad could have a giant button grid with labels and matched images of effects, or even just to have a grid of commands in a browser window on the same computer to use an effect selector.

[cybercop23]

You already can. Use key bindings and the new-ish menu key search. Here's my SD

Expand effect Ctfl Shift R or L

[justibro]

Yes I have done what you suggested but I was hoping to go beyond having to setup tons of keybindings and instead have an infinite array of options if I could call them directly without having to setup up every single effect or apply setting. The images are simple ai generated but to hopefull get eh point across of the variation and ease of setup on that side could be.

[derwin12]

So what are you asking for? We have an api port open already.

[justibro]

I would like to be able to call everything that is under the keybindings along with the extra settings if it has it. It might be nice to have more of an integration later of sending variables back in the companion app. The companion app allows for custom http calls per button press or action.

So I would like to see something like /api/sequencer{scope}/effect{type}/pinwheel{from the dropdown}/setting/E_TEXTCTRL_Eff_On_End=0,E_TEXTCTRL_Eff_On_Start=100 when this is requested it would trigger just like pressing the key command.
Here is another option: /api/sequencer{scope}/zoom_in{type}
Or /api/layout{scope}/model_align_top{type}
Or /api/all_tabs{scope}/paste_by_time{type}

Essentially all the keybindings could be the options in the api call.

This is more of a convenience thing so that instead of having to make tons of keybindings and going through programs to trigger keys, everything could just be set within the api call.

If this is available then a companion plugin could be made with some presets to start with.

For even more in the future it would be nice to send data back into companion so you could have a rotary knob adjust the fade in or out up or down based on the current selected effect.

[derwin12]

This seems pretty niche and not likely to be implemented. Leaving it for other devs to chime in.