tvpipe tvpipeOperations Manual
Section 15Commands and options
15
Commands
play, preview
share, test-pattern

Commands and options

Every command lists all of its options with --help.

15.1Commands

CommandDoes
discoverLists the receivers on the network. See Receivers.
pair, unpairPairs with an Apple TV, or forgets the pairing.
playPlays a file or URL, or mirrors a camera or the screen. See Playing media.
screenMirrors a screen or a window, with the computer's sound. See Sharing the screen.
shareShares a browser tab or a web page. See Sharing the screen and A web page on the TV.
previewPlays in a browser tab. See Playing to a browser.
test-patternSends a test pattern. See Latency.
playsharePlays a party game: a web app on the TV, phones join with a QR code. See Party games.
bundleChecks a party game, packs it into a zip, or starts a new one. See Making party games.
tunnelPuts a server on this computer on a public link. See Public links.
qrPrints a QR code, --svg or --rows for programs.
debug-pipelineReads an input without a receiver. See ffmpeg and encoding.
Everywhere

-v More output.

--debug Protocol traces.

15.2Streaming

OptionEffect
--to NAME|ADDRWhere to send. Repeat for several receivers.
--size WxHThe largest picture size.
--fps NFrames per second.
--bitrate KBPSVideo bitrate.
--encoder NAMEThe video encoder, below.
--no-audioPicture only.
--loopStart over at the end.
--realtime, --no-realtimeRead the input at playback speed, or not. Files are read at playback speed.
--reconnect SECSHow long to reconnect a receiver that dropped out. Default 120, 0 is off.
--latency MSHow long receivers wait before they show a frame. See Latency.
--raw-video, --raw-audioFrames and sound on standard input. See Game input.
--ffmpeg PATHThe ffmpeg to use.

15.3Browser player

These need --to browser.

OptionEffect
--openOpen the player page.
--port PORTThe port of the player page. Default 8765.
--wait-for-viewerWait for a tab before starting.
--new-tokenA 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 MINNew viewers can join over the link for MIN minutes.
--no-qrNo QR code of the public link in the terminal.

15.4Share page

These need share without a URL.

OptionEffect
--tunnel[=PROVIDER]The share page on a public link. See Public links.
--tunnel-ttl MINThe link lets people in for MIN minutes. Default 60, 0 is no limit.
-y, --yesShow a share from elsewhere without asking first.
--no-qrNo QR code of the public link in the terminal.
Hardware

The hardware encoders need an ffmpeg built with them.

15.5Encoders

ValueEncoder
autoPicks one. The default.
builtintvpipe’s own encoder.
x264Software, on every platform.
videotoolboxmacOS hardware.
nvencNVIDIA hardware.
qsvIntel Quick Sync.
vaapiLinux VA-API.
mfWindows Media Foundation.