uxplay(1)

1UXPLAY(1)                        User Commands                       UXPLAY(1)
2
3
4

NAME

6       uxplay - start AirPlay server
7

SYNOPSIS

9       uxplay [-n name] [-s wxh] [-p [n]] [more  OPTIONS  ...]
10

DESCRIPTION

12       UxPlay  1.66:  An  open-source  AirPlay  mirroring  (+ audio streaming)
13       server:
14

OPTIONS

16       -n name   Specify the network name of the AirPlay server
17
18       -nh       Do NOT append "@hostname" at end of AirPlay server name
19
20       -vsync[x] Mirror mode: sync audio to video using timestamps (default)
21
22                 x is optional audio delay: millisecs, decimal, can be neg.
23
24       -vsync no Switch off audio/(server)video timestamp synchronization.
25
26       -async[x] Audio-Only mode: sync audio to client video (default: no).
27
28       -async no Switch off audio/(client)video timestamp synchronization.
29
30       -s wxh[@r]Set display resolution [refresh_rate] default 1920x1080[@60]
31
32       -o        Set display "overscanned" mode on (not usually needed)
33
34       -fs       Full-screen (only works with X11, Wayland and VAAPI)
35
36       -p        Use legacy ports UDP 6000:6001:7011 TCP 7000:7001:7100
37
38       -p n      Use TCP and UDP ports n,n+1,n+2. range 1024-65535
39
40                 use "-p n1,n2,n3" to set each port, "n1,n2" for n3 = n2+1
41
42                 "-p tcp n" or "-p udp n" sets TCP or UDP ports separately.
43
44       -avdec    Force software h264 video decoding with libav decoder.
45
46       -vp prs   Choose GStreamer h264 parser; default "h264parse"
47
48       -vd dec   Choose GStreamer h264 decoder; default "decodebin"
49
50                 choices: (software) avdec_h264; (hardware) v4l2h264dec,
51
52                 nvdec, nvh264dec, vaapih264dec, vtdec, ...
53
54       -vc cnv   Choose GStreamer videoconverter; default "videoconvert"
55
56                 another choice when using v4l2h264dec: v4l2convert.
57
58       -vs sink  Choose the GStreamer videosink; default "autovideosink"
59
60                 choices: ximagesink,xvimagesink,vaapisink,glimagesink,
61
62                 gtksink,waylandsink,osxvideosink,kmssink,d3d11videosink,...
63
64       -vs 0     Streamed audio only, with no video display window.
65
66       -v4l2     Use Video4Linux2 for GPU hardware h264 video decoding.
67
68       -bt709    A workaround (bt709 color) that may be needed with -rpi.
69
70       -rpi      Same as "-v4l2" (for RPi=Rasberry Pi).
71
72       -rpigl    Same as "-rpi -vs glimagesink" for RPi.
73
74       -rpifb    Same as "-rpi -vs kmssink" for RPi using framebuffer.
75
76       -rpiwl    Same as "-rpi -vs waylandsink" for RPi using Wayland.
77
78       -as sink  Choose the GStreamer audiosink; default "autoaudiosink"
79
80                 choices:pulsesink,alsasink,pipewiresink,osssink,oss4sink,
81
82                 jackaudiosink,osxaudiosink,wasapisink,directsoundsink,..
83
84       -as 0     (or -a) Turn audio off, streamed video only.
85
86       -al x     Audio latency in seconds (default 0.25) reported to client.
87
88       -ca fn    In Airplay Audio (ALAC) mode, write cover-art to file fn.
89
90       -reset n  Reset after 3n seconds client silence (default 5, 0=never).
91
92       -nc       Do not close video window when client stops mirroring
93
94       -nohold   Drop current connection when new client connects.
95
96       -restrict Restrict clients to those specified by "-allow deviceID".
97
98                 Uxplay displays deviceID when a client attempts to connect.
99
100                 Use "-restrict no" for no client restrictions (default).
101
102       -allow id Permit deviceID = id to connect if restrictions are imposed.
103
104       -block id Always block connections from deviceID = id.
105
106       -FPSdata  Show video-streaming performance reports sent by client.
107
108       -fps n    Set maximum allowed streaming framerate, default 30
109
110       -f {H|V|I}Horizontal|Vertical flip, or both=Inversion=rotate 180 deg
111
112       -r {R|L}  Rotate 90 degrees Right (cw) or Left (ccw)
113
114       -m        Use random MAC address (use for concurrent UxPlay's)
115
116       -vdmp [n] Dump h264 video output to "fn.h264"; fn="videodump", change
117
118                 with "-vdmp [n] filename". If [n] is given, file fn.x.h264
119
120                 x=1,2,.. opens whenever a new SPS/PPS NAL arrives, and <=n
121
122                 NAL units are dumped.
123
124       -admp [n] Dump audio output to "fn.x.fmt", fmt ={aac, alac, aud}, x
125
126                 =1,2,..; fn="audiodump"; change with "-admp [n] filename".
127
128                 x increases when audio format changes. If n is given, <= n
129
130                 audio packets are dumped. "aud"= unknown format.
131
132       -d        Enable debug logging
133
134       -v        Displays version information
135
136       -h        Displays help information
137

FILES

139       Options in one of $UXPLAYRC, or ~/.uxplayrc, or  ~/.config/uxplayrc
140
141       are applied first (command-line options may modify them). uxplayrc for‐
142       mat:
143
144       one option per line, no initial "-"; lines beginning with "#" ignored.
145

AUTHORS

147       Various, see website or distribution.
148

COPYRIGHT

150       Various,  see  website or distribution.  License: GPL v3+: GNU GPL ver‐
151       sion 3 or later.
152
153       (some parts LGPL v.2.1+ or MIT).
154