Skip to content

Commit 8fb06ec

Browse files
steveseguinactions-user
authored andcommitted
docs(viewer): Document splash screen options and auto-reconnect
Adds documentation for new features related to the viewer mode in `README.md`: - Details `--splashscreen-idle` and `--splashscreen-connecting` CLI options for custom splash images. - Explains that `publish.py --view` now keeps HDMI output active during publisher disconnections, displaying the idle splash screen instead of a black frame. - Notes the automatic re-requesting of streams by the viewer after graceful disconnects. - Updates the 'Recent Changes' section to reflect these enhancements from January 2025. [auto-enhanced]
1 parent 08d99b7 commit 8fb06ec

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,10 @@ options:
356356
--pipeline PIPELINE A full custom pipeline
357357
--record RECORD Specify a stream ID to record to disk. System will not publish a stream when enabled.
358358
--view VIEW Specify a stream ID to play out to the local display/audio.
359+
--splashscreen-idle PATH
360+
Provide a still image that is shown whenever the remote video is muted or disconnected (viewer mode).
361+
--splashscreen-connecting PATH
362+
Optional splash image displayed while the viewer is waiting for the remote stream to start.
359363
--save Save a copy of the outbound stream to disk. Publish Live + Store the video.
360364
--record-room Record all streams in a room to separate files. Requires --room parameter.
361365
Audio recording is enabled by default; use --noaudio to disable.
@@ -389,6 +393,13 @@ options:
389393
--clockstamp Add a clock overlay to the video output, if possible
390394
```
391395

396+
##### Viewer splash screens & auto-restart
397+
398+
- Running `python3 publish.py --view <stream-id>` now keeps the HDMI output alive while waiting for the publisher to reconnect. The idle splash stays visible instead of dropping to black.
399+
- Use `--splashscreen-idle /path/to/image.jpg` to provide a 16:9 still that is shown whenever the remote video is muted or hangs up. If not supplied the viewer falls back to a built-in blank frame.
400+
- Optionally supply `--splashscreen-connecting /path/to/image.jpg` for a different image while the WebRTC session negotiates.
401+
- The viewer automatically re-requests the stream after a disconnect. You can set `RN_DEBUG_DISPLAY=1` while testing to see the splash state transitions and retry logs.
402+
392403
##### Changing video input sources
393404

394405
Using `gst-device-monitor-1.0` will list available devices and their 'caps', or settings. This can help determine what GStreamer pipeline changes need to be made in the script or getting info about what video format options are available for your device.
@@ -1012,6 +1023,7 @@ curl -X POST -F "record=meeting_2024_01_22" -F "process_pid=12345" -F "language=
10121023
## Recent Changes
10131024

10141025
### January 2025
1026+
- **Viewer splash pipeline & auto-reconnect**: Viewer mode now keeps the HDMI sink alive when a publisher disconnects, continuing to show the idle splash instead of a black frame. Customize the visuals with the new `--splashscreen-idle` and `--splashscreen-connecting` options; the viewer automatically re-requests the stream after graceful disconnects.
10151027
- **NDI Direct Mode Now Default**: Changed `--room-ndi` to use direct mode by default, creating separate audio/video NDI streams to avoid combiner freezing issues. Added `--ndi-combine` flag for users who need the problematic combiner mode.
10161028
- **Fixed NDI Freezing Issue**: Implemented workaround for ndisinkcombiner freezing after ~1500 buffers by defaulting to direct NDI mode with separate streams.
10171029
- **HLS Recording Support**: Added HLS (HTTP Live Streaming) recording with automatic VP8 to H.264 transcoding. Creates segmented TS files and M3U8 playlists for easy HTTP streaming.

0 commit comments

Comments
 (0)