Skip to main content

​
Overview

The Play Video and Stop Video actions allow you to embed video files into your 3D scene. Videos are displayed on a virtual screen or surface within the scene environment, making them part of the immersive experience rather than overlays on the interface. Multiple videos can play simultaneously if placed on different surfaces, and you can control playback independently for each.

​
Play Video

​
When to Use

  • Instructional demonstrations: show a video of a process or procedure within the scene
  • Safety briefings: display compliance or safety videos embedded in the environment
  • Expert walkthroughs: show an expert demonstrating a task
  • Equipment tutorials: play manufacturer videos or instruction videos as part of the training
  • Context-building: show background or historical videos relevant to the training

​
Parameters

ParameterTypeRequiredDescription
Video AssetstringYesSelect a video file from your asset library.
AutoplaybooleanNoIf true, the video starts playing immediately. Default is false.
LoopbooleanNoIf true, the video repeats after finishing. Default is false.
VolumenumberNoVolume level from 0 to 1 (0 = silent, 1 = full volume). Default is 1.
MutedbooleanNoIf true, audio is muted regardless of volume setting. Default is false.
PositionX, Y, ZNoPosition of the video screen in 3D space (in meters).
RotationX, Y, ZNoRotation of the video screen (in degrees).
ScaleX, Y, ZNoSize of the video screen. Default is typically (1, 1, 1).

​
Key Behavior

  • Scene-embedded: The video appears as part of the 3D environment, not as an overlay.
  • Spatial audio: Video audio is positional and can be heard from the learner’s position in the scene.
  • Fire and forget: Play Video starts playback; subsequent actions don’t wait unless you add a Delay.
  • Multiple videos: You can play different videos on different surfaces simultaneously.

​
Stop Video

​
When to Use

  • Cleanup: stop video playback when exiting a state
  • Interrupt: stop a video if learner chooses a different action
  • Resource management: stop videos to free resources for other interactions

​
Parameters

ParameterTypeRequiredDescription
Target Action IDstringNo(Optional) Specify the Play Video action ID to stop only that video. If omitted, all playing videos stop.

​
Key Behavior

  • Omnibus or selective: Stop a specific video by action ID, or stop all videos if left empty.
  • Safe to call: Calling Stop Video when no video is playing has no effect.

​
Practical Examples

​
Instructional Video with Narration

Scenario: A training state displays a video demonstration of equipment setup. The video should autoplay, and the learner should wait for it to finish before proceeding.
1
In a state’s onEntry action list:
  1. Play Video:
    • Video Asset: equipment_setup_demo.mp4
    • Autoplay: true
    • Loop: false
    • Position: (0, 2, 0) — positioned at eye level in the scene
    • Rotation: (0, 0, 0)
  2. Delay: 90000 (90 seconds to match video length)
  3. Set Variable: videoWatched = true
2
The video plays automatically, the training waits for it to finish, then marks completion and allows transition to the next state.

​
Looping Instructional Video

Scenario: A video explains a procedure. It loops so learners can watch multiple times if needed.
1
In a state’s onEntry:
  • Play Video:
    • Video Asset: procedure_overview.mp4
    • Autoplay: true
    • Loop: true
    • Volume: 0.8
2
In the onExit:
  • Stop Video (no Target Action ID — stops all videos)
3
The video loops continuously while the state is active. When the learner transitions to a new state, the video stops.

​
Multiple Videos on Different Screens

Scenario: A warehouse training shows two monitors: one displays a safety briefing video, the other shows a live equipment feed.
1
In a state’s onEntry, add two separate Play Video actions:
  1. Play Video #1:
    • Video Asset: safety_briefing.mp4
    • Position: (-2, 2, 0) — left screen
    • Autoplay: true
  2. Play Video #2:
    • Video Asset: equipment_feed.mp4
    • Position: (2, 2, 0) — right screen
    • Autoplay: true
    • Loop: true
2
Both videos play simultaneously on their respective screens.

​
Stop Video on Learner Action

Scenario: A video plays, but if the learner clicks “skip,” the video stops and the training moves forward.
1
In the state’s onEntry:
  • Play Video: Video Asset: explanation.mp4 (assigned action ID: explanation_video)
2
Create a transition triggered by a “Skip Video” button:
  1. Stop Video: Target Action ID: explanation_video
  2. Transition to next state
3
The video stops immediately, and the learner advances.
Position videos at a natural viewing angle relative to the learner’s position in the scene. Typically, positioning videos 2–3 meters away and slightly above eye level (Y = 1.5–2.0) creates a comfortable viewing experience.
Videos stream from your asset library. Ensure your video files are optimized for the target playback environment (resolution, bitrate, codec). Large or poorly compressed videos may cause performance issues.
Always use Stop Video in the state’s onExit if video is playing, especially for looping videos. Otherwise, the video may continue playing after the state exits, consuming resources and potentially confusing learners.