cloudxr-js-sdk

NVIDIA CloudXR.js SDK

Applies to: AI coding assistants helping users build WebXR apps with @nvidia/cloudxr. This is the lean coding-focused quick reference. Read this when: Scaffolding a new client, generating minimal integration code, or wiring up basic Session lifecycle. For detailed types, see agent-api-reference.md.

CloudXR.js streams XR content from a GPU server to a web browser. The server renders; the client displays video and sends back head/hand tracking. Think "Netflix for VR."

Quick Start

Install

From NGC tarball:

npm install nvidia-cloudxr-<version>.tgz

Peer dependencies (app must provide): gl-matrix, long.

Minimal Integration (5 steps)

import { createSession, SessionState } from '@nvidia/cloudxr';

// 1. Get WebXR session + WebGL context
const xrSession = await navigator.xr.requestSession('immersive-vr', {
  optionalFeatures: ['local-floor'],
});
const gl = xrSession.renderState.baseLayer.context;
const referenceSpace = await xrSession.requestReferenceSpace('local-floor');

// 2. Create CloudXR session
const session = createSession(
  {
    serverAddress: '192.168.1.100',
    serverPort: 49100,
    useSecureConnection: false,
    gl,
    perEyeWidth: 2048,
    perEyeHeight: 1792,
    referenceSpace,
  },
  {
    onStreamStarted: () => console.log('Streaming'),
    onStreamStopped: err => err && console.error(err.message),
  }
);

// 3. Connect
session.connect();

// 4. Render loop
function onFrame(time, frame) {
  session.sendTrackingStateToServer(time, frame);
  session.render(time, frame, xrSession.renderState.baseLayer);
  xrSession.requestAnimationFrame(onFrame);
}
xrSession.requestAnimationFrame(onFrame);

// 5. Disconnect when done
session.disconnect();

Core API

Export	Purpose
createSession(options, delegates?)	Create a session. Returns Session.
Session	Interface: state, connect(), disconnect(), sendTrackingStateToServer(), render(), availableMessageChannels
SessionOptions	Config: server address/port, WebGL context, resolution, codec, bitrate, ICE servers, etc.
SessionDelegates	Callbacks: onStreamStarted, onStreamStopped, onWebGLStateChangeBegin/End, onMetrics, onLog
SessionState	Enum: Initialized → Connecting → Connected → Disconnecting → Disconnected → Error
MessageChannel	Binary data channel for custom app messages (preferred over deprecated sendServerMessage)