Commit Graph
11 Commits
Author SHA1 Message Date
SteveGilvarryandClaude Fable 5 8b6d8c4179 docs: document the monitor stream socket and its wire protocol
Adds docs/stream_socket.rst covering the socket path convention, access
control and queue tuning settings, and the version 1 wire protocol
(header layout, HELLO TLVs, MEDIA/KEYFRAME/STATS/BYE semantics,
sequence/generation loss and discontinuity signalling), with pointers
to the reference encoder/decoder, the C++ consumer class and the python
dump tool. Linked from the documentation index.

This also serves as the migration reference for external consumers of
the removed media FIFOs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-09-16 05:02:24 +10:00
Isaac Connor 481210feaf Rough in web ui api documentation. Add download event video documentation. 2024-07-05 15:37:12 -04:00
Pliable Pixels 5f55bbfc5c add slack and forum links at the start so they are easy to discover 2019-10-28 12:28:02 -04:00
Pliable Pixels b3943e0c49 consistent naming of ES -> Event Notification Server 2019-10-27 10:47:09 -04:00
Pliable Pixels 8f251689f6 Add ES/ML link to root doc 2019-10-25 12:04:09 -04:00
Dmitry Smirnov 5bcc414038 codespell: misc. spelling corrections
Signed-off-by: Dmitry Smirnov <onlyjob@member.fsf.org>
2016-02-08 20:41:36 +11:00
SteveGilvarry 9795967298 Initial attempt to migrate wiki to readthedocs 2014-07-13 22:25:30 +10:00
Kyle Johnson cb2a9af647 Added a doc for contributing to the project 2014-04-30 13:48:03 +00:00
Kyle Johnson 4d2f270041 Added FAQ to docs 2014-04-30 03:11:20 +00:00
Kyle Johnson 8dd7d3e934 Initial commit of documentation for the API 2014-04-25 19:13:32 +00:00
Kyle Johnson 48304d2322 Initial commit of Sphinx docs directory 2014-04-25 18:33:41 +00:00