bitfocus / companion-module-renewedvision-pvp

MIT License
1 stars 2 forks source link

PVP 3: Add support for Effects and Effect Presets #9

Closed chrisrouse closed 5 years ago

chrisrouse commented 5 years ago

Moving from module to main project: https://github.com/bitfocus/companion-module-pvp/issues/2

PasteBin link for detailed Effects and Effects Presets documentation: https://pastebin.com/dAgviUd1

Effects can be applied to the Layer or Workspace. Effects can also be saved into Effects Presets. There is a major caveat when using the API to apply effects. When you send a new effect it will clear the current effect immediately. There is no way around this at this time. In order to avoid this, the user must create effects presets that are inclusive of all necessary effects. Putting multiple effects into a single curl results in both the effects firing sequentially and ending on the last effect in the string. I've reported this bug to RV a long time ago.

Most effects have multiple properties that have to be accounted for. The API provides the supported range for each value. Unlike transitions, the Enabled: true/false flag actually does something here. If you send a curl with the flag set to false, it will add the effect, but won't enable it. If you send it with true, it will add the effect and activate it immediately.

Many values will need to support floats. Behind the scenes, there's no rounding down to the decimals. However, the GUI only shows values to the hundredths place, so I think it would be safe to limit the values to two places as well.

There doesn't seem to be a way to remove a single effect that I've found yet. I've reported these bugs to Renewed Vision through my back channels there.

SteveTherrien commented 5 years ago

A quick update for this issue and #463:

PVP has a bug with clearing effect presets from the API, so this part of the issue is on hold until Renewed Vision releases a fix.

As for the actual effects and transition actions, Chris and I are trying to work out whether this is worth adding to Companion. Effects and transitions are visual things, each with many different attributes (angles, colors, speeds...), so programming them blind into Companion would be difficult, at which point you'd just program them into a PVP cue and trigger them that way.

At least, those are my thoughts on the issue. We're trying to gather feedback from other PVP users about whether having these actions in Companion would be useful to them.

chrisrouse commented 5 years ago

I think supporting effects presets will be enough. Now I just need to push them to fix the bug with clearing effects!