Communitygithub.com

ossrs/srs

Aiguille les tâches SRS et Oryx vers le plus petit ensemble pertinent de documentation de projet de confiance et maintient la documentation du projet incluse dans cette compétence. À utiliser lorsque le travail de support ou de développement nécessite de localiser, choisir, lire, créer, mettre à jour ou réviser la documentation SRS, ou lorsque le travail Oryx nécessite de la documentation de projet pour le déploiement, le streaming, l'authentification, l'enregistrement vers un stockage local ou compatible S3, la rediffusion, le live virtuel, la caméra, le transcodage, HTTPS, les API, les callbacks, les fonctionnalités d'IA ou le développement. Inclut la documentation du serveur média C++, la documentation du projet Oryx, les pages du site web, le journal des modifications, les exemples d'API exécutables, ainsi que la documentation du serveur Go de nouvelle génération et des performances.

Qu'est-ce que srs ?

Cette compétence est un routeur de documentation interne pour les projets SRS (serveur média C++) et Oryx. Son objectif principal est d'aider les agents IA, comme Claude Code ou Cursor, à naviguer efficacement dans la documentation de confiance du projet. Au lieu de parcourir l'intégralité de la base de code ou d'effectuer des recherches larges, l'agent utilise cette compétence pour sélectionner et charger uniquement les fichiers de documentation pertinents pour la tâche à accomplir. La compétence est structurée autour de plusieurs catégories de documentation : le serveur média C++, les pages du site web du serveur C++, la documentation d'Oryx (y compris des articles de blog datés, des guides de démarrage et des FAQ), des exemples d'API Go RTMP, des analyses de performances WHEP, et la documentation du proxy Go de nouvelle génération. Pour chaque catégorie, un routeur de référence est fourni, listant les documents individuels avec une brève description. Le fonctionnement est simple : l'agent de plus haut niveau (la compétence parente) délègue à cette compétence la tâche de trouver la bonne documentation. La compétence utilise le routeur de référence pour identifier les documents pertinents, résout les chemins de fichiers (en distinguant les chemins relatifs au référentiel et les chemins inclus avec la compétence), puis charge uniquement ces documents. Une fois la documentation chargée, le contrôle est rendu à la compétence parente pour répondre à la question, effectuer un développement ou un débogage. Cette approche permet d'éviter de surcharger le contexte de l'agent avec des informations non pertinentes, garantissant que la réponse est précise, rapide et basée uniquement sur les sources de confiance. La compétence inclut également des règles strictes pour la résolution des chemins et les mises à jour du routeur lui-même.

Compatible avec✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/ossrs/srs/tree/HEAD/skills/internal-docs-for-srs

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Documentation interne SRS

Aiguille les tâches SRS et Oryx vers des références documentaires ciblées. La compétence parente gère la tâche orientée utilisateur ; cette compétence gère la navigation dans la documentation et la documentation de projet incluse.

Règles de base

  • Utilisez le répertoire de travail actuel comme racine du projet. Ne cherchez pas dans les répertoires parents et ne découvrez pas d'autres racines de référentiel.
  • Utilisez le routeur de référence avant de charger une quelconque référence ou un document inclus.
  • Chargez uniquement les références et les documents inclus pertinents pour la tâche. Ne chargez pas tout.
  • Considérez uniquement les fichiers du projet listés dans cette compétence ou une référence sélectionnée comme documentation de confiance.
  • Si aucun itinéraire ne couvre la tâche, signalez que le routeur de documentation ne la couvre pas. Ne parcourez pas et n'effectuez pas de recherches généralisées dans les répertoires de documentation.
  • Sélectionnez le plus petit ensemble pertinent de documents du projet à partir de leurs descriptions.
  • Conservez l'acheminement de la documentation de confiance dans cette compétence. Ne dupliquez pas les tables sujet-fichier dans les compétences dépendantes.

