Skip to content

docs: bring the README status table in line with the code - #17

Merged
FrekiManagarm merged 1 commit into
mainfrom
docs/readme-status
Nov 7, 2026
Merged

FrekiManagarm merged 1 commit into
mainfrom
docs/readme-status

Conversation

@FrekiManagarm

@FrekiManagarm FrekiManagarm commented Nov 2, 2026 •

Copy link
Copy Markdown
Collaborator

The Project status table showed three ⚠️ rows that no longer match the code:

Row Was Now Evidence
Counter metrics endpoint ⚠️ packet/byte/keyframe counters never incremented ✅ Works record_rtp in src/signaling/session.rs:165, record_keyframe at :198
Keyframe requests (PLI) ⚠️ No-op (empty rx_ssrcs) ✅ Works request_keyframe addresses the stream by mid, src/transport/peer_connection.rs:436
SSRC / seq / timestamp rewrite ⚠️ Inert ✅ Not needed DownTrack only retargets the mid; str0m regenerates the header in media mode (src/media/down_track.rs)

Also:

  • Test count 147 → 148 (cargo test: 148 passed), in the README and CONTEXT.md (which said 98).
  • The NAT row now mentions SFU_UDP_PORT_MIN/MAX; it stays ⚠️ (no STUN, no srflx).
  • The paragraph under the table now only warns about NAT.

Docs only, no code change.

PLI is addressed by mid and reaches the publisher; the packet, byte and
keyframe counters are incremented; DownTrack no longer rewrites headers
(str0m does in media mode). Test count is 148. NAT/STUN is still the one
open warning.
@FrekiManagarm
FrekiManagarm merged commit cb13faf into main Nov 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant