Skip to main content
Documentation

Vreo

Scripted spatial playback for Five SDK scenes, camera movement, narration, effects, and guided presentation flows.

@realsee/vreo@2.6.2 is the Realsee 3D spatial script player. It combines the Five SDK rendering engine with React-based UI modules to play a timeline of camera movement, narration, panorama tags, video effects, model video, and guided presentation content.

The package exports the core Player class:

import { Five } from '@realsee/five'
import { Player } from '@realsee/vreo'

const five = new Five()
const player = new Player(five, {
  autoPreload: true,
  imageOptions: { size: 1024 },
})

await player.load(vreoUnit)
player.play()

Version note

This page is adapted from the published overseas npm package:

PackageVerified versionNotes
@realsee/vreo2.6.2npm tarball README and lib/Player/index.d.ts
@realsee/dnalogel@3.67.0 peer3.67.0peer dependency in Vreo package metadata
Portal Dnalogel docs@realsee/dnalogel@3.81.0newer package metadata used by this docs tree
@realsee/five peer^6.4.0-alpha.1package peer dependency
three peer0.117.1exact peer dependency
react / react-dom peer^18.0.0Vreo UI modules are React-based

Because this portal is on React 19 and does not install Vreo as a runtime dependency, treat these docs as integration guidance for your own app rather than code that runs inside the portal bundle.

What Vreo plays

Vreo is useful when a spatial scene needs a directed experience:

  • Camera movement through panorama or model views.
  • Narration or audio-like playback.
  • Panorama tags and text labels timed to a script.
  • Video or model video effects.
  • Presenter-style UI modules layered over Five.

Runtime model

A Vreo integration has three moving parts:

  1. A loaded Five SDK scene.
  2. A Player instance bound to that Five SDK instance.
  3. A VreoUnit script that contains video metadata and timed keyframes.

Use Five SDK Quickstart first, then add Vreo once the scene lifecycle is stable.

Next steps