Communitygithub.com

ossrs/srs

将 SRS 和 Oryx 任务路由到最小且最相关的可信项目文档集合,并维护此技能所绑定的项目文档。

srs 是什么?

该技能旨在为 AI 代理(如 Claude Code、Cursor 等)提供一个高效、聚焦的文档导航系统,专门用于处理与 SRS(Simple-Rtmp-Server)媒体服务器以及 Oryx 项目相关的任何任务。它通过一个预定义的“参考路由器”,将用户关于部署、流媒体、认证、录制、AI等功能的问题,精准地路由到最相关、最小的可信文档集合,避免不必要的全局搜索或加载大量无关文件。技能支持多种平台,包括 C++ 媒体服务器的用户文档、Oryx 项目文档、网站页面、变更日志、Go RTMP API 示例以及下一代 Go 代理文档。其工作流程清晰:首先对任务进行分类,然后根据路径解析规则加载文档,最后将控制权交还给父技能。该技能严格约束自身行为,只使用当前工作目录和技能目录,不自动搜索其他仓库根目录,确保文档来源的可信度和操作的确定性。

兼容平台✓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 任务路由到重点文档引用。父技能负责面向用户的任务;此技能负责文档导航和绑定的项目文档。

核心规则

  • 将当前工作目录作为项目根目录。不要搜索父目录或发现其他仓库根目录。
  • 在加载任何引用或绑定文档之前,先使用参考路由器。
  • 只加载与任务相关的引用和绑定文档。不要加载所有内容。
  • 仅将本技能或所选引用中列出的项目文件视为可信文档。
  • 如果没有路由覆盖该任务,则报告文档路由器未覆盖。不要扫描或广泛搜索文档目录。
  • 根据描述选择最小且最相关的项目文档集合。
  • 将可信文档路由保留在此技能中。不要在依赖技能中重复主题到文件的映射表。

路径解析

  • 将以 references/、scripts/、assets/ 或 agents/ 开头的绑定路径解析到包含此 SKILL.md 的目录,而不是当前工作目录。
  • 将以 trunk/、internal/、cmd/ 或 skills/ 开头的仓库路径解析到当前工作目录。
  • 对于存储在其仓库中的 Oryx 文档,使用项目根目录相对的 oryx/ 路径。该路径可以是目录,也可以是用户首选检出目录的符号链接。不要解析符号链接或搜索其他 Oryx 根目录。如果路径不可用,请用户将 https://github.com/ossrs/oryx 检出到此处;不要自动创建。
  • 使用当前调用的技能目录。不要搜索工具特定目录(如 .agents/、.kiro/ 或 .claude/)下的其他副本。
  • 在报告路由文件丢失之前,直接检查其完全解析后的路径。

参考路由器

C++ 媒体服务器版本

对于 C++ 媒体服务器跟踪和版本发布,加载:

  • trunk/doc/CHANGELOG.md — 所有 SRS 版本的完整变更日志,每个合并的拉取请求对应一个条目和版本号递增。

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 用法、Enhanced 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 协议兼容性、Enhanced 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、点播、常见错误、协议问题和社区支持。
  • 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,优先使用入门指南、FAQ 和仓库文档。将带日期的博客视为特定场景的指南。如果命令、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 源服务器验证。
  • references/proxy/proxy-load-balancer.md — 内存和 Redis 负载均衡器的行为、流映射、健康跟踪和协议状态。
  • references/proxy/proxy-origin-cluster.md — 生产环境源集群:通过代理配置和验证多源集群的高级用法。

如果任务跨越多个领域,则仅从列表中加载所需的引用或绑定文档。

工作流程

  1. 使用参考路由器对文档需求进行分类。
  2. 根据路径解析解析所选路径,然后直接加载项目或绑定文档。
  3. 仅加载任务所需的文档。
  4. 将控制权返回给父技能,以进行回答、开发、故障排除、审查或编辑。

当直接调用时,遵循相同的路由工作流程,然后应用相关的支持或开发工作流程。

维护路由器

  • 当添加、删除、重命名或更改职责的可信文档时,更新参考路由器。
  • 保持路由器摘要和文件描述简洁,并专注于导航。
  • 不要在路由器中重复文档内容或实现细节。

相关技能