Your Website / Embedding

Advanced Embed Options

For web developers: URL parameters to control the embedded tour — lock to a scene, hide interface, auto-rotate, and cursor-driven motion.

This page is for web developers building a deeper integration — a hero section showing a single slowly-rotating room, a gallery of scenes, or a tour that reacts to the visitor's cursor. If you just want the tour on a page, Embedding Basics is all you need.

How it works

Add query parameters to the tour URL in your iframe's src:

<iframe
  src="https://your-tour-address/?mode=scene&scene=SCENE_ID&ui=none&autoRotate=1"
  width="100%"
  height="600"
  style="border: 0;"
  allow="fullscreen; gyroscope; accelerometer; xr-spatial-tracking"
></iframe>

We'll provide the scene IDs for your tour on request.

Parameters

Scene & interface

Parameter	Values	Default	Effect
`mode`	`full`, `scene`	`full`	`scene` locks the embed to a single scene — no navigating away.
`scene`	scene ID	start scene	Which scene to show first.
`ui`	`full`, `none`	`full`	`none` hides the viewer interface (menus, buttons) for a clean, ambient look.
`hotspots`	`showAll`, `hideAll`, `hideNavigation`, `hideNonNavigation`	`showAll`	Show all hotspots, hide all non-media hotspots, hide navigation hotspots, or hide non-navigation hotspots.
`videoHotspots`	`0` to disable	on	Hide video hotspots.
`audioHotspots`	`0` to disable	on	Hide audio hotspots.
`imageHotspots`	`0` to disable	on	Hide image hotspots.

Input

Parameter	Values	Default	Effect
`drag`	`0` to disable	on	Disable drag-to-look.
`zoom`	`0` to disable	on	Disable zooming.
`keyboard`	`0` to disable	on	Disable keyboard controls.
`gyro`	`0` to disable	on	Disable phone motion controls.
`xr`	`0` to disable	on	Disable VR headset mode.

Auto-rotate

Parameter	Values	Default	Effect
`autoRotate`	`1` to enable	off	Slowly rotate the view when idle.
`autoRotateSpeed`	`0.1`–`12`	`2`	Rotation speed.
`autoRotateDirection`	`left`, `right`	`right`	Rotation direction.
`autoRotateIdleDelay`	`0`–`30`	`3`	Seconds of inactivity before rotation resumes.

Cursor-driven motion

For hero sections where the panorama subtly follows the visitor's mouse:

Parameter	Values	Default	Effect
`cursor`	`none`, `parent`	`none`	`parent` lets the embedding page drive the view from its own cursor position.
`cursorMaxYaw`	`0`–`45`	`5`	Maximum horizontal sway, in degrees.
`cursorMaxPitch`	`0`–`30`	`5`	Maximum vertical sway, in degrees.
`cursorDamping`	`0.01`–`1`	`0.08`	Smoothing — lower is floatier.
`motionMode`	`relative`, `absolute`	`relative`	How pointer position maps to camera movement.

With cursor=parent, the embedding page reports its pointer via postMessage to the iframe:

const frame = document.querySelector("iframe");

document.addEventListener("mousemove", (event) => {
  frame.contentWindow.postMessage(
    {
      type: "realview:pointer",
      payload: {
        // Normalized to the range -1..1 across the page
        x: (event.clientX / window.innerWidth) * 2 - 1,
        y: (event.clientY / window.innerHeight) * 2 - 1,
        active: true,
      },
    },
    "*"
  );
});

Example recipes

Ambient hero background — one scene, no interface, slow rotation, no interaction:

?mode=scene&scene=SCENE_ID&ui=none&hotspots=hideAll&drag=0&zoom=0&keyboard=0&autoRotate=1&autoRotateSpeed=0.5&autoRotateIdleDelay=0

Cursor-follow hero — the room sways gently with the visitor's mouse:

?mode=scene&scene=SCENE_ID&ui=none&hotspots=hideAll&drag=0&zoom=0&cursor=parent&cursorMaxYaw=8&cursorMaxPitch=4

Scene gallery — several small embeds, each locked to a different room, tour opens full from a click-through link:

?mode=scene&scene=SCENE_ID&ui=none&hotspots=hideAll