startVideoStream function to live stream a client screen

[SuperCraft3M]

This pull request introduces a new "live relay" streaming mode for video capture, allowing real-time streaming of WebM segments directly to a callback without writing to disk. This enables low-latency, gap-free playback via MediaSource Extensions (MSE) on the client side. The implementation adds a new startVideoStream export, updates capture options to support chunk size tuning for latency, and introduces new logic for segmenting and relaying live WebM streams. Documentation and type definitions are updated accordingly.

Live relay streaming support:

• Added startVideoStream server-side export, which starts a continuous video capture and relays live MSE-appendable WebM segments (init + media) to a provided onSegment callback, supporting real-time streaming use cases. [1] [2] [3] [4] [5] [6] [7] [8]
• Introduced new types (StreamSegment, StreamSegmentFn) and extended StreamUploadData and CaptureOptions to support relay mode, segment callbacks, and chunk size configuration. [1] [2] [3] [4]

WebM segment framing and relay logic:

• Added new file webm-stream.ts implementing logic to split the continuous WebM byte stream into MSE-appendable segments (init and media) and invoke the onSegment callback in real time.
• Integrated the relay logic into both HTTP and NUI streaming handlers so that relay streams forward segments live, while non-relay streams continue to assemble files on disk. [1] [2] [3] [4] [5]

Capture options and configuration:

• Added streamChunkSize option to capture requests (client and server), allowing tuning of WebM output chunk size to trade off latency versus overhead. Defaults to 800 KiB if not specified. [1] [2] [3] [4]

Documentation:

• Updated README.md with detailed documentation and usage examples for the new startVideoStream export, including explanation of segment structure, options, and integration with MediaSource Extensions. Also updated stopVideoCapture docs to reference the new streaming mode. [1] [2]

---

Every comment on the files an this description is made by AI btw. All the code is done by myself.

[Copilot]

Pull request overview

This PR adds a new live relay capture mode that streams WebM data as MSE-appendable segments to a server-side callback (startVideoStream), enabling low-latency playback without writing recordings to disk.

Changes:

• Added startVideoStream export and server-side relay plumbing to forward live WebM segments (init + per-Cluster media) to an onSegment callback.
• Introduced streamChunkSize capture option to tune streaming latency vs overhead, wired through to the NUI encoder output chunking.
• Updated documentation and refreshed dependency lockfiles.

Reviewed changes

Copilot reviewed 8 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
README.md	Documents the new startVideoStream export and updates stopVideoCapture docs to include it.
pnpm-lock.yaml	Updates dependency resolutions for pnpm-managed workspace.
package-lock.json	Adds an npm lockfile (new file) in addition to pnpm lockfile.
game/server/webm-stream.ts	New WebM framing logic to split a continuous append-only WebM stream into init and media segments.
game/server/upload-store.ts	Stores relay-mode flags and in-memory framing state for active streams.
game/server/types.ts	Adds relay types (StreamSegment, StreamSegmentFn) and extends stream/capture option types.
game/server/stream.ts	Routes NUI stream chunks either to disk (existing) or to live relay framing (new).
game/server/koa-router.ts	Routes HTTP stream chunks either to disk (existing) or to live relay framing (new); relay finalization flushes without touching disk.
game/server/export.ts	Exposes startVideoStream and wires it to stream setup with relay mode enabled.
game/nui/src/capture-stream.ts	Accepts streamChunkSize and uses it as the encoder/stream target chunk size.
.gitignore	Adds ignores for game/.turbo, game/node_modules, and game/dist.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.