Résolution de chemin

  • Résolvez les chemins inclus commençant par references/, scripts/, assets/ ou agents/ par rapport au répertoire contenant ce fichier SKILL.md, et non par rapport au répertoire de travail actuel.
  • Résolvez les chemins du référentiel tels que trunk/, internal/, cmd/ ou skills/ par rapport au répertoire de travail actuel.
  • Pour la documentation Oryx stockée dans son référentiel, utilisez le chemin oryx/ relatif à la racine du projet. Le chemin peut être un répertoire ou un lien symbolique vers l'extraction préférée de l'utilisateur. Ne résolvez pas le lien symbolique et ne cherchez pas d'autres racines Oryx. Si le chemin n'est pas disponible, demandez à l'utilisateur de rendre l'extraction de https://github.com/ossrs/oryx disponible à cet endroit ; ne la créez pas automatiquement.
  • Utilisez le répertoire de compétence actuellement invoqué. Ne cherchez pas d'autres copies sous des répertoires spécifiques à l'outil tels que .agents/, .kiro/ ou .claude/.
  • Avant de signaler qu'un fichier routé est manquant, vérifiez son chemin entièrement résolu directement.

Routeur de référence

Versions du serveur média C++

Pour le suivi et les versions du serveur média C++, chargez :

  • trunk/doc/CHANGELOG.md — Journal des modifications complet de toutes les versions SRS, avec une entrée et une augmentation de version pour chaque pull request fusionnée.

Documentation utilisateur du serveur média C++

Pour la documentation utilisateur du serveur média C++, sélectionnez le document pertinent le plus petit :

  • references/cpp-docs/doc/introduction.md — Présentation de SRS, protocoles pris en charge, liste des fonctionnalités, architecture State Threads et parcours d'apprentissage.
  • references/cpp-docs/doc/getting-started.md — Démarrage rapide avec Docker, publication RTMP, lecture HTTP-FLV/HLS, WebRTC, HTTPS, SRT et modèles d'URL de flux.
  • references/cpp-docs/doc/getting-started-ai.md — Robot SRS, agents IA locaux, système de compétences et philosophie de la base de connaissances du projet.
  • references/cpp-docs/doc/getting-started-build.md — Compiler SRS à partir des sources et cross-compiler pour ARM ou MIPS.
  • references/cpp-docs/doc/getting-started-cdk.md — Déployer SRS sur AWS avec srs-cdk.
  • references/cpp-docs/doc/rtmp.md — Utilisation de RTMP, Enhanced RTMP, configuration, RTMPS, comparaisons de protocoles et historique des codecs.
  • references/cpp-docs/doc/hls.md — Compatibilité HLS, latence, configuration des segments, HTTPS et transcodage audio depuis WebRTC.
  • references/cpp-docs/doc/webrtc.md — WHIP/WHEP, architecture SFU, conversion RTMP-vers-RTC, TURN/ICE, transcodage audio, retransmission NACK et RTX, et utilisation sur les plateformes.
  • references/cpp-docs/doc/flv.md — Distribution HTTP-FLV, configuration, latence, comparaisons de protocoles et compatibilité navigateur.
  • references/cpp-docs/doc/srt.md — Transport SRT, latence, encapsulation MPEG-TS, HEVC, configuration, identifiants de flux et comportement sur réseau faible.
  • references/cpp-docs/doc/rtsp.md — Lecture RTSP, transport TCP, workflow de publication RTMP, configuration et option de compilation.
  • references/cpp-docs/doc/gb28181.md — Publication média GB28181 via External-SIP, création de session HTTP, transport TCP, configuration du délai d'attente et cycle de vie de la session.
  • references/cpp-docs/doc/http-server.md — Serveur HTTP intégré, service HLS/statique, point de terminaison API, configuration et proxys inverses.
  • references/cpp-docs/doc/hevc.md — Compatibilité du protocole H.265/HEVC, Enhanced RTMP, configuration de l'encodeur et compromis de bande passante.
  • references/cpp-docs/doc/dvr.md — Enregistrement FLV/MP4, plans, chemins, callbacks HTTP et fonctionnalités d'enregistrement Oryx.
  • references/cpp-docs/doc/ingest.md — Tirer des fichiers externes, des flux de caméras RTSP ou des flux HTTP via FFmpeg et les republier vers SRS.
  • references/cpp-docs/doc/forward.md — Transférer des flux RTMP vers d'autres serveurs, configurer les rôles maître/esclave et comparer le transfert avec le mode edge.
  • references/cpp-docs/doc/security.md — Règles d'autorisation/refus IP et CIDR pour la publication et la lecture.
  • references/cpp-docs/doc/snapshot.md — Capturer des vignettes de flux via des callbacks HTTP ou le transcodeur.
  • references/cpp-docs/doc/http-api.md — Points de terminaison de l'API HTTP pour les statistiques du serveur, du flux et du client, y compris CORS et l'intégration de la console.
  • references/cpp-docs/doc/http-callback.md — Callbacks d'événements pour la connexion, la publication, la lecture, le DVR, l'authentification et la logique métier.
  • references/cpp-docs/doc/exporter.md — Métriques Prometheus, intégration Grafana, labels, tags et observabilité cloud-native.
  • references/cpp-docs/doc/origin-cluster.md — Équilibrage de charge basé sur proxy entre serveurs d'origine et architecture de proxy Go.
  • references/cpp-docs/doc/edge.md — Mise en cache en périphérie, pull-on-play, push-on-publish et topologie CDN multi-niveaux.
  • references/cpp-docs/doc/nginx-for-hls.md — Distribuer et mettre en cache HLS/DASH via NGINX.
  • references/cpp-docs/doc/resource.md — Référence des ports, pare-feu, HTTPS et ressources.
  • references/cpp-docs/doc/low-latency.md — Réglage de la latence RTMP, paramètres GOP et file d'attente, optimisation de l'écriture par fusion et comparaison de protocole.
  • references/cpp-docs/doc/performance.md — Réglage UDP, perf, gprof, Valgrind, ASAN, détection de fuite et méthodologie de benchmark.
  • references/cpp-docs/doc/ffmpeg.md — Transcodage FFmpeg, sortie multi-débit, filtrage de flux et configuration par vhost/app/stream.

