Skip to content

Commit

Permalink
edited README
Browse files Browse the repository at this point in the history
  • Loading branch information
fduncanh committed Nov 27, 2021
1 parent 1ceb6c9 commit 2c88d25
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h1 id="uxplay-1.42-airplayairplay-mirror-server-for-linux-macos-and-unix.">UxPlay 1.42: AirPlay/AirPlay-Mirror server for Linux, macOS, and Unix.</h1>
<p>This project is a GPLv3 unix AirPlay server which now also works on macOS. Its main use is to act like an AppleTV for screen-mirroring (with audio) of iOS/macOS clients (iPads, iPhones, MacBooks) in a window on the server display (with the possibility of sharing that window on screen-sharing applications such as Zoom) on a host running Linux, macOS, or other unix, using Apple’s AirPlay Mirror protocol first available in iOS 5. As well as screen mirroring, when not mirroring the screen it can also play Apple Lossless (ALAC) audio streamed from the client using the audio-only Airplay protocol. (Details of what is known about the AirPlay2 protocol can be found <a href="https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol">here</a> and <a href="https://emanuelecozzi.net/docs/airplay2">here</a>).</p>
<p>The UxPlay server and its client must be on the same local area network, on which a <strong>Bonjour/Zeroconf mDNS/DNS-SD server</strong> is also running (only DNS-SD “Service Discovery” service is necessary, it is not necessary that the local network also be of the “.local” mDNS-based type). On Linux and BSD Unix servers, this is usually provided by <a href="https://www.avahi.org">Avahi</a>, through the avahi-daemon service, and is included in most Linux distributions (this service can also be provided by macOS, iOS or Windows servers).</p>
<p><em><strong>New:</strong> UxPlay &gt; 1.38 now also supports the Airplay audio-only protocol as well as AirPlay Mirror protocol, and (when the client screen is not being mirrored) can play Apple Lossless (ALAC) 44100/16/2 audio streamed from the client in 2-channel stereo without video (the accompanying cover-art and metadata is received by the server, but not displayed). The initial connection to the client can be in AirPlay audio mode, or an initial Airplay Mirror connection can be switched to Airplay audio by closing the Mirror window and reconnecting in audio-only mode (this changes back to AAC audio if screen mirroring is (re)started).</em></p>
<p><em><strong>New:</strong> UxPlay &gt; 1.38 now also supports the Airplay audio-only protocol as well as AirPlay Mirror protocol, and (when the client screen is not being mirrored) can play Apple Lossless (ALAC) 44100/16/2 audio streamed from the client in 2-channel stereo without video (the accompanying cover-art and metadata is received by the server, but not displayed). The initial connection to the client can be in AirPlay audio mode, or an initial Airplay Mirror connection can be switched to Airplay audio by selecting “Stop Mirroring” in the Screen Mirroring setting (or closing the mirror window) and reconnecting in audio-only AirPlay mode (this changes back to 44100/2 “Advanced Audio Coding” (AAC-ELD) compressed (lossy) audio if screen mirroring is (re)started).</em></p>
<p>UxPlay is based on https://github.com/FD-/RPiPlay, with GStreamer integration from https://github.com/antimof/UxPlay. (UxPlay only uses GStreamer, and does not contain the alternative Raspberry-Pi-specific audio and video renderers also found in RPiPlay.) Tested on Ubuntu 20.04, Linux Mint 20.2, OpenSUSE 15.3, macOS 10.15, FreeBSD 13.0.</p>
<p>Features: 1. Based on Gstreamer. 2. Video and audio are supported out of the box. 3. Gstreamer decoding is plugin agnostic. Uses accelerated decoders if available. For Intel graphics, VAAPI is preferable, (but don’t use VAAPI with nVidia). 4. Automatic screen orientation.</p>
<h3 id="note-to-packagers-openssl-3.0.0-solves-gpl-v3-license-issues.">Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.</h3>
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ _**New:** UxPlay > 1.38 now also supports the Airplay audio-only protocol as we
can play Apple Lossless (ALAC)
44100/16/2 audio streamed from the client in 2-channel stereo without video (the accompanying cover-art and metadata is received by the server,
but not displayed). The initial connection to the client can be in AirPlay audio mode, or an initial Airplay Mirror connection can be switched to
Airplay audio by closing the Mirror window and reconnecting in audio-only mode (this changes back to AAC audio if screen mirroring is (re)started)._
Airplay audio by selecting "Stop Mirroring" in the Screen Mirroring setting (or closing the mirror window) and reconnecting in audio-only AirPlay mode
(the audio stream changes back to "Advanced Audio Coding" (AAC-ELD) compressed (lossy) format if screen mirroring is (re)started)._

UxPlay is based on https://github.com/FD-/RPiPlay, with GStreamer integration from
https://github.com/antimof/UxPlay.
Expand Down
6 changes: 4 additions & 2 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,10 @@ streamed from the client in 2-channel stereo without video (the
accompanying cover-art and metadata is received by the server, but not
displayed). The initial connection to the client can be in AirPlay audio
mode, or an initial Airplay Mirror connection can be switched to Airplay
audio by closing the Mirror window and reconnecting in audio-only mode
(this changes back to AAC audio if screen mirroring is (re)started).*
audio by selecting "Stop Mirroring" in the Screen Mirroring setting (or
closing the mirror window) and reconnecting in audio-only AirPlay mode
(this changes back to 44100/2 "Advanced Audio Coding" (AAC-ELD)
compressed (lossy) audio if screen mirroring is (re)started).*

UxPlay is based on https://github.com/FD-/RPiPlay, with GStreamer
integration from https://github.com/antimof/UxPlay. (UxPlay only uses
Expand Down

0 comments on commit 2c88d25

Please sign in to comment.