Communitygithub.com

ossrs/srs

將 SRS 與 Oryx 任務導向最小且相關的權威專案文件,並維護此技能所附帶的專案文件。

srs 是什麼?

此技能作為 SRS(Simple Realtime Server)與 Oryx 專案的智能文件路由中心。其主要功能是將開發者或 AI 代理的查詢精確地引導至最少且最相關的文件集,避免資訊過載。技能涵蓋的範圍極廣,包括:C++ 媒體伺服器文件(如入門指南、RTMP、HLS、WebRTC、SRT 等協議)、Oryx 部署與操作指南(如 HTTPS、錄影、轉碼、AI 功能)、Changelog、可執行的 API 範例(如 RTMP Go API),以及次世代的 Go 代理伺服器與效能分析文件。它支援 Claude Code、Cursor、Codex 等主流 AI 代理工具。運作核心是嚴格的「參考路由器」機制,它根據任務類型(例如「用戶想了解 Oryx 錄影」、「需要排查 SRS WebRTC 延遲」),從預先定義的文件清單中選取最小的文件子集,並透過精確的「路徑解析」規則(區分技能目錄下的參考文件與 Repository 下的專案文件)來載入內容。這確保了使用時的高效性與資訊的權威性,適合用於日常開發、除錯、文件審閱與新功能開發。

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

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

SRS 內部文件

將 SRS 和 Oryx 任務導向指定範圍內的文件參考。上層技能負責面對用戶的任務;此技能則負責文件導航以及隨附的專案文件。

核心規則

  • 將當前工作目錄作為專案根目錄。請勿搜尋上層目錄或尋找其他 Repository 根目錄。
  • 在載入任何參考或隨附文件之前,請先使用「參考路由器」。
  • 僅載入與任務相關的參考文件和隨附文件。請勿載入全部文件。
  • 僅將此技能或所選參考文件中列出的專案文件視為權威文件。
  • 如果沒有任何路由涵蓋該任務,請回報此文件路由器無法處理。請勿掃描或廣泛搜尋文件目錄。
  • 根據文件描述,選擇最小且相關的專案文件集。
  • 將權威文件路由保留在此技能中。請勿在依賴此技能的其他技能中重複主題對應檔案的表。

路徑解析

  • 對於以 references/、scripts/、assets/ 或 agents/ 開頭的隨附路徑,請相對於包含此 SKILL.md 的目錄進行解析,而非當前工作目錄。
  • 對於諸如 trunk/、internal/、cmd/ 或 skills/ 這類的 Repository 路徑,請相對於當前工作目錄進行解析。
  • 對於存放在其 Repository 中的 Oryx 文件,請使用相對於專案根目錄的 oryx/ 路徑。該路徑可能是目錄或用戶偏好的檢出(checkout)的符號連結。請勿解析符號連結或搜尋其他 Oryx 根目錄。如果該路徑不可用,請要求用戶將 https://github.com/ossrs/oryx 的檢出內容放在那裡;請勿自動建立。
  • 使用當前被調用的技能目錄。請勿在工具特定的目錄(例如 .agents/、.kiro/ 或 .claude/)下搜尋其他副本。
  • 在回報路由檔案缺失之前,請直接檢查其完整解析後的路徑。

參考路由器

C++ 媒體伺服器版本

針對 C++ 媒體伺服器的追蹤與版本發布,請載入:

  • trunk/doc/CHANGELOG.md — 所有 SRS 版本的完整變更日誌,每個合併的 Pull Request 都有一個對應的條目和版本號變更。

C++ 媒體伺服器用戶文件

