SRS Interne Dokumentation
Leite SRS- und Oryx-Aufgaben zu fokussierten Dokumentationsreferenzen. Die übergeordnete Fähigkeit besitzt die benutzerseitige Aufgabe; diese Fähigkeit besitzt die Dokumentationsnavigation und die gebündelte Projektdokumentation.
Kernregeln
- Verwende das aktuelle Arbeitsverzeichnis als Projektwurzel. Durchsuche keine übergeordneten Verzeichnisse und entdecke keine alternativen Repository-Wurzeln.
- Verwende den Referenz-Router, bevor du eine Referenz oder ein gebündeltes Dokument lädst.
- Lade nur die Referenzen und gebündelten Dokumente, die für die Aufgabe relevant sind. Lade nicht alles.
- Behandle nur Projektdateien, die in dieser Fähigkeit oder einer ausgewählten Referenz aufgeführt sind, als vertrauenswürdige Dokumentation.
- Wenn keine Route die Aufgabe abdeckt, melde, dass der Dokumentationsrouter sie nicht abdeckt. Scanne oder durchsuche keine Dokumentationsverzeichnisse global.
- Wähle die kleinste relevante Menge von Projektdokumenten anhand ihrer Beschreibungen aus.
- Behalte das vertrauenswürdige Dokumentationsrouting in dieser Fähigkeit. Dupliziere keine Thema-zu-Datei-Tabellen in abhängigen Fähigkeiten.
Pfadauflösung
- Löse gebündelte Pfade, die mit
references/,scripts/,assets/oderagents/beginnen, relativ zum Verzeichnis auf, das dieseSKILL.mdenthält, nicht zum aktuellen Arbeitsverzeichnis. - Löse Repository-Pfade wie
trunk/,internal/,cmd/oderskills/relativ zum aktuellen Arbeitsverzeichnis auf. - Für die in ihrem Repository gespeicherte Oryx-Dokumentation verwende den projektswurzel-relativen Pfad
oryx/. Der Pfad kann ein Verzeichnis oder ein Symlink zum bevorzugten Checkout des Benutzers sein. Löse den Symlink nicht auf und suche nicht nach alternativen Oryx-Wurzeln. Wenn der Pfad nicht verfügbar ist, bitte den Benutzer, dashttps://github.com/ossrs/oryx-Checkout dort verfügbar zu machen; erstelle es nicht automatisch. - Verwende das aktuell aufgerufene Fähigkeitsverzeichnis. Suche nicht nach alternativen Kopien unter tool-spezifischen Verzeichnissen wie
.agents/,.kiro/oder.claude/. - Bevor du eine geroutete Datei als fehlend meldest, überprüfe ihren vollständig aufgelösten Pfad direkt.
Referenz-Router
C++-Medienserver Versionen
Zum Verfolgen und für Versionen des C++-Medienservers lade:
trunk/doc/CHANGELOG.md— Vollständiges Änderungsprotokoll aller SRS-Versionen, mit einem Eintrag und Versionssprung pro zusammengeführtem Pull-Request.
C++-Medienserver Benutzerdokumentation
Für die Benutzerdokumentation des C++-Medienservers wähle das kleinste relevante Dokument aus:
references/cpp-docs/doc/introduction.md— SRS-Überblick, unterstützte Protokolle, Funktionsliste, State-Threads-Architektur und Lernpfad.references/cpp-docs/doc/getting-started.md— Docker-Schnellstart, RTMP-Veröffentlichung, HTTP-FLV/HLS-Wiedergabe, WebRTC, HTTPS, SRT und Stream-URL-Muster.references/cpp-docs/doc/getting-started-ai.md— SRS Robot, lokale KI-Agenten, das Fähigkeitensystem und die Projekt-Wissensdatenbank-Philosophie.references/cpp-docs/doc/getting-started-build.md— SRS aus dem Quellcode erstellen und Cross-Build für ARM oder MIPS.references/cpp-docs/doc/getting-started-cdk.md— SRS auf AWS mit srs-cdk bereitstellen.references/cpp-docs/doc/rtmp.md— RTMP-Nutzung, Enhanced RTMP, Konfiguration, RTMPS, Protokollvergleiche und Codec-Geschichte.references/cpp-docs/doc/hls.md— HLS-Kompatibilität, Latenz, Segmentkonfiguration, HTTPS und Audio-Transcodierung von WebRTC.references/cpp-docs/doc/webrtc.md— WHIP/WHEP, SFU-Architektur, RTMP-zu-RTC-Konvertierung, TURN/ICE, Audio-Transcodierung, NACK- und RTX-Neuübertragung und Plattformnutzung.references/cpp-docs/doc/flv.md— HTTP-FLV-Auslieferung, Konfiguration, Latenz, Protokollvergleiche und Browser-Kompatibilität.references/cpp-docs/doc/srt.md— SRT-Transport, Latenz, MPEG-TS-Verkapselung, HEVC, Konfiguration, Stream-IDs und Schwachnetzwerkverhalten.references/cpp-docs/doc/rtsp.md— RTSP-Wiedergabe, TCP-Transport, RTMP-Veröffentlichungsworkflow, Konfiguration und Build-Option.references/cpp-docs/doc/gb28181.md— Externes-SIP GB28181 Medienveröffentlichung, HTTP-Sessionserstellung, TCP-Transport, Timeout-Konfiguration und Session-Lebenszyklus.references/cpp-docs/doc/http-server.md— Eingebetteter HTTP-Server, HLS/statisches Serving, API-Endpunkt, Konfiguration und Reverse-Proxies.references/cpp-docs/doc/hevc.md— H.265/HEVC-Protokollkompatibilität, Enhanced RTMP, Encoder-Setup und Bandbreiten-Kompromisse.references/cpp-docs/doc/dvr.md— FLV/MP4-Aufzeichnung, Pläne, Pfade, HTTP-Callbacks und Oryx-Aufzeichnungsfunktionen.references/cpp-docs/doc/ingest.md— Externe Dateien, RTSP-Kameras oder HTTP-Streams via FFmpeg ziehen und an SRS weiterveröffentlichen.references/cpp-docs/doc/forward.md— RTMP-Streams an andere Server weiterleiten, Master/Slave-Rollen konfigurieren und Weiterleitung mit Edge-Modus vergleichen.references/cpp-docs/doc/security.md— IP- und CIDR-Erlauben/Verweigern-Regeln für Veröffentlichung und Wiedergabe.references/cpp-docs/doc/snapshot.md— Stream-Miniaturansichten via HTTP-Callbacks oder Transcoder erfassen.references/cpp-docs/doc/http-api.md— HTTP-API-Endpunkte für Server-, Stream- und Client-Statistiken, inklusive CORS- und Konsolenintegration.references/cpp-docs/doc/http-callback.md— Ereignis-Callbacks für Verbindung, Veröffentlichung, Wiedergabe, DVR, Authentifizierung und Geschäftslogik.references/cpp-docs/doc/exporter.md— Prometheus-Metriken, Grafana-Integration, Labels, Tags und Cloud-native Beobachtbarkeit.references/cpp-docs/doc/origin-cluster.md— Proxy-basierte Lastverteilung über Origin-Server und die Go-Proxy-Architektur.references/cpp-docs/doc/edge.md— Edge-Caching, Pull-on-Play, Push-on-Publish und mehrstufige CDN-Topologie.references/cpp-docs/doc/nginx-for-hls.md— HLS/DASH über NGINX verteilen und cachen.references/cpp-docs/doc/resource.md— Port-, Firewall-, HTTPS- und Ressourcen-Referenz.references/cpp-docs/doc/low-latency.md— RTMP-Latenzoptimierung, GOP- und Warteschlangeneinstellungen, Merge-Write-Optimierung und Protokollvergleich.references/cpp-docs/doc/performance.md— UDP-Optimierung, perf, gprof, Valgrind, ASAN, Leckerkennung und Benchmarking-Methodik.references/cpp-docs/doc/ffmpeg.md— FFmpeg-Transcodierung, Multi-Bitrate-Ausgabe, Stream-Filterung und Konfiguration pro Vhost/App/Stream.
C++-Medienserver Webseiten
Für Webseiten des C++-Medienservers wähle die kleinste relevante Seite aus:
references/cpp-docs/pages/faq-server-en.md— SRS-Server-FAQ zu CDN, VoD, häufigen Fehlern, Protokollproblemen und Community-Support.references/cpp-docs/pages/license-en.md— Lizenzen von SRS, State Threads und Drittanbieter-Bibliotheken.references/cpp-docs/pages/product-en.md— Veröffentlichungsmeilensteine, Codenamen, Errungenschaften und Produktgeschichte.references/cpp-docs/pages/security-advisories-en.md— Veröffentlichte CVEs, betroffene Versionen, Patches und Sicherheitsreferenzen.
Oryx-Dokumentation
Für die Oryx-Dokumentation wähle das kleinste relevante Dokument aus:
references/oryx/getting-started-oryx.md— Oryx-Überblick, Bereitstellung, Vergleich mit SRS, Authentifizierung, Aufzeichnung, Weiterleitung, virtuelles Live, Transcodierung, KI-Funktionen, OpenAPI und HTTP-Callbacks.references/oryx/faq-oryx-en.md— Oryx-Setup, Upgrades, HTTPS, Authentifizierung, Aufzeichnung auf lokale Festplatte oder S3-kompatiblen Cloud-Speicher, Re-Streaming und häufige Betriebsfragen.oryx/README.md— Oryx-Überblick, Docker-Bereitstellung, Ports, persistentes/data-Layout, Umgebungsvariablen, Funktionen und Abhängigkeiten.oryx/DEVELOPER.md— Oryx-OpenAPI, Umgebungsvariablen, Ports, Bereitstellungsvarianten, Entwicklungsworkflows, Tests und Änderungsprotokoll.references/oryx/2022-04-09-Oryx-Tutorial.md— Ein-Klick-, Docker-, Lightsail- und DigitalOcean-Bereitstellung, sowie RTMP-, WebRTC- und SRT-Einstieg.references/oryx/2022-04-12-Oryx-HTTPS.md— DNS, automatisches HTTPS, Let's Encrypt und Zertifikatserneuerung.references/oryx/2022-04-15-Oryx-WordPress-Plugin.md— HLS-, HTTP-FLV- und WebRTC-Streams in WordPress einbetten.references/oryx/2022-04-29-BT-aaPanel.md— Oryx über aaPanel installieren und betreiben.references/oryx/2023-08-29-Oryx-Ensuring-Authentication-for-Live-Streaming-Publishing.md— Globale Publish-Secret-Authentifizierung und ihre Grenzen.references/oryx/2023-09-09-Oryx-Multi-Platform-Streaming.md— An YouTube, Twitch und Facebook weiterstreamen.references/oryx/2023-09-10-Oryx-Record-Live-Streaming.md— Serverseitige Aufzeichnung, MP4-Generierung, Filter und lokaler oder S3-kompatibler Cloud-Speicher.references/oryx/2023-09-11-Oryx-Virtual-Live-Events.md— Voraufgezeichnete Dateien als Live-Streams veröffentlichen.references/oryx/2023-10-11-Oryx-Stream-IP-Camera-Events.md— RTSP-Kameras ziehen und an Streaming-Plattformen weiterleiten.references/oryx/2023-10-21-Oryx-Live-Transcoding.md— FFmpeg-basierte Bitraten- und Auflösungs-Transcodierung.references/oryx/2023-11-28-Oryx-Live-Streams-Transcription.md— Whisper-Transkription, eingebettete Untertitel und WebVTT.references/oryx/2023-12-12-Oryx-OBS-WHIP-Service.md— WHIP aus OBS veröffentlichen und über WHEP abspielen.references/oryx/2024-01-31-Browser-Voice-Driven-GPT.md— Browser-Sprachassistent, Live-Räume, Sprachcoaching und Übersetzung.references/oryx/2024-02-21-Dubbing-Translating.md— Videoübersetzung, ASR, TTS, Segmentbearbeitung und Export.references/oryx/2024-05-20-OCR-Video-Streams.md— Live-Stream-OCR, konfigurierbare KI-Anweisungen und Callbacks.
Für Oryx bevorzuge den Einstiegsleitfaden, die FAQ und die Repository-Dokumentation. Behandle datierte Blogs als szenariospezifische Anleitungen. Wenn sich Befehle, UI-Bezeichnungen, Werkzeuge oder Verhalten unterscheiden, bevorzuge die Dokumentation, die zur Version des Benutzers von Oryx passt.
RTMP Go API-Beispiele
Für RTMP-Go-API-Beispiele lade:
internal/rtmp/example_test.go— RTMP-API-Beispiele für AMF0, Handshake und Protokoll-Workflows.
WHEP-Leistungsanalyse
Für die WHEP-Leistungsanalyse lade:
references/perf/proxy-whep.md— Profilierung von WHEP mit pprof und srs-bench und Vergleich von CPU, Allokation, Heap, Goroutinen und Trace-Daten.
Dokumentation für den Go-Proxy der nächsten Generation
Für die Dokumentation des Go-Proxys der nächsten Generation wähle das kleinste relevante Dokument aus:
references/proxy/features.md— Proxy-Funktionsstatus und -Einschränkungen, einschließlich implementierter Protokolle, APIs, Lastausgleich, Bereitstellung, Konfiguration, Betrieb und aktueller Einschränkungen.references/proxy/proxy-design.md— Proxy-Architektur, einschließlich zustandslosem Proxy-Design, integriertem Lastausgleich, Redis-Modus und horizontaler Skalierung.references/proxy/proxy-protocol.md— Backend-Registrierung, Debugging-Backend, Heartbeat-Protokoll und Umgebungsvariablen.references/proxy/proxy-usage.md— Erste Schritte mit dem Proxy: bauen, starten, registrieren, veröffentlichen und mit einem SRS-Origin verifizieren.references/proxy/proxy-load-balancer.md— Lastausgleichsverhalten für Speicher- und Redis-Lastausgleicher, Stream-Zuordnung, Gesundheitsüberwachung und Protokollzustand.references/proxy/proxy-origin-cluster.md— Produktions-Origin-Cluster: fortgeschrittene Nutzung zum Konfigurieren und Verifizieren eines Multi-Origin-Clusters über den Proxy.
Wenn eine Aufgabe mehrere Bereiche umfasst, lade nur die erforderlichen Referenzen oder gebündelten Dokumente aus den Listen.
Arbeitsablauf
- Klassifiziere den Dokumentationsbedarf mit dem Referenz-Router.
- Löse den ausgewählten Pfad gemäß Pfadauflösung auf, dann lade das Projekt- oder gebündelte Dokument direkt.
- Lade nur die für die Aufgabe erforderlichen Dokumente.
- Gib die Kontrolle an die übergeordnete Fähigkeit zurück für Antwort, Entwicklung, Fehlerbehebung, Überprüfung oder Bearbeitung.
Wenn direkt aufgerufen, folge demselben Routing-Workflow und wende dann den relevanten Support- oder Entwicklungsworkflow an.
Wartung des Routers
- Aktualisiere den Referenz-Router, wenn ein vertrauenswürdiges Dokument hinzugefügt, entfernt, umbenannt wird oder seine Zuständigkeit ändert.
- Halte Router-Zusammenfassungen und Dateibeschreibungen präzise und auf die Navigation fokussiert.
- Dupliziere keine Dokumentinhalte oder Implementierungsdetails im Router.