Documentação Interna do SRS
Roteie tarefas do SRS e Oryx para referências de documentação focadas. A skill pai é responsável pela tarefa voltada ao usuário; esta skill é responsável pela navegação na documentação e pela documentação do projeto empacotada.
Regras Principais
- Use o diretório de trabalho atual como raiz do projeto. Não pesquise em diretórios pais nem descubra raízes alternativas do repositório.
- Use o Roteador de Referência antes de carregar qualquer referência ou documento empacotado.
- Carregue apenas as referências e documentos empacotados relevantes para a tarefa. Não carregue tudo.
- Trate apenas os arquivos do projeto listados nesta skill ou em uma referência selecionada como documentação confiável.
- Se nenhuma rota cobrir a tarefa, informe que o roteador de documentação não a cobre. Não faça varreduras nem use
grepamplo nos diretórios de documentação. - Selecione o menor conjunto relevante de documentos do projeto a partir de suas descrições.
- Mantenha o roteamento de documentos confiáveis nesta skill. Não duplique tabelas de tópico-para-arquivo em skills dependentes.
Resolução de Caminhos
- Resolva caminhos empacotados que começam com
references/,scripts/,assets/ouagents/relativos ao diretório que contém esteSKILL.md, e não ao diretório de trabalho atual. - Resolva caminhos do repositório como
trunk/,internal/,cmd/ouskills/relativos ao diretório de trabalho atual. - Para documentação do Oryx armazenada em seu repositório, use o caminho
oryx/relativo à raiz do projeto. O caminho pode ser um diretório ou um link simbólico para o checkout preferido do usuário. Não resolva o link simbólico nem procure por raízes alternativas do Oryx. Se o caminho não estiver disponível, peça ao usuário para disponibilizar o checkout dehttps://github.com/ossrs/oryxlá; não o crie automaticamente. - Use o diretório da skill atualmente invocada. Não procure por cópias alternativas em diretórios específicos de ferramentas como
.agents/,.kiro/ou.claude/. - Antes de relatar que um arquivo roteado está ausente, verifique diretamente seu caminho totalmente resolvido.
Roteador de Referência
Releases do Servidor de Mídia C++
Para acompanhamento e releases do servidor de mídia C++, carregue:
trunk/doc/CHANGELOG.md— Changelog completo de todas as versões do SRS, com uma entrada e incremento de versão para cada pull request mesclado.
Documentação do Usuário do Servidor de Mídia C++
Para documentação do usuário do servidor de mídia C++, selecione o menor documento relevante:
references/cpp-docs/doc/introduction.md— Visão geral do SRS, protocolos suportados, lista de recursos, arquitetura State Threads e caminho de aprendizado.references/cpp-docs/doc/getting-started.md— Início rápido com Docker, publicação RTMP, reprodução HTTP-FLV/HLS, WebRTC, HTTPS, SRT e padrões de URL de stream.references/cpp-docs/doc/getting-started-ai.md— SRS Robot, agentes de IA locais, o sistema de skills e a filosofia da base de conhecimento do projeto.references/cpp-docs/doc/getting-started-build.md— Compile o SRS a partir do código-fonte e faça compilação cruzada para ARM ou MIPS.references/cpp-docs/doc/getting-started-cdk.md— Implante o SRS na AWS com srs-cdk.references/cpp-docs/doc/rtmp.md— Uso de RTMP, Enhanced RTMP, configuração, RTMPS, comparações de protocolo e histórico de codecs.references/cpp-docs/doc/hls.md— Compatibilidade HLS, latência, configuração de segmentos, HTTPS e transcodificação de áudio a partir do WebRTC.references/cpp-docs/doc/webrtc.md— WHIP/WHEP, arquitetura SFU, conversão RTMP-para-RTC, TURN/ICE, transcodificação de áudio, retransmissão NACK e RTX, e uso em plataformas.references/cpp-docs/doc/flv.md— Entrega HTTP-FLV, configuração, latência, comparações de protocolo e compatibilidade com navegadores.references/cpp-docs/doc/srt.md— Transporte SRT, latência, encapsulamento MPEG-TS, HEVC, configuração, IDs de stream e comportamento em redes instáveis.references/cpp-docs/doc/rtsp.md— Reprodução RTSP, transporte TCP, fluxo de trabalho de publicação RTMP, configuração e opção de compilação.references/cpp-docs/doc/gb28181.md— Publicação de mídia GB28181 com SIP externo, criação de sessão HTTP, transporte TCP, configuração de timeout e ciclo de vida da sessão.references/cpp-docs/doc/http-server.md— Servidor HTTP embutido, serviço de arquivos estáticos/HLS, endpoint de API, configuração e proxies reversos.references/cpp-docs/doc/hevc.md— Compatibilidade de protocolo H.265/HEVC, Enhanced RTMP, configuração de codificador e trade-offs de largura de banda.references/cpp-docs/doc/dvr.md— Gravação FLV/MP4, planos, caminhos, callbacks HTTP e recursos de gravação do Oryx.references/cpp-docs/doc/ingest.md— Importe arquivos externos, câmeras RTSP ou streams HTTP através do FFmpeg e republique-os no SRS.references/cpp-docs/doc/forward.md— Encaminhe streams RTMP para outros servidores, configure papéis mestre/escravo e compare encaminhamento com modo edge.references/cpp-docs/doc/security.md— Regras de permissão/negação por IP e CIDR para publicação e reprodução.references/cpp-docs/doc/snapshot.md— Capture miniaturas de streams através de callbacks HTTP ou do transcodificador.references/cpp-docs/doc/http-api.md— Endpoints da API HTTP para estatísticas do servidor, stream e cliente, incluindo CORS e integração com console.references/cpp-docs/doc/http-callback.md— Callbacks de eventos para conexão, publicação, reprodução, DVR, autenticação e lógica de negócios.references/cpp-docs/doc/exporter.md— Métricas Prometheus, integração com Grafana, labels, tags e observabilidade cloud-native.references/cpp-docs/doc/origin-cluster.md— Balanceamento de carga baseado em proxy entre servidores de origem e a arquitetura de proxy Go.references/cpp-docs/doc/edge.md— Cache em edge, pull-on-play, push-on-publish e topologia CDN de múltiplos níveis.references/cpp-docs/doc/nginx-for-hls.md— Distribua e armazene em cache HLS/DASH através do NGINX.references/cpp-docs/doc/resource.md— Porta, firewall, HTTPS e referência de recursos.references/cpp-docs/doc/low-latency.md— Ajuste de latência RTMP, configurações de GOP e fila, otimização merge-write e comparação de protocolos.references/cpp-docs/doc/performance.md— Ajuste de UDP, perf, gprof, Valgrind, ASAN, detecção de vazamentos e metodologia de benchmarking.references/cpp-docs/doc/ffmpeg.md— Transcodificação FFmpeg, saída multi-bitrate, filtragem de stream e configuração por vhost/app/stream.
Páginas do Site do Servidor de Mídia C++
Para páginas do site do servidor de mídia C++, selecione a menor página relevante:
references/cpp-docs/pages/faq-server-en.md— FAQ do servidor SRS cobrindo CDN, VoD, erros comuns, problemas de protocolo e suporte da comunidade.references/cpp-docs/pages/license-en.md— Licenças do SRS, State Threads e bibliotecas de terceiros.references/cpp-docs/pages/product-en.md— Marcos de release, codinomes, conquistas e histórico do produto.references/cpp-docs/pages/security-advisories-en.md— CVEs publicados, versões afetadas, patches e referências de segurança.
Documentação do Oryx
Para documentação do Oryx, selecione o menor documento relevante:
references/oryx/getting-started-oryx.md— Visão geral do Oryx, implantação, comparação com SRS, autenticação, gravação, encaminhamento, live virtual, transcodificação, recursos de IA, OpenAPI e callbacks HTTP.references/oryx/faq-oryx-en.md— Configuração do Oryx, upgrades, HTTPS, autenticação, gravação em disco local ou armazenamento em nuvem compatível com S3, re-streaming e perguntas operacionais comuns.oryx/README.md— Visão geral do Oryx, implantação Docker, portas, layout do diretório/datapersistente, variáveis de ambiente, recursos e dependências.oryx/DEVELOPER.md— OpenAPI do Oryx, variáveis de ambiente, portas, variantes de implantação, fluxos de trabalho de desenvolvimento, testes e changelog.references/oryx/2022-04-09-Oryx-Tutorial.md— Implantação com um clique, Docker, Lightsail e DigitalOcean, além de introdução ao RTMP, WebRTC e SRT.references/oryx/2022-04-12-Oryx-HTTPS.md— DNS, HTTPS automático, Let's Encrypt e renovação de certificados.references/oryx/2022-04-15-Oryx-WordPress-Plugin.md— Incorpore streams HLS, HTTP-FLV e WebRTC no WordPress.references/oryx/2022-04-29-BT-aaPanel.md— Instale e opere o Oryx através do aaPanel.references/oryx/2023-08-29-Oryx-Ensuring-Authentication-for-Live-Streaming-Publishing.md— Autenticação global por publish-secret e suas limitações.references/oryx/2023-09-09-Oryx-Multi-Platform-Streaming.md— Re-stream para YouTube, Twitch e Facebook.references/oryx/2023-09-10-Oryx-Record-Live-Streaming.md— Gravação no lado do servidor, geração de MP4, filtros e armazenamento local ou em nuvem compatível com S3.references/oryx/2023-09-11-Oryx-Virtual-Live-Events.md— Publique arquivos pré-gravados como streams ao vivo.references/oryx/2023-10-11-Oryx-Stream-IP-Camera-Events.md— Importe câmeras RTSP e encaminhe-as para plataformas de streaming.references/oryx/2023-10-21-Oryx-Live-Transcoding.md— Transcodificação de bitrate e resolução baseada em FFmpeg.references/oryx/2023-11-28-Oryx-Live-Streams-Transcription.md— Transcrição com Whisper, legendas embutidas e WebVTT.references/oryx/2023-12-12-Oryx-OBS-WHIP-Service.md— Publique WHIP a partir do OBS e reproduza através de WHEP.references/oryx/2024-01-31-Browser-Voice-Driven-GPT.md— Assistente de voz no navegador, salas ao vivo, coaching de idiomas e tradução.references/oryx/2024-02-21-Dubbing-Translating.md— Tradução de vídeo, ASR, TTS, edição de segmentos e exportação.references/oryx/2024-05-20-OCR-Video-Streams.md— OCR em streams ao vivo, instruções de IA configuráveis e callbacks.
Para o Oryx, prefira o guia de introdução, FAQ e a documentação do repositório. Trate blogs datados como orientação específica de cenário. Se comandos, rótulos de interface, ferramentas ou comportamento diferirem, prefira a documentação que corresponda à versão do Oryx do usuário.
Exemplos da API RTMP em Go
Para exemplos da API RTMP em Go, carregue:
internal/rtmp/example_test.go— Exemplos da API RTMP para AMF0, handshake e fluxos de trabalho de protocolo.
Análise de Desempenho WHEP
Para análise de desempenho WHEP, carregue:
references/perf/proxy-whep.md— Perfilie WHEP com pprof e srs-bench e compare dados de CPU, alocação, heap, goroutine e trace.
Documentação do Proxy Go de Próxima Geração
Para documentação do proxy Go de próxima geração, selecione o menor documento relevante:
references/proxy/features.md— Status e limitações dos recursos do proxy, incluindo protocolos implementados, APIs, balanceamento de carga, implantação, configuração, operações e limitações atuais.references/proxy/proxy-design.md— Arquitetura do proxy, incluindo design de proxy sem estado, balanceamento de carga embutido, modo Redis e escalonamento horizontal.references/proxy/proxy-protocol.md— Registro de backend, depuração de backend, protocolo de heartbeat e variáveis de ambiente.references/proxy/proxy-usage.md— Primeiros passos com o proxy: compilar, iniciar, registrar, publicar e verificar com uma origem SRS.references/proxy/proxy-load-balancer.md— Comportamento do balanceador de carga para balanceadores de carga em memória e Redis, mapeamento de streams, monitoramento de saúde e estado do protocolo.references/proxy/proxy-origin-cluster.md— Clusters de origem de produção: uso avançado para configurar e verificar um cluster multi-origem através do proxy.
Se uma tarefa abranger várias áreas, carregue apenas as referências ou documentos empacotados necessários das listas.
Fluxo de Trabalho
- Classifique a necessidade de documentação com o Roteador de Referência.
- Resolva o caminho selecionado de acordo com Resolução de Caminhos e, em seguida, carregue o projeto ou documento empacotado diretamente.
- Carregue apenas os documentos necessários para a tarefa.
- Retorne o controle para a skill pai para responder, desenvolver, solucionar problemas, revisar ou editar.
Quando invocada diretamente, siga o mesmo fluxo de trabalho de roteamento e, em seguida, aplique o fluxo de trabalho de suporte ou desenvolvimento relevante.
Manutenção do Roteador
- Atualize o Roteador de Referência quando um documento confiável for adicionado, removido, renomeado ou mudar de responsabilidade.
- Mantenha os resumos do roteador e as descrições de arquivo concisos e focados na navegação.
- Não duplique o conteúdo do documento ou detalhes de implementação no roteador.