morgan/UxPlay
1
0
Fork 0
mirror of https://github.com/morgan9e/UxPlay synced 2026-04-15 00:34:05 +09:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
F. Duncanh
2022-11-28 16:21:11 -05:00
parent 090b772b28
commit c04987725d
3 changed files with 27 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.html
View File

@@ -7,6 +7,15 @@ id="now-developed-at-the-github-site-httpsgithub.comfdh2uxplay-where-all-user-is
developed at the GitHub site <a developed at the GitHub site <a
href="https://github.com/FDH2/UxPlay">https://github.com/FDH2/UxPlay</a> href="https://github.com/FDH2/UxPlay">https://github.com/FDH2/UxPlay</a>
(where all user issues should be posted).</h3> (where all user issues should be posted).</h3>
<h3
id="linux-distributions-providing-prebuilt-uxplay-packages-include-debian-testing-bookworm-ubuntu-since-22.04-and-ubuntu-derivatives-install-with-sudo-apt-install-uxplay.-to-easily-build-latest-uxplay-from-source-or-for-guidance-on-required-gstreamer-plugins-see-getting-uxplay-below.-raspberry-pi-users-see-here.">Linux
distributions providing prebuilt uxplay packages include Debian
“testing” (Bookworm), Ubuntu (since 22.04), and Ubuntu derivatives
(install with “<code>sudo apt install uxplay</code>”). To easily build
latest UxPlay from source, or for guidance on required GStreamer
plugins, see <a href="#getting-uxplay">Getting UxPlay</a> below.
Raspberry Pi users see <a
href="https://github.com/FDH2/UxPlay/wiki/Gstreamer-Video4Linux2-plugin-patches">here</a>.</h3>
<p>Highlights:</p> <p>Highlights:</p>
<ul> <ul>
<li><p>GPLv3, open source.</p></li> <li><p>GPLv3, open source.</p></li>
@@ -68,7 +77,7 @@ computers) in a window on the server display (with the possibility of
sharing that window on screen-sharing applications such as Zoom) on a sharing that window on screen-sharing applications such as Zoom) on a
host running Linux, macOS, or other unix (and now also Microsoft host running Linux, macOS, or other unix (and now also Microsoft
Windows). UxPlay supports Apple’s AirPlay2 protocol using “Legacy Windows). UxPlay supports Apple’s AirPlay2 protocol using “Legacy
Pairing”, but some features are missing. (Details of what is publically Pairing”, but some features are missing. (Details of what is publicly
known about Apple’s AirPlay 2 protocol can be found <a known about Apple’s AirPlay 2 protocol can be found <a
href="https://openairplay.github.io/airplay-spec/">here</a>, <a href="https://openairplay.github.io/airplay-spec/">here</a>, <a
href="https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol">here</a> href="https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol">here</a>
@@ -171,7 +180,7 @@ regarded as a “System Library”, which it is in *BSD). Many Linux
distributions treat OpenSSL as a “System Library”, but some distributions treat OpenSSL as a “System Library”, but some
(e.g. Debian) do not: in this case, the issue is solved by linking with (e.g. Debian) do not: in this case, the issue is solved by linking with
OpenSSL-3.0.0 or later.</p> OpenSSL-3.0.0 or later.</p>
<h1 id="getting-uxplay">Getting UxPlay:</h1> <h1 id="getting-uxplay">Getting UxPlay</h1>
<ul> <ul>
<li>Your distribution may already provide a pre-built uxplay package. It <li>Your distribution may already provide a pre-built uxplay package. It
will be included in the next Debian release “Bookworm” (currently in will be included in the next Debian release “Bookworm” (currently in
@@ -352,7 +361,7 @@ video solution by itself) provides the best results.</p>
<li><p><strong>For UxPlay-1.56 and later, if you are not using the <li><p><strong>For UxPlay-1.56 and later, if you are not using the
latest GStreamer patches from the Wiki, you will need to use the UxPlay latest GStreamer patches from the Wiki, you will need to use the UxPlay
option <code>-bt709</code></strong>: previously the GStreamer v4l2 option <code>-bt709</code></strong>: previously the GStreamer v4l2
plugin could not recognise Apple’s color format (an unusual “full-range” plugin could not recognize Apple’s color format (an unusual “full-range”
variant of the bt709 HDTV standard), which -bt709 fixes. variant of the bt709 HDTV standard), which -bt709 fixes.
GStreamer-1.20.4 has a fix for this, which is included in the latest GStreamer-1.20.4 has a fix for this, which is included in the latest
patches, so beginning with UxPlay-1.56, the bt709 fix is no longer patches, so beginning with UxPlay-1.56, the bt709 fix is no longer
@@ -533,7 +542,7 @@ MSYS2):</p>
<p><code>pacman -S mingw-w64-x86_64-libplist mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base</code></p> <p><code>pacman -S mingw-w64-x86_64-libplist mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base</code></p>
<p>Note that libplist will be linked statically to the uxplay <p>Note that libplist will be linked statically to the uxplay
executable. It should also be possible to install gstreamer for Windows executable. It should also be possible to install gstreamer for Windows
from the <a href="https://gstreamer.freedesktop.org/download/">offical from the <a href="https://gstreamer.freedesktop.org/download/">official
GStreamer site</a>, especially if you are trying a different Windows GStreamer site</a>, especially if you are trying a different Windows
build system.</p></li> build system.</p></li>
<li><p>cd to the UxPlay source directory, then <li><p>cd to the UxPlay source directory, then
@@ -763,7 +772,7 @@ running uxplay if you attempt to run two instances of uxplay on the same
computer.) If UxPlay fails to find the true MAC address of a network computer.) If UxPlay fails to find the true MAC address of a network
card, (more specifically, the MAC address used by the first active card, (more specifically, the MAC address used by the first active
network interface detected) a random MAC address will be used even if network interface detected) a random MAC address will be used even if
option <strong>-m</strong> was not specifed. (Note that a random MAC option <strong>-m</strong> was not specified. (Note that a random MAC
address will be different each time UxPlay is started).</p> address will be different each time UxPlay is started).</p>
<p><strong>-t <em>timeout</em></strong> will cause the server to <p><strong>-t <em>timeout</em></strong> will cause the server to
relaunch (without stopping uxplay) if no connections have been present relaunch (without stopping uxplay) if no connections have been present

