diff --git a/README.html b/README.html index fbe5c7b..75d289d 100644 --- a/README.html +++ b/README.html @@ -42,11 +42,11 @@
  • cmake . (or “cmake -DZOOMFIX=ON .” to get a screen-sharing fix to make X11 mirror display windows visible to screen-sharing applications such as Zoom, see Improvements #3 below). ZOOMFIX is only needed for GStreamer-1.18.x or earlier.
  • make
  • sudo make install (you can afterwards uninstall with sudo make uninstall in the same directory in which this was run)
    • -
  • Install GStreamer plugins that you need: sudo apt-get install gstreamer1.0-<plugin>; values of <plugin> needed are: “plugins-base”, “libav” (for sound), “plugins-good” (for v4l2 hardware h264 decoding) and “plugins-bad” (for h264 decoding). Also needed may be “gl” for OpenGL support, and “x” for X11 support, although these may already be installed; “vaapi” is needed for hardware-accelerated h264 video decoding by Intel graphics (not for NVIDIA). Also install “tools” to get the utility gst-inspect-1.0 for examining the GStreamer installation.
    • +
  • Install GStreamer plugins that you need: sudo apt-get install gstreamer1.0-<plugin>; values of <plugin> needed are: “plugins-base”, “libav” (for sound), “plugins-good” (for v4l2 hardware h264 decoding) and “plugins-bad” (for h264 decoding). Also needed may be “gl” for OpenGL support (which may be useful, and should be used with h264 decoding by the NVIDIA GPU), and “x” for X11 support, although these may already be installed; “vaapi” is needed for hardware-accelerated h264 video decoding by Intel graphics (not for NVIDIA). Also install “tools” to get the utility gst-inspect-1.0 for examining the GStreamer installation.

    • If you intend to modify the code, use a separate “build” directory: replace “cmake [ ] .” by “mkdir build ; cd build ; cmake [ ] ..”; you can then clean the build directory with “rm -rf build/*” (run from within the UxPlay source directory) without affecting the source directories which contain your modifications.

    The above script installs the executable file “uxplay” to /usr/local/bin, (and installs a manpage to somewhere like /usr/local/share/man/man1 and README files to somewhere like /usr/local/share/doc/uxplay). It can also be found in the build directory after the build processs.

    -

    Finally, run uxplay in a terminal window. If it is not seen by the iOS client’s drop-down “Screen Mirroring” panel, check that your DNS-SD server (usually avahi-daemon) is running: do this in a terminal window with systemctl status avahi-daemon. If this shows the avahi-daemon is not running, control it with sudo systemctl [start,stop,enable,disable] avahi-daemon (or avahi-daemon.service). If UxPlay is seen, but the client fails to connect when it is selected, there may be a firewall on the server that prevents UxPlay from receiving client connection requests unless some network ports are opened. See Troubleshooting below for help with this or other problems. See Usage for run-time options. For OpenGL support (option -vs glimagesink), needed for Raspberry Pi and NVIDIA GPU-based video decoding, make sure gstreamer1.0-gl is installed.

    +

    Finally, run uxplay in a terminal window. If it is not seen by the iOS client’s drop-down “Screen Mirroring” panel, check that your DNS-SD server (usually avahi-daemon) is running: do this in a terminal window with systemctl status avahi-daemon. If this shows the avahi-daemon is not running, control it with sudo systemctl [start,stop,enable,disable] avahi-daemon (or avahi-daemon.service). If UxPlay is seen, but the client fails to connect when it is selected, there may be a firewall on the server that prevents UxPlay from receiving client connection requests unless some network ports are opened. See Troubleshooting below for help with this or other problems. See Usage for run-time options.