Hosting output

[sebinside]

To enable simple web overlays, e.g. for OBS Studio, a HTML overlay output is needed. The communication should be easy through a generated rest interface or websocket. The output should be hosted from the framework web service itself.

[sebinside]

Requirements:

• It shall be possible to create a infinite number of hosting connectors, which are available through their own scope, e.g. http://xyz:2400/content/connectorName/pluginName/abc
• It shall be possible to host any content, e.g. html websites provided in the plugin resources
• It shall be possible to provide dynamic content updates through a per-plugin websocket

Approach (framework site):

• New Servlet registered in ScalatraBootstrap
• Servlet has access to ConnectorRegistry
• On http get access to servlet: scanns connectors for hosting connectors, deliver content based on previous plugin regisitrations (see below)
• Optional speedup: web hosting connectors register / unregister themselves in global server (flow inversion, but breaks clean architecture, probably no good idea)
• Start websocket for communication of plugin and delivered content

Approach (plugin site):

• Write plugin logic, define websocket end points / communication in a simplified way
• Write frontend html file, containing custom code for websocket communication (aided or native)
• Register ressource in output, register websocket communication in output
• Http get hosted content

Notes:

• Naming: Since everything is possible to host, and the usage of (dynamic) html websites is only one possibility, we might call this connector simply "hosting connector"?
• Approach: This approach would be also suitable for the REST output from REST Input/Output & Http Output #85

[sebinside]

Some TODOs:

• Initial implementation of hosting
• Websocket communication
• Linking to one endpoint per plugin, visible on the GUI
• Code documentation
• Connector metadata
• Wiki entry