Cloud status

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.cloud reports whether the phone currently has a connection to MentraOS cloud. The phone owns that connection. Your miniapp does not open, configure, or close it. This module only observes and reports the current state, so you can render honest UX (an online/offline indicator, a “reconnecting” hint).

src/background/index.ts

import { registerMiniapp } from "@mentra/miniapp/background";

registerMiniapp((session) => {
  if (session.cloud.connected) {
    session.display.render([{type: "text", id: "msg", box: {x: 0, y: 0, w: 576, h: 288}, text: "Online"}]);
  }

  session.cloud.onStatusChanged((status) => {
    // status.status: "connected" | "connecting" | "reconnecting" | "disconnected"
    // status.audioTransport: "udp" | "ws" | "offline" | "none"
  });
});

This module needs no permission. It’s read-only.

Reading status

status returns the latest CloudClientStatus snapshot. connected is true only when status.status is "connected". isConnected() is a method alias for connected.

const snapshot = session.cloud.status;   // { status, audioTransport }
const online = session.cloud.connected;  // boolean
const same = session.cloud.isConnected(); // same value, function-style

Member	Returns	Notes
`status`	`CloudClientStatus`	Latest snapshot pushed by the phone.
`connected`	`boolean`	`true` when `status.status === "connected"`.
`isConnected()`	`boolean`	Method form of `connected`.
`onStatusChanged(handler)`	`UnsubscribeFn`	Subscribe to changes. Call the returned function to unsubscribe.

Watching for changes

onStatusChanged delivers the current value to your handler immediately, then calls it again on every change. You don’t need a separate read to hydrate UI.

const stop = session.cloud.onStatusChanged((status) => {
  render(status.status, status.audioTransport);
});

stop(); // unsubscribe

CloudClientStatus

interface CloudClientStatus {
  status: "connected" | "connecting" | "reconnecting" | "disconnected";
  audioTransport: "udp" | "ws" | "offline" | "none";
}

status is the connection state:

Value	Meaning
`connected`	The cloud-client handshake is complete.
`connecting`	A first connection is in progress.
`reconnecting`	A dropped connection is being re-established.
`disconnected`	No cloud connection.

audioTransport is how audio reaches the cloud when a connection exists:

Value	Meaning
`udp`	Audio over UDP.
`ws`	Audio over WebSocket.
`offline`	Connected, but no audio transport available.
`none`	No audio transport (the default before any status arrives).

Some capabilities depend on the cloud connection. session.transcription, session.translation, and cloud text-to-speech on session.speaker degrade or stop while status.status is not "connected". Use session.cloud to tell the user why, not to control the connection.

Getting Started

Core Concepts

UI Layer

Display

Audio & Speech

Sensors & Input

Camera

Phone & System

Data

Reference

Reading status

Watching for changes

CloudClientStatus