Documentation
Docs/en/reference/video/delivery.md
Video Resource Delivery
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.delivery.raw-copy |
Raw-copy delivery | Keep ogv in Baking.RawCopyFileExtensions and include RawCopy in the client-only resource pack that owns video files. | There is no video baker; playback consumes the delivered bytes. | Source/Common/Settings.inc, Source/Tools/RawCopyBaker.cpp |
video.delivery.exact-path |
Exact resource path | Pass the complete delivered video path, including its extension; video lookup has no default suffix or normalized stem index. | Both fullscreen and script-owned paths call Resources.ReadFile with the supplied path. | Source/Client/Client.cpp, Source/Scripting/ClientGlobalScriptMethods.cpp |
video.delivery.client-only |
Client runtime ownership | Deliver video to client resources and invoke playback on the client or mapper runtime. | Decoding, texture creation, drawing, and exported methods live in the client layer. | Source/Scripting/ClientGlobalScriptMethods.cpp |
video.delivery.memory-budget |
Whole-resource memory budget | Budget compressed file bytes, one CPU RGBA frame, and one GPU texture for each active playback; the stock path is not streaming from the resource store. | ReadFile.GetData moves the complete resource into VideoClip.RawVideoData before packet decoding. | Source/Client/VideoClip.cpp, Source/Scripting/ClientGlobalScriptMethods.cpp |