Ion SFU
Go implementation of a WebRTC Selective Forwarding Unit
A selective forwarding unit is a video routing service which allows webrtc sessions to scale more efficiently. This package provides a simple, flexible, high performance Go implementation of a WebRTC SFU. It can be called directly or through a gRPC or json-rpc interface.
Features
- Audio/Video/Datachannel forwarding
- Congestion Control (TWCC, REMB, RR/SR)
- Unified plan semantics
- Pub/Sub Peer Connection (
O(n)
port usage)
Quickstart
Run the Echo Test example
docker-compose -f examples/echotest/docker-compose.yaml up
Open the client
http://localhost:8000/
SFU with json-rpc signaling
The json-rpc signaling service can be used to easily get up and running with the sfu. It can be used with the corresponding javascript signaling module.
Using golang environment
go build ./cmd/signal/json-rpc/main.go && ./main -c config.toml
Using docker
docker run -p 7000:7000 -p 5000-5200:5000-5200/udp pionwebrtc/ion-sfu:latest-jsonrpc
SFU with gRPC signaling
For service-to-service communication, you can use the grpc interface. A common pattern is to call the grpc endpoints from a custom signaling service.
Using golang environment
go build ./cmd/signal/grpc/main.go && ./main -c config.toml
Using docker
docker run -p 50051:50051 -p 5000-5200:5000-5200/udp pionwebrtc/ion-sfu:latest-grpc
Examples
To see some other ways of interacting with the ion-sfu instance, check out our examples.
Media Processing
ion-sfu
supports real-time processing on media streamed through the sfu using ion-avp
.
For an example of recording a MediaStream to webm, checkout the save-to-webm example.
License
MIT License - see LICENSE for full text