Documentation
Docs/en/reference/video/index.md
Generated Video Reference
Generated reference. Do not edit directly. Update
BuildTools/VideoInterface.json, then runpython BuildTools/docs_video.py --write.
| Index | Formats | Delivery | Decoding | Fullscreen | Embedded | Validation | Canonical JSON | Guide |
This reference describes the revision-pinned Engine video primitive. It is experimental: a game cinematic system, subtitles, policy, asset ownership, and acceptance evidence remain project concerns.
Contract status
| Field | Value |
|---|---|
| Stability | experimental |
| Support policy | The current CPU-decoded Ogg/Theora path is revision-pinned while focused native fixtures, production cinematic evidence, and a versioned compatibility policy are missing. |
| Source manifest | BuildTools/VideoInterface.json |
| Contract digest | e71428249d2e234edc19b825ca4b70363179c0570a9b8dccf304bea729c04d29 |
| Resource | .ogv / Ogg / Theora |
| Whole resource buffered | True |
| Container audio decoded | False |
| Runtime side | client |
| Focused native video tests | 0 |
| Reference | Entries | Purpose |
|---|---|---|
| Formats | 2 | Container, codec, and pixel-format requirements. |
| Delivery | 4 | Raw-copy, exact paths, runtime ownership, and memory. |
| Decoding | 7 | Ogg/Theora decode, frame clock, color, and failure rules. |
| Fullscreen | 9 | Replacement, queue, input, music, drawing, and status. |
| Embedded | 7 | Script-owned playback and RenderIface drawing. |
| Validation | 5 | Visible acceptance gates and known coverage gaps. |
Boundary
Included:
- OGV raw-copy delivery and exact-path resource loading
- Ogg packetization and Theora header/frame decoding
- CPU YCbCr-to-RGBA conversion and texture upload
- fullscreen playback, queues, input interruption, and separate music pairing
- script-created rectangular VideoPlayback instances
- current diagnostics, limitations, and embedding-project validation
Excluded:
- project cinematic catalogs, story triggers, subtitle systems, localization, skip policy, and save-state consequences
- container audio decoding, voice tracks, audio mixing, and synchronization beyond a separately started music resource
- hardware/platform media decoders, streaming from disk or network, adaptive bitrate, and DRM
- MP4, WebM, AVI, MPEG, animated images, and non-Theora Ogg video
- mastering, accessibility, licensing, attribution, and source provenance