針對 C++ 媒體伺服器用戶文件,請選擇最小、最相關的文件:

  • references/cpp-docs/doc/introduction.md — SRS 概覽、支援的協議、功能列表、State Threads 架構以及學習路徑。
  • references/cpp-docs/doc/getting-started.md — Docker 快速指南、RTMP 發布、HTTP-FLV/HLS 播放、WebRTC、HTTPS、SRT 以及串流 URL 模式。
  • references/cpp-docs/doc/getting-started-ai.md — SRS Robot、本地 AI 代理、技能系統以及專案知識庫理念。
  • references/cpp-docs/doc/getting-started-build.md — 從原始碼構建 SRS 以及為 ARM 或 MIPS 進行交叉構建。
  • references/cpp-docs/doc/getting-started-cdk.md — 使用 srs-cdk 在 AWS 上部署 SRS。
  • references/cpp-docs/doc/rtmp.md — RTMP 使用、增強型 RTMP、配置、RTMPS、協議比較以及編解碼器歷史。
  • references/cpp-docs/doc/hls.md — HLS 相容性、延遲、切片配置、HTTPS 以及來自 WebRTC 的音訊轉碼。
  • references/cpp-docs/doc/webrtc.md — WHIP/WHEP、SFU 架構、RTMP 到 RTC 轉換、TURN/ICE、音訊轉碼、NACK 與 RTX 重傳以及平台使用。
  • references/cpp-docs/doc/flv.md — HTTP-FLV 傳輸、配置、延遲、協議比較以及瀏覽器相容性。
  • references/cpp-docs/doc/srt.md — SRT 傳輸、延遲、MPEG-TS 封裝、HEVC、配置、串流 ID 以及弱網路行為。
  • references/cpp-docs/doc/rtsp.md — RTSP 播放、TCP 傳輸、RTMP 發布工作流程、配置以及構建選項。
  • references/cpp-docs/doc/gb28181.md — 外部 SIP GB28181 媒體發布、HTTP 會話建立、TCP 傳輸、超時配置以及會話生命週期。
  • references/cpp-docs/doc/http-server.md — 內嵌 HTTP 伺服器、HLS/靜態檔案服務、API 端點、配置以及反向代理。
  • references/cpp-docs/doc/hevc.md — H.265/HEVC 協議相容性、增強型 RTMP、編碼器設定以及頻寬權衡。
  • references/cpp-docs/doc/dvr.md — FLV/MP4 錄製、計劃、路徑、HTTP 回調以及 Oryx 錄製功能。
  • references/cpp-docs/doc/ingest.md — 透過 FFmpeg 拉取外部檔案、RTSP 攝影機或 HTTP 串流,並將其重新發布到 SRS。
  • references/cpp-docs/doc/forward.md — 將 RTMP 串流轉發到其他伺服器、配置主/從角色,以及比較轉發與邊緣模式。
  • references/cpp-docs/doc/security.md — 針對發布和播放的 IP 和 CIDR 允許/拒絕規則。
  • references/cpp-docs/doc/snapshot.md — 透過 HTTP 回調或轉碼器擷取串流縮圖。
  • references/cpp-docs/doc/http-api.md — 針對伺服器、串流和用戶端統計資料的 HTTP API 端點,包含 CORS 和控制台整合。
  • references/cpp-docs/doc/http-callback.md — 針對連線、發布、播放、DVR、認證和業務邏輯的事件回調。
  • references/cpp-docs/doc/exporter.md — Prometheus 指標、Grafana 整合、標籤、標記以及雲端原生可觀測性。
  • references/cpp-docs/doc/origin-cluster.md — 基於代理的跨源伺服器負載均衡以及 Go 代理架構。
  • references/cpp-docs/doc/edge.md — 邊緣緩存、按需拉流、推流即發布以及多層級 CDN 拓撲。
  • references/cpp-docs/doc/nginx-for-hls.md — 透過 NGINX 分發和緩存 HLS/DASH。
  • references/cpp-docs/doc/resource.md — 連接埠、防火牆、HTTPS 以及資源參考。
  • references/cpp-docs/doc/low-latency.md — RTMP 延遲調校、GOP 與佇列設定、合併寫入優化以及協議比較。
  • references/cpp-docs/doc/performance.md — UDP 調校、perf、gprof、Valgrind、ASAN、洩漏檢測以及基準測試方法。
  • references/cpp-docs/doc/ffmpeg.md — FFmpeg 轉碼、多碼率輸出、串流過濾以及按 vhost/app/stream 進行配置。

C++ 媒體伺服器網站頁面

針對 C++ 媒體伺服器網站頁面,請選擇最小、最相關的頁面:

  • references/cpp-docs/pages/faq-server-en.md — SRS 伺服器常見問題,涵蓋 CDN、VoD、常見錯誤、協議問題和社群支援。
  • references/cpp-docs/pages/license-en.md — SRS、State Threads 以及第三方函式庫的許可證。
  • references/cpp-docs/pages/product-en.md — 版本里程碑、代號、成就和產品歷史。
  • references/cpp-docs/pages/security-advisories-en.md — 已發布的 CVE、受影響的版本、修補程式和安全參考資料。

Oryx 文件

