Skip to content

Commit 17e7654

Browse files
authored
FCE-1661 / improve examples readme (#375)
## Description Updates README of examples. Removes an unmaintained example. ## Motivation and Context Readme needed a refresh. The example of using camera and microphone is covered by the maintained and tested Fishjam Chat example. ## Types of changes - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
1 parent dce3119 commit 17e7654

39 files changed

Lines changed: 50 additions & 1140 deletions

examples/react-client/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Examples for Fishjam client
2+
3+
- [Minimal React](./minimal-react/) - minimal example
4+
5+
- streaming the shared screen
6+
- receiving media from other peers
7+
- almost no UI
8+
9+
- [Fishjam Chat](./fishjam-chat) - example video chat app
10+
11+
- streaming camera, microphone and screen sharing
12+
- displaying other peers video and audio
13+
- applying blur middleware
14+
15+
- [Livestream viewer](./livestream-viewer) - example of viewing a live stream
16+
- viewing a stream using a viewer token
17+
- you can test your livestream with this example
18+
19+
- [Audio only](./audio-only) - example audio-only app
20+
21+
- streaming microphone only
22+
- playing other peers' audio
23+
24+
- [Minimal Smelter](./minimal-smelter/) - example of integrating Fishjam with Smelter
25+
26+
- applying an example overlay on the camera stream with Smelter
27+
- streaming the result to Fishjam
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

examples/react-client/broadcast/package.json renamed to examples/react-client/livestream-viewer/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@fishjam-example/broadcast-example",
2+
"name": "@fishjam-example/livestream-viewer",
33
"private": true,
44
"version": "0.0.1",
55
"type": "module",

examples/react-client/broadcast/src/components/App.tsx renamed to examples/react-client/livestream-viewer/src/components/App.tsx

File renamed without changes.

examples/react-client/broadcast/src/components/VideoPlayer.tsx renamed to examples/react-client/livestream-viewer/src/components/VideoPlayer.tsx

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)