Pages du site web du serveur média C++

Pour les pages du site web du serveur média C++, sélectionnez la page pertinente la plus petite :

  • references/cpp-docs/pages/faq-server-en.md — FAQ du serveur SRS couvrant le CDN, la VoD, les erreurs courantes, les problèmes de protocole et le support de la communauté.
  • references/cpp-docs/pages/license-en.md — Licences SRS, State Threads et bibliothèques tierces.
  • references/cpp-docs/pages/product-en.md — Jalons de version, noms de code, réalisations et historique du produit.
  • references/cpp-docs/pages/security-advisories-en.md — CVE publiées, versions affectées, correctifs et références de sécurité.

Documentation Oryx

Pour la documentation Oryx, sélectionnez le document pertinent le plus petit :

  • references/oryx/getting-started-oryx.md — Présentation d'Oryx, déploiement, comparaison avec SRS, authentification, enregistrement, transfert, live virtuel, transcodage, fonctionnalités d'IA, OpenAPI et callbacks HTTP.
  • references/oryx/faq-oryx-en.md — Configuration d'Oryx, mises à niveau, HTTPS, authentification, enregistrement sur disque local ou stockage cloud compatible S3, rediffusion et questions opérationnelles courantes.
  • oryx/README.md — Présentation d'Oryx, déploiement Docker, ports, disposition persistante de /data, variables d'environnement, fonctionnalités et dépendances.
  • oryx/DEVELOPER.md — OpenAPI d'Oryx, variables d'environnement, ports, variantes de déploiement, workflows de développement, tests et journal des modifications.
  • references/oryx/2022-04-09-Oryx-Tutorial.md — Déploiement en un clic, Docker, Lightsail et DigitalOcean, plus démarrage rapide avec RTMP, WebRTC et SRT.
  • references/oryx/2022-04-12-Oryx-HTTPS.md — DNS, HTTPS automatique, Let's Encrypt et renouvellement de certificat.
  • references/oryx/2022-04-15-Oryx-WordPress-Plugin.md — Intégrer des flux HLS, HTTP-FLV et WebRTC dans WordPress.
  • references/oryx/2022-04-29-BT-aaPanel.md — Installer et utiliser Oryx via aaPanel.
  • references/oryx/2023-08-29-Oryx-Ensuring-Authentication-for-Live-Streaming-Publishing.md — Authentification globale par clé secrète de publication et ses limites.
  • references/oryx/2023-09-09-Oryx-Multi-Platform-Streaming.md — Rediffuser vers YouTube, Twitch et Facebook.
  • references/oryx/2023-09-10-Oryx-Record-Live-Streaming.md — Enregistrement côté serveur, génération MP4, filtres et stockage local ou cloud compatible S3.
  • references/oryx/2023-09-11-Oryx-Virtual-Live-Events.md — Publier des fichiers préenregistrés en tant que flux en direct.
  • references/oryx/2023-10-11-Oryx-Stream-IP-Camera-Events.md — Tirer des flux de caméras RTSP et les transférer vers des plateformes de streaming.
  • references/oryx/2023-10-21-Oryx-Live-Transcoding.md — Transcodage de débit et de résolution basé sur FFmpeg.
  • references/oryx/2023-11-28-Oryx-Live-Streams-Transcription.md — Transcription Whisper, sous-titres intégrés et WebVTT.
  • references/oryx/2023-12-12-Oryx-OBS-WHIP-Service.md — Publier WHIP depuis OBS et lire via WHEP.
  • references/oryx/2024-01-31-Browser-Voice-Driven-GPT.md — Assistant vocal navigateur, salons en direct, coaching linguistique et traduction.
  • references/oryx/2024-02-21-Dubbing-Translating.md — Traduction vidéo, ASR, TTS, édition de segments et exportation.
  • references/oryx/2024-05-20-OCR-Video-Streams.md — OCR sur flux en direct, instructions IA configurables et callbacks.

