Document shared video stream lease behaviour
@@ -92,9 +92,9 @@
92
92
- ZIP_CACHE_DIR - Absolute path to the zip-cache/ directory (project root).
93
93
94
94
## server/video-stream.js
95
- createVideoStreamSession(sourcePath) - Probes the input duration, attempts WebVTT conversion for all subtitle streams (skipping only failed conversions), starts ffmpeg HLS transcoding, and resolves only when HLS assets are present (not subtitle files alone); returns durationSeconds, subtitleTracks, and subtitleSummary {total, converted, skipped}.
96
- sendVideoStreamAsset(sessionId, assetPath, req, res) - Serves HLS playlists, segments, and extracted subtitle files, tracks request lifecycle, and prunes old .ts segments once playback has moved beyond the configured retention window.
97
- releaseVideoStreamSession(sessionId) - Explicitly stops an active stream session, terminates ffmpeg, and removes temporary assets.
95
- createVideoStreamSession(sourcePath) - Probes input metadata and reuses a compatible active transcode session per source file when possible; returns a per-viewer lease id as sessionId plus duration/subtitle data.
96
- sendVideoStreamAsset(sessionId, assetPath, req, res) - Resolves viewer leases to a shared stream session, serves HLS assets, tracks lease activity, and prunes segments using the slowest active viewer position.
97
- releaseVideoStreamSession(sessionId) - Releases one viewer lease; only destroys the underlying transcode session when no active leases remain.
98
98
- STREAM_ROOT_DIR - Temporary root directory for active ffmpeg-backed stream sessions.
99
99
- STREAM_SESSION_TTL_MS - Idle lifetime for a stream session before cleanup.
100
100
- STREAM_IDLE_STOP_MS - Maximum client inactivity window before an active stream session is terminated (5 minutes).
@@ -252,6 +252,8 @@
252
252
- createVideoStreamSession configures flat segment filenames that match playlist URLs - Verifies ffmpeg segment output paths match the segment URLs emitted in the generated HLS playlists.
253
253
- createVideoStreamSession does not become ready from subtitle files alone - Verifies stream readiness is tied to HLS output instead of extracted subtitle files.
254
254
- createVideoStreamSession keeps playback available when subtitle conversion fails - Verifies subtitle conversion failures are skipped without breaking stream playback.
255
- sendVideoStreamAsset prunes old segment files after playback moves far ahead - Verifies old segments are removed only after the retention window passes.
256
- createVideoStreamSession reuses one transcode for concurrent viewers of the same file - Verifies two viewers share one ffmpeg transcode while keeping independent lease release behaviour.
255
257
256
258
## tests/share.page.load.test.js
257
259
- applies default caption settings for share-page video playback - Verifies requested caption defaults are applied and persisted on share-page video preview.
@@ -92,9 +92,9 @@92
- ZIP_CACHE_DIR - Absolute path to the zip-cache/ directory (project root).
92
- ZIP_CACHE_DIR - Absolute path to the zip-cache/ directory (project root).
93
93
94
## server/video-stream.js
94
## server/video-stream.js
95
- createVideoStreamSession(sourcePath) - Probes the input duration, attempts WebVTT conversion for all subtitle streams (skipping only failed conversions), starts ffmpeg HLS transcoding, and resolves only when HLS assets are present (not subtitle files alone); returns durationSeconds, subtitleTracks, and subtitleSummary {total, converted, skipped}.
95
- createVideoStreamSession(sourcePath) - Probes input metadata and reuses a compatible active transcode session per source file when possible; returns a per-viewer lease id as sessionId plus duration/subtitle data.
96
- sendVideoStreamAsset(sessionId, assetPath, req, res) - Serves HLS playlists, segments, and extracted subtitle files, tracks request lifecycle, and prunes old .ts segments once playback has moved beyond the configured retention window.
96
- sendVideoStreamAsset(sessionId, assetPath, req, res) - Resolves viewer leases to a shared stream session, serves HLS assets, tracks lease activity, and prunes segments using the slowest active viewer position.
97
- releaseVideoStreamSession(sessionId) - Explicitly stops an active stream session, terminates ffmpeg, and removes temporary assets.
97
- releaseVideoStreamSession(sessionId) - Releases one viewer lease; only destroys the underlying transcode session when no active leases remain.
98
- STREAM_ROOT_DIR - Temporary root directory for active ffmpeg-backed stream sessions.
98
- STREAM_ROOT_DIR - Temporary root directory for active ffmpeg-backed stream sessions.
99
- STREAM_SESSION_TTL_MS - Idle lifetime for a stream session before cleanup.
99
- STREAM_SESSION_TTL_MS - Idle lifetime for a stream session before cleanup.
100
- STREAM_IDLE_STOP_MS - Maximum client inactivity window before an active stream session is terminated (5 minutes).
100
- STREAM_IDLE_STOP_MS - Maximum client inactivity window before an active stream session is terminated (5 minutes).
@@ -252,6 +252,8 @@252
- createVideoStreamSession configures flat segment filenames that match playlist URLs - Verifies ffmpeg segment output paths match the segment URLs emitted in the generated HLS playlists.
252
- createVideoStreamSession configures flat segment filenames that match playlist URLs - Verifies ffmpeg segment output paths match the segment URLs emitted in the generated HLS playlists.
253
- createVideoStreamSession does not become ready from subtitle files alone - Verifies stream readiness is tied to HLS output instead of extracted subtitle files.
253
- createVideoStreamSession does not become ready from subtitle files alone - Verifies stream readiness is tied to HLS output instead of extracted subtitle files.
254
- createVideoStreamSession keeps playback available when subtitle conversion fails - Verifies subtitle conversion failures are skipped without breaking stream playback.
254
- createVideoStreamSession keeps playback available when subtitle conversion fails - Verifies subtitle conversion failures are skipped without breaking stream playback.
255
- sendVideoStreamAsset prunes old segment files after playback moves far ahead - Verifies old segments are removed only after the retention window passes.
256
- createVideoStreamSession reuses one transcode for concurrent viewers of the same file - Verifies two viewers share one ffmpeg transcode while keeping independent lease release behaviour.
255
257
256
## tests/share.page.load.test.js
258
## tests/share.page.load.test.js
257
- applies default caption settings for share-page video playback - Verifies requested caption defaults are applied and persisted on share-page video preview.
259
- applies default caption settings for share-page video playback - Verifies requested caption defaults are applied and persisted on share-page video preview.