Files
RTSP-Streamer/config.example.yaml
Levi Woodard caed091dc2 Add on-screen clock overlay (outlined text, configurable corner/timezone)
A small always-on-top mpv window renders the local time in a screen
corner. Implementation notes:

- Transparent lavfi canvas (color=...@0.0, --alpha=yes) so the camera
  video shows through; no new dependencies. If the compositor can't do
  alpha it degrades to a dark backing, still legible.
- Time drawn as an ASS osd-overlay pushed over mpv IPC once a second:
  white fill + black outline (\bord), so it reads on both bright (day)
  and dark (night) scenes without sampling the picture. Formatting the
  text in Go avoids any filtergraph escaping.
- Time computed with time.LoadLocation against a configured IANA zone
  (default "Local"), so it's correct regardless of the host clock's zone
  and handles DST. A bad zone name fails at startup.
- Managed on the daemon's own context (survives layout switches); the
  daemon keeps it positioned and raised above camera tiles. ensureClock
  is a no-op when the clock config + resolution are unchanged, so a
  reload never disturbs it.

Config: new `clock` section (enabled, timezone, format, corner,
font_size, width, height, margin) with defaults and corner validation.
Documented in README and config.example (shipped enabled, America/Denver,
24-hour w/ seconds). Tests cover corner geometry.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-02 14:20:49 -05:00

107 lines
4.7 KiB
YAML

# Example rtsp-streamer config. Copy to ~/.config/rtsp-streamer/config.yaml
# (or point $RTSP_STREAMER_CONFIG at it) and edit. Keep secrets out of it by
# using password_env instead of an inline password.
controller:
host: 192.168.1.1 # UniFi OS console IP / hostname
username: viewer # a local Protect user with camera view access
password_env: RTSP_STREAMER_PASSWORD # read the password from this env var
verify_tls: false # UniFi ships a self-signed cert
rtsp_port: 7441 # Protect RTSPS port (default)
# Pin the render resolution, or leave empty to auto-detect from the connected
# output via sway.
display:
width: 1920
height: 1080
player:
hwdec: v4l2m2m-copy # Pi 4 hardware H.264 decoder. "auto-safe" often
# won't engage it; "no" forces software.
profile: low-latency
max_fps: 0 # cap rendered fps (0 = uncapped); trims render load
audio: false # streams are muted by default (saves CPU too);
# set true to decode and play camera audio
resync_seconds: 600 # reconnect each stream to the live edge on this
# interval (staggered) so latency can't slowly
# drift; 0 = off. 600 keeps drift to a few sec.
restart_backoff_seconds: 3
extra_args: []
# Camera catalog. Normally populated by `rtsp-streamer discover`; shown here
# by hand for illustration. Each camera can carry multiple stream qualities
# (high/medium/low) so a tile can choose which to pull. Layouts reference
# cameras by `name`. (A single `rtsp:` URL instead of `streams:` also works.)
cameras:
- id: 60a1b2c3d4e5f6 # UniFi Protect camera id (blank for manual entries)
name: Front Door
streams:
high: rtsps://192.168.1.1:7441/aBcD1234?enableSrtp
low: rtsps://192.168.1.1:7441/aBcD5678?enableSrtp
- name: Driveway
streams:
high: rtsps://192.168.1.1:7441/eFgH1234?enableSrtp
low: rtsps://192.168.1.1:7441/eFgH5678?enableSrtp
- name: Back Yard
streams:
low: rtsps://192.168.1.1:7441/iJkL9012?enableSrtp
- name: Garage
rtsp: rtsps://192.168.1.1:7441/mNoP3456?enableSrtp # legacy single-URL form
# Layouts place cameras on a base grid (COLSxROWS). Cameras are "tiles" that
# may span multiple cells, so you can mix a big main view with small side
# tiles. Up to 16 cameras per layout. Edit these interactively with
# `rtsp-streamer tui` (a live ASCII preview shows the arrangement).
layouts:
# Simple even grid: four 1x1 tiles on a 2x2.
- name: quad
grid: 2x2
tiles:
- {camera: Front Door, col: 0, row: 0}
- {camera: Driveway, col: 1, row: 0}
- {camera: Back Yard, col: 0, row: 1}
- {camera: Garage, col: 1, row: 1}
# Security-wall style: one big 3x3 main view (high quality) + a right column
# of three small tiles on the low substream to keep decode load down.
- name: main-plus
grid: 4x3
tiles:
- {camera: Front Door, col: 0, row: 0, colspan: 3, rowspan: 3, quality: high}
- {camera: Driveway, col: 3, row: 0, quality: low}
- {camera: Back Yard, col: 3, row: 1, quality: low}
- {camera: Garage, col: 3, row: 2, quality: low}
- name: front-focus
grid: 1x1
tiles:
- {camera: Front Door, col: 0, row: 0}
# The older one-camera-per-cell "slots" form still works and is upgraded to
# tiles automatically when you edit it:
# grid: 3x3
# slots: [Front Door, Driveway, Back Yard, Garage, "", "", "", "", ""]
active_layout: quad
# On-screen clock overlay: a small always-on-top window showing the local time,
# drawn as white text with a black outline so it stays legible over both bright
# (day) and dark (night) camera scenes. The time is computed in the given
# timezone (DST handled automatically), independent of the host clock's zone.
clock:
enabled: true
timezone: America/Denver # IANA name; "Local" uses the system zone
format: "15:04:05" # Go time layout (24-hour w/ seconds). Others:
# "3:04:05 PM" · "Mon Jan 2 15:04"
corner: bottom-right # bottom-right | bottom-left | top-right | top-left
font_size: 44 # glyph height in px
width: 300 # overlay window size in px
height: 72
margin: 24 # gap from the screen edges in px
# Re-sync the active layout from its linked UniFi Protect live view every N
# seconds (0 = off). Layouts created by `views import` carry a `protect_view:`
# and are re-synced when this is set. Requires the controller password at
# runtime (export RTSP_STREAMER_PASSWORD for the daemon).
view_refresh_seconds: 0