@stream-io/video-react-sdk 0.0.35 → 0.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/README.md +80 -3
  3. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -2,6 +2,24 @@
2
2
 
3
3
  This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
4
4
 
5
+ ### [0.0.37](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-sdk-0.0.36...@stream-io/video-react-sdk-0.0.37) (2023-06-20)
6
+
7
+ ### Dependency Updates
8
+
9
+ * `@stream-io/video-client` updated to version `0.0.1`
10
+ * `@stream-io/video-react-bindings` updated to version `0.0.18`
11
+
12
+ ### Documentation
13
+
14
+ * Restructure device management guide ([#666](https://github.com/GetStream/stream-video-js/issues/666)) ([70013b2](https://github.com/GetStream/stream-video-js/commit/70013b203adbed13e6bbb070d749a6be2e7df794))
15
+
16
+ ### [0.0.36](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-sdk-0.0.35...@stream-io/video-react-sdk-0.0.36) (2023-06-19)
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * **react-sdk:** vale lint issue in README.md ([#665](https://github.com/GetStream/stream-video-js/issues/665)) ([f21fe8e](https://github.com/GetStream/stream-video-js/commit/f21fe8e74302f3f3b436f3f1bf0f64335d9c936a))
22
+
5
23
  ### [0.0.35](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-sdk-0.0.34...@stream-io/video-react-sdk-0.0.35) (2023-06-16)
6
24
 
7
25
 
package/README.md CHANGED
@@ -1,5 +1,82 @@
1
- # @stream-io/video-react-sdk
1
+ # Official React SDK for [Stream Video](https://getstream.io/video/docs/)
2
2
 
3
- 🚧 **WARNING** This package is not yet stable, it is for internal use only. For more information check out our [video product page](https://getstream.io/video/). 🚧
3
+ ## **Quick Links**
4
4
 
5
- TO DO
5
+ - [Register](https://getstream.io/chat/trial/) to get an API key for Stream Video
6
+ - [React Video Tutorial](/sample-apps/react/stream-video-react-tutorial)
7
+ - [Sample application](../../sample-apps/react/stream-video-react-tutorial)
8
+
9
+ ## What is Stream?
10
+
11
+ Stream allows developers to rapidly deploy scalable feeds, chat messaging and video with an industry leading 99.999% uptime SLA guarantee.
12
+
13
+ With Stream's video components, you can use their SDK to build in-app video calling, audio rooms, audio calls, or live streaming. The best place to get started is with their tutorials:
14
+
15
+ - Video & Audio Calling Tutorial
16
+ - Audio Rooms Tutorial
17
+ - Livestreaming Tutorial
18
+
19
+ Stream provides UI components and state handling that make it easy to build video calling for your app. All calls run on Stream's network of edge servers around the world, ensuring optimal latency and reliability.
20
+
21
+ ## 👩‍💻 Free for Makers 👨‍💻
22
+
23
+ Stream is free for most side and hobby projects. To qualify, your project/company needs to have < 5 team members and < $10k in monthly revenue. Makers get $100 in monthly credit for video for free.
24
+
25
+ ## 💡Supported Features💡
26
+
27
+ Here are some of the features we support:
28
+
29
+ - Developer experience: Great SDKs, docs, tutorials and support so you can build quickly
30
+ - Edge network: Servers around the world ensure optimal latency and reliability
31
+ - Chat: Stored chat, reactions, threads, typing indicators, URL previews etc
32
+ - Security & Privacy: Based in USA and EU, Soc2 certified, GDPR compliant
33
+ - Dynascale: Automatically switch resolutions, fps, bitrate, codecs and paginate video on large calls
34
+ - Screen sharing
35
+ - Picture in picture support
36
+ - Active speaker
37
+ - Custom events
38
+ - Geofencing
39
+ - Notifications and ringing calls
40
+ - Opus DTX & Red for reliable audio
41
+ - Webhooks & SQS
42
+ - Backstage mode
43
+ - Flexible permissions system
44
+ - Joining calls by ID, link or invite
45
+ - Enabling and disabling audio and video when in calls
46
+ - Flipping, Enabling and disabling camera in calls
47
+ - Enabling and disabling speakerphone in calls
48
+ - Push notification providers support
49
+ - Call recording
50
+ - Broadcasting to HLS
51
+
52
+ ## Roadmap
53
+
54
+ ### 0.1 milestone
55
+ - [ ] Call session migration
56
+ - [ ] Hardware-accelerated video encoding on supported platforms
57
+
58
+ ### 0.2 milestone
59
+ - [ ] Composite layout for streaming and recording
60
+ - [ ] Dynascale: turn off incoming video when the browser is in the background
61
+ - [ ] Performance and bundle-size optimizations
62
+ - [ ] Typescript generics enhancements
63
+ - [ ] Logging 2.0
64
+ - [ ] E2E testing platform
65
+ - [ ] Increase test coverage
66
+
67
+ ### 0.3 milestone
68
+ - [ ] Video and audio filters
69
+ - [ ] Transcriptions
70
+ - [ ] Closed captions
71
+
72
+ ### 0.4 milestone
73
+ - [ ] Enhanced UI components and theming
74
+ - [ ] Break-out rooms
75
+ - [ ] Waiting rooms
76
+
77
+ ## Contributing
78
+
79
+ - How can I submit a sample app?
80
+ - Apps submissions are always welcome. 🥳 Open a PR with a proper description and we'll review it as soon as possible.
81
+ - Spot a bug 🕷 ?
82
+ - We welcome code changes that improve the apps or fix a problem. Please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github.
package/package.json CHANGED
@@ -26,8 +26,8 @@
26
26
  "@nivo/core": "^0.80.0",
27
27
  "@nivo/line": "^0.80.0",
28
28
  "@stream-io/i18n": "^0.0.5",
29
- "@stream-io/video-client": "^0.0.16",
30
- "@stream-io/video-react-bindings": "^0.0.17",
29
+ "@stream-io/video-client": "^0.0.17",
30
+ "@stream-io/video-react-bindings": "^0.0.18",
31
31
  "clsx": "^1.2.1",
32
32
  "rxjs": "~7.8.1"
33
33
  },
@@ -47,5 +47,5 @@
47
47
  "typedoc": "^0.24.7",
48
48
  "typescript": "^4.9.5"
49
49
  },
50
- "version": "0.0.35"
50
+ "version": "0.0.37"
51
51
  }