README
¶
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.
Getting Started
Running the json-rpc server
If you have a local golang environment already setup, simply run
go build ./cmd/server/json-rpc/main.go && ./main -c config.toml
If you prefer a containerized environment, you can use the included Docker image
docker run -p 50051:50051 -p 5000-5020:5000-5020/udp pionwebrtc/ion-sfu:v1.0.6-jsonrpc
Running the grpc server
If you have a local golang environment already setup, simply run
go build ./cmd/server/grpc/main.go && ./main -c config.toml
If you prefer a containerized environment, you can use the included Docker image
docker run -p 50051:50051 -p 5000-5020:5000-5020/udp pionwebrtc/ion-sfu:v1.0.6-grpc
Interacting with the server
To get an idea of how to interact with the ion-sfu instance, check out our examples.
Processing Media
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
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
server/grpc
Package cmd contains an entrypoint for running an ion-sfu instance.
|
Package cmd contains an entrypoint for running an ion-sfu instance. |
|
server/json-rpc
Package cmd contains an entrypoint for running an ion-sfu instance.
|
Package cmd contains an entrypoint for running an ion-sfu instance. |
|
examples
|
|
|
custom-signaling
Package cmd contains an entrypoint for running an ion-sfu instance.
|
Package cmd contains an entrypoint for running an ion-sfu instance. |
|
internal/signal
Package signal contains helpers to exchange the SDP session description between examples.
|
Package signal contains helpers to exchange the SDP session description between examples. |
|
pub-from-browser
Package pub-from-browser contains an example of publishing a stream to an ion-sfu instance from the browser.
|
Package pub-from-browser contains an example of publishing a stream to an ion-sfu instance from the browser. |
|
pub-from-disk
Package pub-from-disk contains an example of publishing a stream to an ion-sfu instance from a file on disk.
|
Package pub-from-disk contains an example of publishing a stream to an ion-sfu instance from a file on disk. |
|
pub-from-disk-using-grpc
Package pub-from-disk-using-grpc contains an example of publishing a stream to an ion-sfu instance from a file on disk.
|
Package pub-from-disk-using-grpc contains an example of publishing a stream to an ion-sfu instance from a file on disk. |
|
sub-to-browser
Package sub-to-browser contains an example of subscribing to a stream from an ion-sfu instance in the browser.
|
Package sub-to-browser contains an example of subscribing to a stream from an ion-sfu instance in the browser. |
|
sub-to-disk-using-grpc
Package sub-to-disk-using-grpc demonstrates how to subscribe a stream from ion-sfu, and save VP8/Opus to disk.
|
Package sub-to-disk-using-grpc demonstrates how to subscribe a stream from ion-sfu, and save VP8/Opus to disk. |