v3_EN_Home

Remark: SRS3 will be released soon, now it's beta and ready for production environment.

SRS Overview

SRS is industrial-strength live streaming cluster, for the best conceptual integrity and the simplest implementation. SRS provides variety of inputs, for example, Push RTMP to SRS, Push RTSP/UDP/FLV to SRS, Pull Stream to SRS. SRS can transform the RTMP to other protocols or deliveries, for example, RTMP Transcode, Snapshot, Forward to Other Servers, Transmux to HTTP-FLV, Transmux to HLS, Transmux to HDS, Transmux to DASH, DVR to FLV/MP4. SRS canbe used in CDN for large stream clusters, for example, RTMP Cluster、 OriginCluster, VHOST, Reload, HTTP-FLV Cluster. Futhermore, SRS provides apis, for example, HTTP Callback, Security, HTTP API, RTMP Bandwidth Test. There're lots of Applications in both CDN and origin servers.

Note: Please read https://www.processon.com/view/link/5e3f5581e4b0a3daae80ecef for details.

Downloading

Get SRS from the downloads page of the project website. If you'd like to build SRS from scratch, visit Build SRS.

SRS runs on Linuxs, for instace, Centos and Ubuntu, and x86, x86-64, ARM and MIPS is ok. For other OS, please use srs-docker. SRS build on the coroutine library state-threads, which simplify the complex protocol imlementations.

SRS is easy to run on a machine, or multiple machines, to run the cluster. SRS is single process, not multiple processes model; you can use go-oryx for multiple processes.

Where to Go from Here

User Guides:

Quick Start: A quick introduction of SRS, please start here.
Milestones: The milestone and product design。
Why SRS: Why you should choose SRS? What's the roadmap?
GIT Mirrors: The GIT mirrors of SRS to get SRS faster.
Main Features: The features list of SRS. Some features is introduced from specified version; while some features are experiment.
Releases: The released versions of SRS.
Docs: The detail tech docs of SRS.

Deployment Guides:

We illustrate and explain how to deploy SRS for typical use scenarios.

Delivery RTMP: How to delivery RTMP using SRS.
Delivery HLS: How to delivery RTMP and HLS using SRS.
Delivery HTTP FLV: How to remux RTMP to HTTP FLV stream.
Delivery HDS: How to delivery HDS using SRS.
Delivery DASH: How to delivery DASH using SRS.
Transcode: How to transcode the RTMP stream.
Snapshot: How to snapshot thumbnail of RTMP stream.
Forward: How to forward RTMP to other servers.
Low latency: How to deploy the low latency SRS.
Ingest: How to ingest other streams to SRS.
HTTP Server: How to deploy SRS as HTTP server.
SRS DEMO: How to deploy the demo of SRS.
Projects: Who are using SRS.
Setup: How to setup SRS.

Cluster Guides:

The examples here are aimed for deploying and maintaining origin/edge cluster.

Origin Cluster: Origin Cluster for huge streams or fault tolerance.
Edge Cluster: RTMP: Edge Cluster for RTMP streaming.
Edge Cluster: FLV: Edge Cluster for HTTP-FLV streaming.
VHOST: Support multiple customers in the same cluster by vhost.
Reload: Apply changed config by reload.
Tracable Log: Debug and trace user in cluster log.
Log Rotate: How to rotate the log.

Integration Guides:

HTTP Callback: Use HTTP callback to hook the events of SRS.
HTTP API: Get system data from HTTP API of SRS.
RTMP Bandwidth: Use bandwidth api to test the available bandwidth for SRS.
Special Control: Some special control config for expert.

Migrate From NGINX-RTMP:

If you are a user of nginx-rtmp, there is a tendency to use SRS as nginx-rtmp that you already know. Be aware of this bias and try to avoid it.

NG EXEC: Fork/Exec external program when got some event.

Benchmarks:

Compare: The comparation of SRS to other servers.
Performance: The performance benchmark.

Join Us:

How to file a issue to SRS?
File Issue: File an issue.
Contact: Contact us by DingTalk or Wechat.

Develop Guide

SRS Code Analysis, code and arch.
SRS Librtmp: Exported librtmp library by SRS, can be used to push or pull stream over RTMP, and it's C++ code to compile for Android or iOS.
Third-party Client SDK: For mobile platform, such as Android and iOS, there are some client SDKs to publish or play live stream.