You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,28 @@
1
1
#pulsebeam-js
2
2
3
3
**Thin JavaScript client for PulseBeam SFU.**
4
-
A lightweight, optional SDK for connecting to the PulseBeam WebRTC SFU server. Simplifies real-time video, audio, and data streaming using native WebRTC APIs.
4
+
A lightweight, optional SDK for connecting to the[PulseBeam WebRTC SFU server](https://github.com/pulsebeamdev/pulsebeam). Simplifies real-time video, audio, and data streaming using native WebRTC APIs.
5
5
6
6
[Report a Bug](https://github.com/pulsebeamdev/pulsebeam-js/issues) ·[Request a Feature](https://github.com/pulsebeamdev/pulsebeam-js/issues) ·[Discord](https://discord.gg/Bhd3t9afuB)
7
7
8
8
---
9
9
10
10
##What is pulsebeam-js?
11
11
12
-
`pulsebeam-js` is a minimal JavaScript client for the[PulseBeam SFU server](https://github.com/pulsebeamdev/pulsebeam). It’s an optional convenience layer to streamline connecting browsers orNode.js apps to PulseBeam for real-time media (video/audio/data).
12
+
`pulsebeam-js` is a minimal JavaScript client for the[PulseBeam SFU server](https://github.com/pulsebeamdev/pulsebeam). It’s an optional convenience layer to streamline connecting browsers, mobile apps, andNode.js apps to PulseBeam for real-time media (video/audio/data).
13
13
14
14
-**Thin and optional**: Wraps native WebRTC APIs, no dependencies, no bloat.
15
15
-**Purpose**: Simplifies setup for publishing and subscribing to streams.
16
-
-**No lock-in**: You can use raw WebRTC with PulseBeam’s HTTP signaling (WHIP/WHEP-compatible) without this SDK.
16
+
-**No lock-in**: Use raw WebRTC with PulseBeam’s HTTP signaling (WHIP/WHEP-compatible) without this SDK.
17
+
18
+
###Planned Framework Support
19
+
20
+
| Platform| Framework| Status|
21
+
|----------------|----------------|---------|
22
+
|**Browser**| React| Planned|
23
+
|**Browser**| Vue| Planned|
24
+
|**Browser**| Angular| Planned|
25
+
|**Mobile**| React Native| Planned|
17
26
18
27
The SDK is not implemented yet—our focus is on stabilizing the[PulseBeam SFU server](https://github.com/pulsebeamdev/pulsebeam). Check the server repo for setup, demos, and raw WebRTC examples.
19
28
@@ -23,7 +32,7 @@ The SDK is not implemented yet—our focus is on stabilizing the [PulseBeam SFU
23
32
24
33
The PulseBeam SFU is the core. See the[PulseBeam README](https://github.com/pulsebeamdev/pulsebeam) for how to run the server and use browser-native WebRTC APIs for publishing and viewing streams.
25
34
26
-
This client will provide a simpler APIforthe same functionality when ready. For now, use the server’s raw HTTP signaling as shown in the[PulseBeam demos](https://github.com/pulsebeamdev/pulsebeam#demo-broadcast).
35
+
This client will provide a simpler API, with explicit supportfor**React**,**React Native**,**Vue**, and**Angular**, when ready. For now, use the server’s raw HTTP signaling as shown in the[PulseBeam demos](https://github.com/pulsebeamdev/pulsebeam#demo-broadcast).