Documentation
Docs/en/reference/video/validation.md
Video Validation Contract
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 |
| Stable ID | Rule | Requirement | Why | Source |
|---|---|---|---|---|
video.validation.raw-copy |
Delivered-byte validation | Bake and inspect the exact client resource path and bytes before runtime playback. | RawCopy is the only delivery transform and runtime paths are exact. | Source/Tools/RawCopyBaker.cpp |
video.validation.visible-client |
Visible-client requirement | Validate first frame, motion, end, skip, queue, resize, and texture cleanup in a visible client on every claimed platform. | No headless or source-only check proves texture upload and presentation. | Source/Client/Client.cpp |
video.validation.no-native-fixture |
Missing native video fixture | Treat the lack of Test_Video or Test_Theora as a coverage gap and keep visible regression evidence mandatory. | The current native test inventory contains no focused video decoder/playback source. | Source/Tests/README.md |
video.validation.loop-risk |
Looping requires explicit proof | Do not promise looping cinematics until a multi-cycle visible regression proves decoder rewind and frame continuity for the exact asset. | SetLooped is exposed through creation, but the current source has no focused loop fixture. | Source/Client/VideoClip.cpp |
video.validation.project-boundary |
Embedding-project acceptance | An embedding project owns cinematic triggers, recipients, skip/queue policy, subtitles, localization, aspect fit, audio strategy, save consequences, assets, provenance, budgets, and acceptance tests. | The Engine supplies decoder and presentation primitives, not a game cinematic system. | Source/Scripting/ClientGlobalScriptMethods.cpp |
Validation commands
python BuildTools\docs_video.py --check
python -m unittest BuildTools.tests.test_docs_video
cmake --build <build-dir> --config RelWithDebInfo --target RunUnitTests
There is no focused native video decoder/playback fixture. A visible client must prove first frame, sustained motion, completion, skip, queue transitions, resizing, paired music behavior, cleanup, and multi-cycle looping for every exact asset and claimed platform.