AURA

JSGG

AuraJS
DOCSEXAMPLESGITHUB
12 Video and Cutscenes
Video helpers, cutscene patterns, and native media presentation guidance.
docs/external/game-dev-api/12-video-cutscenes-web-and-react.md

Video and Cutscenes

This page groups the current native media and cutscene surfaces.

`aura.video`

Current runtime methods:

  • load(source, options?)
  • play(videoHandle)
  • pause(videoHandle)
  • stop(videoHandle)
  • seek(videoHandle, time)
  • getTexture(videoHandle)
  • getInfo(videoHandle)
  • setLooping(videoHandle, enabled)
  • unload(videoHandle)
  • createBillboardSurface(source, options?)
  • createPresentation(source, options?)

Current honest contract:

  • AuraJS can stream video-like content into a texture.
  • Native desktop hosts can load .mp4 through the same aura.video surface.
  • Native .mp4 decode is handled in-process via the embedded video codec library. No external tools are required for video playback.
  • Current proof is oriented around texture-backed playback rather than a full engine-managed cutscene stack.
  • Treat this as runtime media texturing support, not as full Unity-style codec/audio/subtitle/skip/checkpoint orchestration.

Companion 3D media helpers:

  • aura.audio.createSpatialEmitter(path, options?)
  • aura.video.createBillboardSurface(source, options?)
  • aura.video.createPresentation(source, options?)

`@auraindustry/aurajs/cutscene`

The package exports a JS helper for the current cutscene layer:

  • createVideoCutsceneController(...)
  • createSpatialAudioEmitter(...)
  • createVideoBillboardSurface(...)
  • createMediaPresentationController(...)

This helper is documented in:

  • docs/video-cutscene-contract-v1.md
  • docs/native-mp4-video-contract-v1.md
  • docs/native-media-presentation-contract-v1.md

Use it when you want:

  • cue-based cutscene control over aura.video
  • JS-side sequencing without pretending the engine already owns full cinematic playback
  • one native-only authored path for video plus a separate audio asset

When to use which layer

Use runtime aura.video when you need:

  • a texture-backed playback source inside a game scene
  • native desktop .mp4 screens or in-world playback
  • billboarded/video-textured meshes
  • stylized in-engine video moments

Use @auraindustry/aurajs/cutscene when you need:

  • JS-side cue sequencing around video playback
  • pause/skip/advance orchestration above raw video handles
  • a small helper layer for world-space video surfaces plus spatial audio
  • the canonical native desktop path for separate video + audio presentation
DOCUMENT REFERENCE
docs/external/game-dev-api/12-video-cutscenes-web-and-react.md
AURAJS
Cmd/Ctrl+K
aurajsgg