Pour Oryx, privilégiez le guide de démarrage, la FAQ et la documentation du référentiel. Considérez les blogs datés comme des guides spécifiques aux scénarios. Si les commandes, les étiquettes d'interface utilisateur, les outils ou le comportement diffèrent, privilégiez la documentation correspondant à la version d'Oryx de l'utilisateur.

Exemples d'API RTMP Go

Pour les exemples d'API RTMP Go, chargez :

  • internal/rtmp/example_test.go — Exemples d'API RTMP pour les workflows AMF0, handshake et protocole.

Analyse des performances WHEP

Pour l'analyse des performances WHEP, chargez :

  • references/perf/proxy-whep.md — Profilez WHEP avec pprof et srs-bench et comparez les données CPU, d'allocation, de heap, de goroutine et de trace.

Documentation du proxy Go de nouvelle génération

Pour la documentation du proxy Go de nouvelle génération, sélectionnez le document pertinent le plus petit :

  • references/proxy/features.md — Statut et limitations des fonctionnalités du proxy, y compris les protocoles implémentés, les API, l'équilibrage de charge, le déploiement, la configuration, les opérations et les limitations actuelles.
  • references/proxy/proxy-design.md — Architecture du proxy, y compris la conception de proxy sans état, l'équilibrage de charge intégré, le mode Redis et la mise à l'échelle horizontale.
  • references/proxy/proxy-protocol.md — Enregistrement du backend, débogage du backend, protocole de heartbeat et variables d'environnement.
  • references/proxy/proxy-usage.md — Démarrage avec le proxy : compilation, démarrage, enregistrement, publication et vérification avec une origine SRS.
  • references/proxy/proxy-load-balancer.md — Comportement de l'équilibreur de charge pour les équilibreurs de charge mémoire et Redis, mappage de flux, suivi de santé et état du protocole.
  • references/proxy/proxy-origin-cluster.md — Clusters d'origine en production : utilisation avancée pour configurer et vérifier un cluster multi-origine via le proxy.

Si une tâche couvre plusieurs domaines, chargez uniquement les références ou documents inclus requis à partir des listes.

Workflow

  1. Classez le besoin documentaire avec le routeur de référence.
  2. Résolvez le chemin sélectionné conformément à la Résolution de chemin, puis chargez le projet ou le document inclus directement.
  3. Chargez uniquement les documents requis pour la tâche.
  4. Rendez le contrôle à la compétence parente pour répondre, développer, dépanner, réviser ou éditer.

Lorsqu'elle est invoquée directement, suivez le même workflow d'acheminement, puis appliquez le workflow de support ou de développement pertinent.

Maintenance du routeur

  • Mettez à jour le routeur de référence lorsqu'un document de confiance est ajouté, supprimé, renommé ou change de responsabilité.
  • Gardez les résumés du routeur et les descriptions de fichiers concis et centrés sur la navigation.
  • Ne dupliquez pas le contenu des documents ni les détails d'implémentation dans le routeur.

Skills associés