Commands and options
Every command lists all of its options with --help.
15.1Commands
| Command | Does |
|---|---|
discover | Lists the receivers on the network. See Receivers. |
pair, unpair | Pairs with an Apple TV, or forgets the pairing. |
play | Plays a file or URL, or mirrors a camera or the screen. See Playing media. |
screen | Mirrors a screen or a window, with the computer's sound. See Sharing the screen. |
share | Shares a browser tab or a web page. See Sharing the screen and A web page on the TV. |
preview | Plays in a browser tab. See Playing to a browser. |
test-pattern | Sends a test pattern. See Latency. |
playshare | Plays a party game: a web app on the TV, phones join with a QR code. See Party games. |
bundle | Checks a party game, packs it into a zip, or starts a new one. See Making party games. |
tunnel | Puts a server on this computer on a public link. See Public links. |
qr | Prints a QR code, --svg or --rows for programs. |
debug-pipeline | Reads an input without a receiver. See ffmpeg and encoding. |
15.2Streaming
| Option | Effect |
|---|---|
--to NAME|ADDR | Where to send. Repeat for several receivers. |
--size WxH | The largest picture size. |
--fps N | Frames per second. |
--bitrate KBPS | Video bitrate. |
--encoder NAME | The video encoder, below. |
--no-audio | Picture only. |
--loop | Start over at the end. |
--realtime, --no-realtime | Read the input at playback speed, or not. Files are read at playback speed. |
--reconnect SECS | How long to reconnect a receiver that dropped out. Default 120, 0 is off. |
--latency MS | How long receivers wait before they show a frame. See Latency. |
--raw-video, --raw-audio | Frames and sound on standard input. See Game input. |
--ffmpeg PATH | The ffmpeg to use. |
15.3Browser player
These need --to browser.
| Option | Effect |
|---|---|
--open | Open the player page. |
--port PORT | The port of the player page. Default 8765. |
--wait-for-viewer | Wait for a tab before starting. |
--new-token | A new address for the player page. Old ones stop working. |
--tunnel[=PROVIDER] | Also on a public link: cloudflare, the default, or opentunnel. See Public links. |
--tunnel-ttl MIN | New viewers can join over the link for MIN minutes. |
--no-qr | No QR code of the public link in the terminal. |
15.4Share page
These need share without a URL.
| Option | Effect |
|---|---|
--tunnel[=PROVIDER] | The share page on a public link. See Public links. |
--tunnel-ttl MIN | The link lets people in for MIN minutes. Default 60, 0 is no limit. |
-y, --yes | Show a share from elsewhere without asking first. |
--no-qr | No QR code of the public link in the terminal. |
15.5Encoders
| Value | Encoder |
|---|---|
auto | Picks one. The default. |
builtin | tvpipe’s own encoder. |
x264 | Software, on every platform. |
videotoolbox | macOS hardware. |
nvenc | NVIDIA hardware. |
qsv | Intel Quick Sync. |
vaapi | Linux VA-API. |
mf | Windows Media Foundation. |