Codex: Document unsupported media transports

This commit is contained in:
winlin 2026-05-01 11:08:34 -04:00
parent 4b97841853
commit c2f2dc768a
2 changed files with 8 additions and 3 deletions

View File

@ -127,6 +127,12 @@ Which underlying transport (TCP or UDP) each protocol uses in SRS:
- **RTSP** — TCP. SRS only supports TCP transport (no UDP/RTP interleaved).
- **GB28181** — TCP. PS stream over TCP.
Related transport protocols that are important in the media industry but **not supported by SRS or Oryx**:
- **RIST** — UDP. Reliable Internet Stream Transport. Similar to SRT: a reliable, low-latency media transport over UDP, with retransmission and encryption options.
- **MoQ** — UDP/QUIC. Media over QUIC. An IETF effort for low-latency media ingest and delivery over QUIC, usually over UDP and optionally through WebTransport.
- **WebTransport** — UDP/QUIC, HTTP/3-based. A browser and network transport API/protocol that can carry media data, and one possible substrate for MoQ.
## Most Common Usage
The simplest way to use SRS: publish an RTMP stream and play it.
@ -292,4 +298,3 @@ Config files are in the `conf/` folder. Key files:
- Other files exist for specific features like clustering, DVR, or different protocols.
SRS also supports configuration via environment variables. This is especially useful for Docker and cloud-native deployments — you can set environment variables in YAML files or other platforms without needing a separate config file. It's convenient to copy and paste, making documentation clearer. In the SRS docs, environment variables are often used to show how to run SRS with different configurations.

View File

@ -65,7 +65,7 @@ func ExampleAmf0Object() {
// is number: false
}
func ExampleNewHandshake() {
func ExampleRTMPHandshake() {
client := rtmp.NewHandshake()
server := rtmp.NewHandshake()
@ -136,7 +136,7 @@ func ExampleNewHandshake() {
// server cached c1: true
}
func ExampleNewProtocol() {
func ExampleRTMPProtocol() {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()