weston

History

Pekka Paalanen 3d5d9476e3 Rename compositor.h to libweston/libweston.h The main idea is to make libweston users use the form #include <libweston/libweston.h> instead of the plain #include <compositor.h> which is prone to name conflicts. This is reflected both in the installed files, and the internal header search paths so that Weston would use the exact same form as an external project using libweston would. The public headers are moved under a new top-level directory include/ to make them clearly stand out as special (public API). Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>		6 years ago
..
README	Add remoting plugin for output streaming	6 years ago
meson.build	meson: link remoting with glib and gobject	6 years ago
remoting-plugin.c	Fix typos all around (thanks codespell!)	6 years ago
remoting-plugin.h	Rename compositor.h to libweston/libweston.h	6 years ago

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).