11
README.md
View File

@@ -2,6 +2,7 @@
### Now developed at the GitHub site [https://github.com/FDH2/UxPlay](https://github.com/FDH2/UxPlay) (where all user issues should be posted). ### Now developed at the GitHub site [https://github.com/FDH2/UxPlay](https://github.com/FDH2/UxPlay) (where all user issues should be posted).
### Linux distributions providing prebuilt uxplay packages include Debian "testing" (Bookworm), Ubuntu (since 22.04), and Ubuntu derivatives (install with "`sudo apt install uxplay`"). To easily build latest UxPlay from source, or for guidance on required GStreamer plugins, see [Getting UxPlay](#getting-uxplay) below. Raspberry Pi users see [here](https://github.com/FDH2/UxPlay/wiki/Gstreamer-Video4Linux2-plugin-patches).
Highlights: Highlights:
@@ -55,7 +56,7 @@ on the server display (with the possibility of
sharing that window on screen-sharing applications such as Zoom) sharing that window on screen-sharing applications such as Zoom)
on a host running Linux, macOS, or other unix (and now also Microsoft Windows). UxPlay supports on a host running Linux, macOS, or other unix (and now also Microsoft Windows). UxPlay supports
Apple's AirPlay2 protocol using "Legacy Pairing", but some features are missing. Apple's AirPlay2 protocol using "Legacy Pairing", but some features are missing.
(Details of what is publically known about Apple's AirPlay 2 protocol can be found (Details of what is publicly known about Apple's AirPlay 2 protocol can be found
[here](https://openairplay.github.io/airplay-spec/), [here](https://openairplay.github.io/airplay-spec/),
[here](https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol) and [here](https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol) and
[here](https://emanuelecozzi.net/docs/airplay2)). While there is no guarantee that future [here](https://emanuelecozzi.net/docs/airplay2)). While there is no guarantee that future
@@ -146,7 +147,7 @@ OpenSSL can be regarded as a "System Library", which it is in *BSD). Many Linux
as a "System Library", but some (e.g. Debian) do not: in this case, the issue is solved by linking as a "System Library", but some (e.g. Debian) do not: in this case, the issue is solved by linking
with OpenSSL-3.0.0 or later. with OpenSSL-3.0.0 or later.
# Getting UxPlay: # Getting UxPlay
* Your distribution may already provide a pre-built uxplay package. It will be included in the * Your distribution may already provide a pre-built uxplay package. It will be included in the
next Debian release "Bookworm" (currently in "testing" phase) and Ubuntu-22.04 already provides a uxplay-1.46 next Debian release "Bookworm" (currently in "testing" phase) and Ubuntu-22.04 already provides a uxplay-1.46
@@ -292,7 +293,7 @@ provides the best results.
* **For UxPlay-1.56 and later, if you are not using the latest GStreamer patches from the Wiki, you will need to use the UxPlay option `-bt709`**: * **For UxPlay-1.56 and later, if you are not using the latest GStreamer patches from the Wiki, you will need to use the UxPlay option `-bt709`**:
previously the GStreamer v4l2 plugin could previously the GStreamer v4l2 plugin could
not recognise Apple's color format (an unusual "full-range" variant of the bt709 HDTV standard), which -bt709 fixes. GStreamer-1.20.4 has not recognize Apple's color format (an unusual "full-range" variant of the bt709 HDTV standard), which -bt709 fixes. GStreamer-1.20.4 has
a fix for this, which is included in the latest patches, so beginning with UxPlay-1.56, the bt709 fix is no longer automatically a fix for this, which is included in the latest patches, so beginning with UxPlay-1.56, the bt709 fix is no longer automatically
applied. applied.
@@ -446,7 +447,7 @@ as the device is rotated).
Note that libplist will be linked statically to the uxplay executable. Note that libplist will be linked statically to the uxplay executable.
It should also be possible to install gstreamer for Windows from the It should also be possible to install gstreamer for Windows from the
[offical GStreamer site](https://gstreamer.freedesktop.org/download/), [official GStreamer site](https://gstreamer.freedesktop.org/download/),
especially if you are trying a different Windows build system. especially if you are trying a different Windows build system.
5. cd to the UxPlay source directory, then "`mkdir build`" and "``cd build``", followed by 5. cd to the UxPlay source directory, then "`mkdir build`" and "``cd build``", followed by
@@ -652,7 +653,7 @@ which will not work if a firewall is running.
attempt to run two instances of uxplay on the same computer.) attempt to run two instances of uxplay on the same computer.)
If UxPlay fails to find the true MAC address of a network card, (more If UxPlay fails to find the true MAC address of a network card, (more
specifically, the MAC address used by the first active network interface detected) specifically, the MAC address used by the first active network interface detected)
a random MAC address will be used even if option **-m** was not specifed. a random MAC address will be used even if option **-m** was not specified.
(Note that a random MAC address will be different each time UxPlay is started). (Note that a random MAC address will be different each time UxPlay is started).
**-t _timeout_** will cause the server to relaunch (without stopping uxplay) if no connections **-t _timeout_** will cause the server to relaunch (without stopping uxplay) if no connections