針對 Oryx 文件,請選擇最小、最相關的文件:

  • references/oryx/getting-started-oryx.md — Oryx 概覽、部署、與 SRS 的比較、認證、錄製、轉發、虛擬直播、轉碼、AI 功能、OpenAPI 以及 HTTP 回調。
  • references/oryx/faq-oryx-en.md — Oryx 設定、升級、HTTPS、認證、錄製到本機磁碟或 S3 相容雲端儲存、重新推流以及常見操作問題。
  • oryx/README.md — Oryx 概覽、Docker 部署、連接埠、持久的 /data 目錄佈局、環境變數、功能和依賴關係。
  • oryx/DEVELOPER.md — Oryx OpenAPI、環境變數、連接埠、部署變體、開發工作流程、測試和變更日誌。
  • references/oryx/2022-04-09-Oryx-Tutorial.md — 一鍵部署、Docker、Lightsail 和 DigitalOcean 部署,以及 RTMP、WebRTC 和 SRT 入門。
  • references/oryx/2022-04-12-Oryx-HTTPS.md — DNS、自動 HTTPS、Let's Encrypt 和憑證續期。
  • references/oryx/2022-04-15-Oryx-WordPress-Plugin.md — 在 WordPress 中嵌入 HLS、HTTP-FLV 和 WebRTC 串流。
  • references/oryx/2022-04-29-BT-aaPanel.md — 透過 aaPanel 安裝和操作 Oryx。
  • references/oryx/2023-08-29-Oryx-Ensuring-Authentication-for-Live-Streaming-Publishing.md — 全域發布密鑰認證及其限制。
  • references/oryx/2023-09-09-Oryx-Multi-Platform-Streaming.md — 重新推流到 YouTube、Twitch 和 Facebook。
  • references/oryx/2023-09-10-Oryx-Record-Live-Streaming.md — 伺服器端錄製、MP4 生成、過濾器以及本機或 S3 相容雲端儲存。
  • references/oryx/2023-09-11-Oryx-Virtual-Live-Events.md — 將預錄檔案作為直播串流發布。
  • references/oryx/2023-10-11-Oryx-Stream-IP-Camera-Events.md — 拉取 RTSP 攝影機並將其轉發到串流平台。
  • references/oryx/2023-10-21-Oryx-Live-Transcoding.md — 基於 FFmpeg 的碼率和解析度轉碼。
  • references/oryx/2023-11-28-Oryx-Live-Streams-Transcription.md — Whisper 轉錄、內嵌字幕和 WebVTT。
  • references/oryx/2023-12-12-Oryx-OBS-WHIP-Service.md — 從 OBS 以 WHIP 發布並透過 WHEP 播放。
  • references/oryx/2024-01-31-Browser-Voice-Driven-GPT.md — 瀏覽器語音助手、直播間、語言輔導和翻譯。
  • references/oryx/2024-02-21-Dubbing-Translating.md — 影片翻譯、ASR、TTS、片段編輯和匯出。
  • references/oryx/2024-05-20-OCR-Video-Streams.md — 直播 OCR、可配置的 AI 指令和回調。

對於 Oryx,優先使用入門指南、常見問題和 Repository 文件。將帶有日期的部落格視為特定場景的指導。如果命令、UI 標籤、工具或行為有所不同,則優先使用與用戶 Oryx 版本相符的文件。

RTMP Go API 範例

針對 RTMP Go API 範例,請載入:

  • internal/rtmp/example_test.go — 針對 AMF0、握手和協議工作流程的 RTMP API 範例。

WHEP 效能分析

針對 WHEP 效能分析,請載入:

  • references/perf/proxy-whep.md — 使用 pprof 和 srs-bench 分析 WHEP,並比較 CPU、記憶體分配、堆積、goroutine 和追蹤資料。

次世代 Go 代理文件

針對次世代 Go 代理文件,請選擇最小、最相關的文件:

  • references/proxy/features.md — 代理功能狀態與限制,包括已實現的協議、API、負載均衡、部署、配置、操作以及當前限制。
  • references/proxy/proxy-design.md — 代理架構,包括無狀態代理設計、內建負載均衡、Redis 模式和水準擴展。
  • references/proxy/proxy-protocol.md — 後端註冊、除錯後端、心跳協議和環境變數。
  • references/proxy/proxy-usage.md — 代理入門:構建、啟動、註冊、發布以及與 SRS Origin 進行驗證。
  • references/proxy/proxy-load-balancer.md — 針對記憶體和 Redis 負載均衡器的負載均衡行為、串流映射、健康狀態追蹤和協議狀態。
  • references/proxy/proxy-origin-cluster.md — 生產環境的 Origin 集群:配置和驗證透過代理實現的多 Origin 集群的高階用法。

如果一個任務涉及多個領域,請僅從列表中載入所需的參考文件或隨附文件。

工作流程

  1. 使用「參考路由器」對文件需求進行分類。
  2. 根據路徑解析解析選定的路徑,然後直接載入專案文件或隨附文件。
  3. 僅載入任務所需的文件。
  4. 將控制權交還給上層技能,以進行解答、開發、除錯、審閱或編輯。

當直接調用此技能時,請遵循相同的路由工作流程,然後應用相關的支援或開發工作流程。

維護路由器

  • 當新增、刪除、重新命名或變更權威文件的職責時,請更新「參考路由器」。
  • 保持路由器摘要和文件描述的簡潔,並專注於導航。
  • 請勿在路由器中複製文件內容或實作細節。

相關技能