From Node.js
The @tvpipe/sdk npm package controls tvpipe from Node. It plays files, URLs, the test pattern and web pages, and streams frames and sound that your program makes: a canvas, raw pixels, or H.264 from WebCodecs.
$ npm install @tvpipe/sdk
11.1Play something
import { play, testPattern, share } from "@tvpipe/sdk";
const session = await play("movie.mp4", { to: "Living Room" });
await session.done;
await testPattern({ to: ["Kitchen", "browser"] });
await share("https://status.example.com", { to: "Kitchen", reload: 30 });
to takes the same forms as --to on the command line (Receivers), a Device from discover(), or a list of them. If you leave to out, tvpipe uses the only receiver on the network that can show video. If there are several, the error lists them.
11.2Frames from your program
import { stream } from "@tvpipe/sdk";
const s = await stream({
to: "Living Room",
video: { width: 1280, height: 720, fps: 30, format: "rgba" },
audio: { sampleRate: 48000, channels: 2 },
});
s.drawLoop(canvas, (ctx, timeMs) => draw(ctx, timeMs)); // or s.writeVideo(rgba)
s.writeAudio(samples); // Float32Array or Int16Array
When tvpipe falls behind, video frames are dropped, not queued, so the stream stays real time. For H.264 you encode yourself, create the stream with codec: "h264" and pass each WebCodecs chunk to s.writeChunk(chunk, metadata). When a receiver needs a keyframe, the session emits a keyframe event.
11.3Sessions and errors
session.on("receiver", (r) => console.log(r.name, r.state));
await session.stop();
- Stopping.
stop(), anAbortSignalorawait usingstops the session. Every receiver gets the same clean teardown as with Ctrl-C. - When your program dies. If it exits or crashes, tvpipe notices and stops by itself.
- Errors. Every error is a
TvpipeErrorwith a readable message and a stablecode, such aspairing-requiredorffmpeg-missing.
11.4Public links
const p = await preview("movie.mp4", { player: { tunnel: true } });
console.log(p.publicUrl); // anyone with it can watch
const s = await share({ to: "TV", tunnel: "opentunnel", yes: true });
console.log(s.publicUrl); // someone elsewhere opens it and shares to the TV
tunnel: true uses Cloudflare, "opentunnel" OpenTunnel, as --tunnel does. session.publicUrl is the link. A session has no terminal to ask in, so remote shares need yes: true. See Public links.
11.5Pairing
import { pair } from "@tvpipe/sdk";
await pair("Living Room", { onPin: ({ name }) => askUser(`PIN on ${name}?`) });
Pass onPin to play() and the other functions, and a receiver that needs pairing is paired when it is first used. Pairings live in tvpipe's config directory (Configuration), the same one the command line tool uses. The configDir option points elsewhere.
11.6Other languages
The package uses tvpipe --machine: JSON events on standard output, commands on standard input. Any language can drive tvpipe the same way. The protocol is in docs/machine.md.