12
README.txt
View File

@@ -2,6 +2,8 @@
### Now developed at the GitHub site <https://github.com/FDH2/UxPlay> (where all user issues should be posted). ### Now developed at the GitHub site <https://github.com/FDH2/UxPlay> (where all user issues should be posted).
### Linux distributions providing prebuilt uxplay packages include Debian "testing" (Bookworm), Ubuntu (since 22.04), and Ubuntu derivatives (install with "`sudo apt install uxplay`"). To easily build latest UxPlay from source, or for guidance on required GStreamer plugins, see [Getting UxPlay](#getting-uxplay) below. Raspberry Pi users see [here](https://github.com/FDH2/UxPlay/wiki/Gstreamer-Video4Linux2-plugin-patches).
Highlights: Highlights:
- GPLv3, open source. - GPLv3, open source.
@@ -67,7 +69,7 @@ a window on the server display (with the possibility of sharing that
window on screen-sharing applications such as Zoom) on a host running window on screen-sharing applications such as Zoom) on a host running
Linux, macOS, or other unix (and now also Microsoft Windows). UxPlay Linux, macOS, or other unix (and now also Microsoft Windows). UxPlay
supports Apple's AirPlay2 protocol using "Legacy Pairing", but some supports Apple's AirPlay2 protocol using "Legacy Pairing", but some
features are missing. (Details of what is publically known about Apple's features are missing. (Details of what is publicly known about Apple's
AirPlay 2 protocol can be found AirPlay 2 protocol can be found
[here](https://openairplay.github.io/airplay-spec/), [here](https://openairplay.github.io/airplay-spec/),
[here](https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol) [here](https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol)
@@ -171,7 +173,7 @@ clause incompatible with the GPL unless OpenSSL can be regarded as a
OpenSSL as a "System Library", but some (e.g. Debian) do not: in this OpenSSL as a "System Library", but some (e.g. Debian) do not: in this
case, the issue is solved by linking with OpenSSL-3.0.0 or later. case, the issue is solved by linking with OpenSSL-3.0.0 or later.
# Getting UxPlay: # Getting UxPlay
- Your distribution may already provide a pre-built uxplay package. It - Your distribution may already provide a pre-built uxplay package. It
will be included in the next Debian release "Bookworm" (currently in will be included in the next Debian release "Bookworm" (currently in
@@ -348,7 +350,7 @@ results.
- **For UxPlay-1.56 and later, if you are not using the latest - **For UxPlay-1.56 and later, if you are not using the latest
GStreamer patches from the Wiki, you will need to use the UxPlay GStreamer patches from the Wiki, you will need to use the UxPlay
option `-bt709`**: previously the GStreamer v4l2 plugin could not option `-bt709`**: previously the GStreamer v4l2 plugin could not
recognise Apple's color format (an unusual "full-range" variant of recognize Apple's color format (an unusual "full-range" variant of
the bt709 HDTV standard), which -bt709 fixes. GStreamer-1.20.4 has a the bt709 HDTV standard), which -bt709 fixes. GStreamer-1.20.4 has a
fix for this, which is included in the latest patches, so beginning fix for this, which is included in the latest patches, so beginning
with UxPlay-1.56, the bt709 fix is no longer automatically applied. with UxPlay-1.56, the bt709 fix is no longer automatically applied.
@@ -540,7 +542,7 @@ landscape mode as the device is rotated).
Note that libplist will be linked statically to the uxplay Note that libplist will be linked statically to the uxplay
executable. It should also be possible to install gstreamer for executable. It should also be possible to install gstreamer for
Windows from the [offical GStreamer Windows from the [official GStreamer
site](https://gstreamer.freedesktop.org/download/), especially if site](https://gstreamer.freedesktop.org/download/), especially if
you are trying a different Windows build system. you are trying a different Windows build system.
@@ -789,7 +791,7 @@ running uxplay if you attempt to run two instances of uxplay on the same
computer.) If UxPlay fails to find the true MAC address of a network computer.) If UxPlay fails to find the true MAC address of a network
card, (more specifically, the MAC address used by the first active card, (more specifically, the MAC address used by the first active
network interface detected) a random MAC address will be used even if network interface detected) a random MAC address will be used even if
option **-m** was not specifed. (Note that a random MAC address will be option **-m** was not specified. (Note that a random MAC address will be
different each time UxPlay is started). different each time UxPlay is started).
**-t *timeout*** will cause the server to relaunch (without stopping **-t *timeout*** will cause the server to relaunch (without stopping