|
1 | 1 | <h1 align="center">
|
2 |
| - Examples |
| 2 | + Examples WebRTC Applications |
3 | 3 | </h1>
|
4 | 4 |
|
5 |
| -We've build an extensive collection of examples covering common use-cases. You can modify and extend these examples to quickly get started. |
| 5 | +The following are a collection of example applications built by Pion users. These applications show real world usage of Pion, |
| 6 | +and should serve as a good starting point for your next project. For more minimal examples check out [examples](https://github.com/pion/webrtc/tree/master/examples) in the Pion WebRTC repository |
6 | 7 |
|
7 |
| -### Overview |
8 |
| -#### Media API |
| 8 | +If you have a request please make an issue, we also love contributions more examples are always welcome. |
| 9 | + |
| 10 | +Have any questions? Join [the Slack channel](https://pion.ly/slack) to follow development and speak with the maintainers. |
| 11 | + |
| 12 | +## Examples |
9 | 13 | * [Gstreamer Receive](gstreamer-receive): The gstreamer-receive example shows how to receive media from the browser and play it live. This example uses GStreamer for rendering.
|
10 | 14 | * [Gstreamer Send](gstreamer-send): Example gstreamer-send shows how to send video to your browser. This example uses GStreamer to process the video.
|
11 | 15 | * [Gstreamer Send Offer](gstreamer-send-offer): Example gstreamer-send-offer is a variant of gstreamer-send that initiates the WebRTC connection by sending an offer.
|
12 |
| -* [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. |
13 | 16 | * [Janus Gateway](janus-gateway): Example janus-gateway is a collection of examples showing how to use Pion WebRTC with [janus-gateway](https://github.com/meetecho/janus-gateway).
|
14 |
| -* [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. |
15 | 17 | * [SFU Websocket](sfu-ws): 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.
|
16 | 18 |
|
17 |
| -#### Data Channel API |
18 |
| -* [Data Channels](data-channels): The data-channels example shows how you can send/recv DataChannel messages from a web browser. |
19 |
| -* [Data Channels Create](data-channels-create): Example data-channels-create shows how you can send/recv DataChannel messages from a web browser. The difference with the data-channels example is that the data channel is initialized from the server side in this example. |
20 |
| -* [Data Channels Close](data-channels-close): Example data-channels-close is a variant of data-channels that allow playing with the life cycle of data channels. |
21 |
| -* [Data Channels Detach](data-channels-detach): The data-channels-detach example shows how you can send/recv DataChannel messages using the underlying DataChannel implementation directly. This provides a more idiomatic way of interacting with Data Channels. |
22 |
| -* [Data Channels Detach Create](data-channels-detach-create): Example data-channels-detach-create shows how you can send/recv DataChannel messages using the underlying DataChannel implementation directly. This provides a more idiomatic way of interacting with Data Channels. The difference with the data-channels-detach example is that the data channel is initialized in this example. |
23 |
| -* [Pion to Pion](pion-to-pion): Example pion-to-pion is an example of two pion instances communicating directly! It therefore has no corresponding web page. |
24 |
| -* [ORTC](ortc): Example ortc shows how you an use the ORTC API for DataChannel communication. |
25 |
| -* [ORTC QUIC](ortc-quic): Example ortc-quic shows how you an use the ORTC API for QUIC DataChannel communication. |
26 |
| -* [Pion to Pion](pion-to-pion): Example pion-to-pion is an example of two pion instances communicating directly! It therefore has no corresponding web page. |
27 |
| - |
28 | 19 |
|
29 | 20 | ### Usage
|
30 | 21 | We've made it easy to run the browser based examples on your local machine.
|
31 | 22 |
|
32 | 23 | 1. Build and run the example server:
|
33 | 24 | ``` sh
|
34 |
| - go get github.com/pion/webrtc |
35 |
| - cd $GOPATH/src/github.com/pion/webrtc/examples |
| 25 | + go get github.com/webrtc-example-applications |
| 26 | + cd $GOPATH/src/github.com/webrtc-example-applications |
36 | 27 | go run examples.go
|
37 | 28 | ```
|
38 | 29 |
|
39 | 30 | 2. Browse to [localhost](http://localhost) to browse through the examples.
|
40 | 31 |
|
41 | 32 | Note that you can change the port of the server using the ``--address`` flag.
|
42 | 33 |
|
43 |
| -### WebAssembly |
44 |
| -Some of our examples have support for WebAssembly. The same examples server documented above can be used to run the WebAssembly examples. However, you have to compile them first. This is done as follows: |
| 34 | +### Contributing |
| 35 | +Check out the **[contributing wiki](https://github.com/pion/webrtc/wiki/Contributing)** to join the group of amazing people making this project possible: |
45 | 36 |
|
46 |
| -1. If the example supports WebAssembly it will contain a `main.go` file under the `jsfiddle` folder. |
47 |
| -2. Build this `main.go` file as follows: |
48 |
| - ``` |
49 |
| - GOOS=js GOARCH=wasm go build -o demo.wasm |
50 |
| - ``` |
51 |
| -3. Start the example server. Refer to the [usage](#usage) section for how you can build the example server. |
52 |
| -4. Browse to [localhost](http://localhost). The page should now give you the option to run the example using the WebAssembly binary. |
| 37 | +### License |
| 38 | +MIT License - see [LICENSE](LICENSE) for full text |
0 commit comments