weston

History

Marius Vlad bb7ed37a89 remoting,pipewire: Use the connector and the output name for the head name Makes the client's life much easier to identify between multiple remote outputs. xdg_output is advertising (in later versions) the head name, but in case we have different plug-ins or multiple remote outputs created, it would only repeat/advertise the same name for all (remoting) outputs. This instead uses a string that uses both the connector and name to derive a more easier identifier a client can choose from. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>		2020-11-09 11:36:12 +02:00
..
meson.build	plug-ins: Migrate pipewire and remoting plug-ins headers to public header	2020-09-04 10:36:48 +00:00
README	doc: Move helper scripts to doc/scripts	2019-06-25 14:05:54 +00:00
remoting-plugin.c	remoting,pipewire: Use the connector and the output name for the head name	2020-11-09 11:36:12 +02:00

README

	Remoting plugin for Weston


The Remoting plugin creates a streaming image of a virtual output and transmits
it to a remote host. It is currently only supported on the drm-backend. Virtual
outputs are created and configured by adding a remote-output section to
weston.ini. See man weston-drm(7) for configuration details. This plugin is
loaded automatically if any remote-output sections are present.

This plugin sends motion jpeg images to a client via RTP using gstreamer, and
so requires gstreamer-1.0. This plugin starts sending images immediately when
weston is run, and keeps sending them until weston shuts down. The image stream
can be received by any appropriately configured RTP client, but a sample
gstreamer RTP client script can be found at doc/scripts/remoting-client-receive.bash.

Script usage:
	remoting-client-receive.bash <PORT NUMBER>


How to compile
---------------
Set --enable-remoting=true when configuring weston. The remoting-plugin.so
module is created and installed in the libweston path.


How to configure weston.ini
----------------------------
See man weston-drm(7).