Vreo plays a timed narrative over an existing Five SDK scene. A VreoUnit contains a narration media timeline and keyframes for actions such as camera movement and captions. Vreo does not create Work or generate narration from a prompt.
Choose a task
| Goal | Guide |
|---|---|
| Load a script and start from a user action | Quickstart |
| Pause, resume, replay, and clean up | Playback controls |
| Author camera movement and caption keyframes | Narrative keyframes |
| Use the published React provider and hooks | React integration |
The published keyframe enum also includes panorama text, panorama tags, information panels, video layers, effects, background music, panorama updates, and custom keyframes. A matching enum name alone does not validate data: each action has its own declared payload and scene or media prerequisites.
Compatible versions
| Package | Pinned version | Reason |
|---|---|---|
@realsee/vreo | 2.6.4 | Stable public package |
@realsee/dnalogel | 3.81.10 | Vreo's exact peer requirement |
@realsee/five | 6.9.2 | Satisfies the published Five peer range |
| React / React DOM | 18.3.1 | Vreo declares React 18 peers |
three | 0.117.1 | Exact Vreo peer |
@tweenjs/tween.js | 18.6.4 | Imported by published Vreo code but omitted from its runtime dependencies |
Dnalogel 3.81.12 does not satisfy Vreo's exact 3.81.10 peer dependency. Do not bypass that conflict with force flags.