mirror of
https://github.com/pion/webrtc.git
synced 2025-10-07 16:10:55 +08:00
Rename sfu-minimal -> broadcast
Will have new dedicated SFU example when re-negotation is complete. Keep this broadcast example for users who want fan-out example and not everything needed for multi-track re-negotations. Relates to #207
This commit is contained in:
@@ -11,7 +11,7 @@ For more full featured examples that use 3rd party libraries see our **[example-
|
|||||||
* [Reflect](reflect): The reflect example demonstrates how to have Pion send back to the user exactly what it receives using the same PeerConnection.
|
* [Reflect](reflect): The reflect example demonstrates how to have Pion send back to the user exactly what it receives using the same PeerConnection.
|
||||||
* [Play from disk](play-from-disk): The play-from-disk example demonstrates how to send video to your browser from a file saved to disk.
|
* [Play from disk](play-from-disk): The play-from-disk example demonstrates how to send video to your browser from a file saved to disk.
|
||||||
* [Save to Disk](save-to-disk): The save-to-disk example shows how to record your webcam and save the footage to disk on the server side.
|
* [Save to Disk](save-to-disk): The save-to-disk example shows how to record your webcam and save the footage to disk on the server side.
|
||||||
* [SFU Minimal](sfu-minimal): The SFU example demonstrates how to broadcast a video to multiple peers. A broadcaster uploads the video once and the server forwards it to all other peers.
|
* [Broadcast](broadcast): The broadcast example demonstrates how to broadcast a video to multiple peers. A broadcaster uploads the video once and the server forwards it to all other peers.
|
||||||
|
|
||||||
#### Data Channel API
|
#### Data Channel API
|
||||||
* [Data Channels](data-channels): The data-channels example shows how you can send/recv DataChannel messages from a web browser.
|
* [Data Channels](data-channels): The data-channels example shows how you can send/recv DataChannel messages from a web browser.
|
||||||
|
32
examples/broadcast/README.md
Normal file
32
examples/broadcast/README.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# broadcast
|
||||||
|
broadcast is a Pion WebRTC application that demonstrates how to broadcast a video to many peers, while only requiring the broadcaster to upload once.
|
||||||
|
|
||||||
|
This could serve as the building block to building conferencing software, and other applications where publishers are bandwidth constrained.
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
### Download broadcast
|
||||||
|
```
|
||||||
|
go get github.com/pion/webrtc/examples/broadcast
|
||||||
|
```
|
||||||
|
|
||||||
|
### Open broadcast example page
|
||||||
|
[jsfiddle.net](https://jsfiddle.net/zhpya3n9/) You should see two buttons 'Publish a Broadcast' and 'Join a Broadcast'
|
||||||
|
|
||||||
|
### Run Broadcast
|
||||||
|
#### Linux/macOS
|
||||||
|
Run `broadcast` OR run `main.go` in `github.com/pion/webrtc/examples/broadcast`
|
||||||
|
|
||||||
|
### Start a publisher
|
||||||
|
|
||||||
|
* Click `Publish a Broadcast`
|
||||||
|
* `curl localhost:8080/sdp -d "YOUR SDP"`. The `broadcast` application will respond with an offer, paste this into the second input field. Then press `Start Session`
|
||||||
|
|
||||||
|
### Join the broadcast
|
||||||
|
* Click `Join a Broadcast`
|
||||||
|
* `curl localhost:8080/sdp -d "YOUR SDP"`. The `broadcast` application will respond with an offer, paste this into the second input field. Then press `Start Session`
|
||||||
|
|
||||||
|
You can change the listening port using `-port 8011`
|
||||||
|
|
||||||
|
You can `Join the broadcast` as many times as you want. The `broadcast` Golang application is relaying all traffic, so your browser only has to upload once.
|
||||||
|
|
||||||
|
Congrats, you have used Pion WebRTC! Now start building something cool
|
5
examples/broadcast/jsfiddle/demo.details
Normal file
5
examples/broadcast/jsfiddle/demo.details
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
name: broadcast
|
||||||
|
description: Example of a broadcast using Pion WebRTC
|
||||||
|
authors:
|
||||||
|
- Sean DuBois
|
@@ -48,9 +48,9 @@
|
|||||||
"type": "browser"
|
"type": "browser"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"title": "SFU Minimal",
|
"title": "Broadcast",
|
||||||
"link": "sfu-minimal",
|
"link": "broadcast",
|
||||||
"description": "The SFU example demonstrates how to broadcast a video to multiple peers. A broadcaster uploads the video once and the server forwards it to all other peers.",
|
"description": "The broadcast example demonstrates how to broadcast a video to multiple peers. A broadcaster uploads the video once and the server forwards it to all other peers.",
|
||||||
"type": "browser"
|
"type": "browser"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
@@ -1,32 +0,0 @@
|
|||||||
# sfu-minimal
|
|
||||||
sfu-minimal is a Pion WebRTC application that demonstrates how to broadcast a video to many peers, while only requiring the broadcaster to upload once.
|
|
||||||
|
|
||||||
This could serve as the building block to building conferencing software, and other applications where publishers are bandwidth constrained.
|
|
||||||
|
|
||||||
## Instructions
|
|
||||||
### Download sfu-minimal
|
|
||||||
```
|
|
||||||
go get github.com/pion/webrtc/examples/sfu-minimal
|
|
||||||
```
|
|
||||||
|
|
||||||
### Open sfu-minimal example page
|
|
||||||
[jsfiddle.net](https://jsfiddle.net/zhpya3n9/) You should see two buttons 'Publish a Broadcast' and 'Join a Broadcast'
|
|
||||||
|
|
||||||
### Run SFU Minimal
|
|
||||||
#### Linux/macOS
|
|
||||||
Run `sfu-minimal` OR run `main.go` in `github.com/pion/webrtc/examples/sfu-minimal`
|
|
||||||
|
|
||||||
### Start a publisher
|
|
||||||
|
|
||||||
* Click `Publish a Broadcast`
|
|
||||||
* `curl localhost:8080/sdp -d "YOUR SDP"`. The `sfu-minimal` application will respond with an offer, paste this into the second input field. Then press `Start Session`
|
|
||||||
|
|
||||||
### Join the broadcast
|
|
||||||
* Click `Join a Broadcast`
|
|
||||||
* `curl localhost:8080/sdp -d "YOUR SDP"`. The `sfu-minimal` application will respond with an offer, paste this into the second input field. Then press `Start Session`
|
|
||||||
|
|
||||||
You can change the listening port using `-port 8011`
|
|
||||||
|
|
||||||
You can `Join the broadcast` as many times as you want. The `sfu-minimal` Golang application is relaying all traffic, so your browser only has to upload once.
|
|
||||||
|
|
||||||
Congrats, you have used Pion WebRTC! Now start building something cool
|
|
@@ -1,5 +0,0 @@
|
|||||||
---
|
|
||||||
name: sfu-minimal
|
|
||||||
description: Example of a minimal SFU using Pion WebRTC
|
|
||||||
authors:
|
|
||||||
- Sean DuBois
|
|
Reference in New Issue
Block a user