Streaming

Mentra Miniapp SDK betaThe SDK is in beta, so its APIs may change before general availability.To put a miniapp in front of users, host it at an HTTPS URL and share the link, or get it listed in the Mentra Miniapp Store. See Publish your miniapp.Developing on Mentra Live? We recommend using the Mentra Bluetooth SDK.The developer tools are available in the Mentra App under Settings → Miniapp Developer Settings.Share feedback with an in-app bug report, on Discord, or by email at help@mentra.glass.

session.stream starts and stops a live video stream from camera glasses like Mentra Live. One method, startStream, covers both ways to stream: Mentra hosts it for you (the default), or you publish straight to a URL you own.

src/background/index.ts

// Managed: Mentra hosts the stream and gives you playback URLs.
const stream = await session.stream.startStream();
session.display.showReferenceCard("Live", stream.hlsUrl);

Managed streaming (default)

Call startStream() with no direct URL and Mentra provisions a hosted stream, handles transport and reconnection, and returns playback URLs. This is the right choice for most apps.

src/background/index.ts

// Hosted stream, optionally fanned out to your own destinations.
const stream = await session.stream.startStream({
  destinations: [{ url: "rtmp://a.rtmp.youtube.com/live2/KEY", name: "youtube" }],
});
// stream.hlsUrl, stream.dashUrl, stream.webrtcUrl

Option	Type	What it is
`destinations`	`Array<string \| { url; name? }>`	Restream targets the relay fans out to (YouTube, Twitch, …). Bare URLs or `{ url, name? }` objects, mixed freely.
`ingest`	`"srt" \| "whip" \| "rtmp"`	Latency/durability trade. `"srt"` (default): ~10-20s latency, HLS/DASH playback, recording. `"whip"`: sub-second WebRTC playback (`webrtcUrl`), no HLS/DASH, no recording; see WHIP goes through the phone. `"rtmp"`: RTMPS over TCP 443 with HLS playback, for networks that block UDP.
`video`	`StreamVideoConfig`	`width`, `height`, `bitrate`, `fps` (all optional).
`audio`	`StreamAudioConfig`	`bitrate`, `sampleRate`, `echoCancellation`, `noiseSuppression` (all optional).
`sound`	`boolean`	Play glasses-side start/stop sounds. Defaults to `true`.

WHIP goes through the phone

With ingest: "whip", the glasses don’t publish over their own Wi-Fi. They start a hotspot, the phone joins it, and the phone relays the stream to Mentra over its cellular connection. So:

The phone needs working cellular data (or Ethernet) while it streams.
Keep the phone near the glasses, and keep the Mentra App running.
If the phone leaves the glasses’ hotspot, for example to join a known Wi-Fi network, the relay drops. It reconnects by itself and reports reconnecting, then reconnected; see Stream status. While it does, the glasses’ Wi-Fi status can read as disconnected; that is the hotspot being rebuilt, not the cause of the drop.

For long sessions that don’t need sub-second latency, "srt" or "rtmp" lets the glasses publish from their own Wi-Fi with no phone relay.

Direct streaming

Pass direct with your own ingest URL (rtmp/rtmps/srt/whip) and the glasses publish straight to it, with no Mentra relay. You manage the endpoint, and no playback URLs come back.

src/background/index.ts

const stream = await session.stream.startStream({
  direct: "rtmp://example.com/live/STREAM-KEY",
  video: { fps: 30 },
});
// stream.streamId, pass it to stop()

video, audio, and sound work the same as managed. destinations and ingest are ignored for direct streams.

Result

startStream resolves to a StreamResult:

Field	Type	What it is
`streamId`	`string`	ID for this stream. Pass it to `stop`.
`status`	`string`	The stream’s reported state.
`resolvedConfig`	`StreamResolvedConfig`	The transport and the video/audio settings actually applied. Optional.
`hlsUrl`	`string`	HLS playback URL. Managed streams only.
`dashUrl`	`string`	DASH playback URL. Managed streams only.
`webrtcUrl`	`string`	WHEP playback URL. Managed streams in `"whip"` mode.
`liveInputId`	`string`	Hosted live-input UID, for building player URLs. Managed streams only.
`mode`	`"hls" \| "webrtc"`	Which playback the stream serves. Managed streams only.

Stream status

onStatus reports what happens to the stream after it starts. It returns an unsubscribe function.

src/background/index.ts

const unsubscribe = session.stream.onStatus((status) => {
  if (status.status === "reconnecting") showBanner("Reconnecting…");
  if (status.status === "reconnected") hideBanner();
  if (status.source === "coordinator" && status.status === "error") {
    // The stream has ended. Start a new one; it has new playback URLs.
    void session.stream.startStream({ ingest: "whip" });
  }
});

Each StreamStatus has streamId, status, and a source saying who reported it:

`source`	Statuses	What it means
`"glasses"`	`streaming`, `reconnecting`, `reconnected`, `error`, `stopped`, …	The glasses publisher. Reconnects carry `attempt` and `maxAttempts`; `terminal: true` means it gave up.
`"coordinator"`	`connected`, `reconnecting`, `reconnected`	The phone relay of a `"whip"` stream (`transport: "softap_relay"`).
`"coordinator"`	`suspended`, `resumed`	Bluetooth to the glasses dropped and came back. The stream ends if it stays down for 15 seconds.
`"coordinator"`	`hls_ready`, `webrtc_ready`	Playback is live.
`"coordinator"`	`error`	The stream has ended and must be started again. `reason` says why.
`"cloudflare"`	`connected`, `disconnected`	Whether the hosted ingest is receiving video, checked every 5 seconds. Managed streams only.

A stream that reconnects by itself keeps its streamId and playback URLs. After an error from "coordinator", call startStream() again.

Stop

stop ends the stream. Pass the streamId from the start result, or omit it to stop the active stream.

src/background/index.ts

await session.stream.stop(stream.streamId);

Getting Started

Core Concepts

UI Layer

Display

Audio & Speech

Sensors & Input

Camera

Phone & System

Data

Reference

Managed streaming (default)

WHIP goes through the phone

Direct streaming

Result

Stream status

Stop