weston

History

Pekka Paalanen 27b377f51f Rename plugin-registry.h to libweston/plugin-registry.h See "Rename compositor.h to libweston/libweston.h" for rationale. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>		2019-04-18 12:31:46 +03:00
..
README	Add remoting plugin for output streaming	2018-10-30 17:09:01 +09:00
meson.build	meson: link remoting with glib and gobject	2019-03-28 09:43:23 +00:00
remoting-plugin.c	Rename public backend headers	2019-04-18 12:31:46 +03:00
remoting-plugin.h	Rename plugin-registry.h to libweston/plugin-registry.h	2019-04-18 12:31:46 +03: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/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).