VreoUnit schema

The script unit shape consumed by the Vreo Player.

VreoUnit is the script object consumed by Player.load. The package README describes it as the minimum unit for video, audio-like playback, and timed keyframes.

Top-level shape

{
  "categoryId": "257ac7a8-b00a-4a1b-88b8-76f93362c0dc",
  "categoryText": "Tour layout narration",
  "video": {
    "duration": 106278,
    "start": 0,
    "end": 106278,
    "url": "//example-cdn/video.mp4"
  },
  "keyframes": []
}

If video.url is an empty string, Vreo follows its audio-like playback path instead of playing a video URL.

Keyframes

Each keyframe is timed with start and end in milliseconds. The README examples include keyframe types such as:

Keyframe type	Typical use
`PanoTextLabel`	Timed text label in panorama space.
`ModelVideo`	Video surface mapped into model coordinates.
`PanoTag`	Panorama tag or image marker.
`PanoEffect`	Timed panorama effect.

Example text label

{
  "uuid": "ac70621b-4e00-442e-311c-befb5bd3f87f",
  "type": "PanoTextLabel",
  "start": 27060,
  "end": 42351,
  "parsed": false,
  "data": {
    "text": "Main bedroom",
    "vertex": {
      "x": -0.8879,
      "y": 0.383,
      "z": -1.8068
    },
    "fontSize": 16
  }
}

Data source

Store VreoUnit scripts in your own backend or CMS. If scripts need Realsee scene data, fetch that data server-side with provisioned Developer app credentials, then return the final browser-safe script to the page.