Skip to content

docs: transports and udp:// slots in the READMEs (#75) - #81

Merged
compot-dev merged 1 commit into
v2from
docs/transports
Oct 12, 2026
Merged

compot-dev merged 1 commit into
v2from
docs/transports

Conversation

@compot-dev

Copy link
Copy Markdown
Collaborator

Closes #75. Documents the transport work merged in #70, #72 and #73 in all three READMEs (EN/RU/ZH).

  • New section "Transports": TCP (default) / UDP / Auto / Multicast; how the video arrives, what each one is for, and when it falls back to TCP. OpenIPC Majestic and XM cameras reply 400/451 to RTSP multicast and play over TCP in the same connection (checked in Device testing: UDP, plain RTP and RTSP multicast (#70, #72, #73) #74).
  • UDP slots (Majestic outgoing): URL forms (udp://@:5600, udp://@239.1.2.3:5600, udp://source@group:port, ?codec=/&pt=); codec chosen by payload type 96/97 and followed when it changes; one port per slot. How to add the destination in /etc/majestic.yaml, /api/v1/outgoing.json for its state, and multicast destinations (Majestic does send to a group: confirmed in Device testing: UDP, plain RTP and RTSP multicast (#70, #72, #73) #74).
  • Shared links: the transport extra, with an adb example.
  • Updated: Features, Requirements, Quick start, the menu table (Settings = URL + transport, U), the reserved ninth cell (points to udp:// slots), Known limitations (RTSP over TCP only removed; RTSP multicast needs Android 8.0+), Architecture (Transport, UdpReceiver, RtpReorder, RtpListener), and the security note (RTP over UDP is not encrypted either).
  • Tables realigned.

Documentation only.

- New section Transports: TCP / UDP / Auto / Multicast, what each does and its fallback;
  OpenIPC Majestic and XM reply 400/451 to RTSP multicast and play over TCP
- udp:// slots for Majestic outgoing: URL forms, codec by payload type, codec=/pt=,
  one port per slot, the outgoing destination in /etc/majestic.yaml,
  /api/v1/outgoing.json, multicast destinations (confirmed in #74)
- The transport extra of a shared link, with an adb example
- Requirements, features, quick start, the menu table, the reserved ninth cell,
  Known limitations (RTSP multicast needs Android 8.0+), Architecture (Transport,
  UdpReceiver, RtpReorder, RtpListener) and the security note updated; EN/RU/ZH
@compot-dev

Copy link
Copy Markdown
Collaborator Author

/review

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can commit Qodo's fix in one click with committable suggestions (GitHub & GitLab)

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@compot-dev
compot-dev merged commit f1facc4 into v2 Oct 12, 2026
4 checks passed
@compot-dev
compot-dev deleted the docs/transports branch October 13, 2026 17:15
compot-dev added a commit that referenced this pull request Oct 15, 2026
docs: transports and udp:// slots in the READMEs (#75)
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.

docs: README for transports (TCP/UDP/Auto/Multicast) and udp:// slots

1 participant