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: Assets/SimpleWebRTC/README.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio
7
7
- WebRTC peer-to-peer connection management
8
8
- WebSocket-based signaling
9
9
- Video and audio streaming
10
+
- Immersive video streaming (360° monoscopic or stereo over-under)
10
11
- Data channel communication
11
12
- Logging and debugging tools
12
13
- Usage with Photon Fusion 2
@@ -18,7 +19,7 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
18
19
19
20
## Simple Installation
20
21
1. Make sure, that the required dependencies are installed (`TextMeshPro`, `Unity WebRTC`, `NativeWebSocket`).
21
-
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/slug/309727](https://assetstore.unity.com/packages/slug/309727)
22
+
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727](https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727)
22
23
4. Install the package via Unity AssetStore.
23
24
24
25
## Installation using the releases page
@@ -34,6 +35,13 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
34
35
5. After the installation finished, click on the + sign in the upper left/right corner again
35
36
6. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
36
37
38
+
## Installation using Unity Package Manager with preinstalled Meta Voice SDK package
39
+
1. Create a new Unity project
40
+
2. The Meta Voice SDK already has the NativeWebSocket package integrated, so there is no need to install it manually. SimpleWebRTC will automatically try to use the NativeWebSocket package provided by Meta.
41
+
3. Open the Package Manager, click on the + sign in the upper left/right corner
42
+
4. Select "Add package from git URL"
43
+
5. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
44
+
37
45
## Manual Installation
38
46
1. Clone the repository:
39
47
```sh
@@ -117,13 +125,15 @@ The `WebRTCConnection` component includes several configurable parameters:
117
125
Modify these values in the Unity Inspector or directly in the script.
118
126
119
127
## Example
120
-
Following sample scenes are included in the pacakge:
128
+
Following sample scenes are included in the package (available at Samples tab in package manager):
121
129
**WebSocket-TestConnection*: For testing the wecksocket connection separately.
122
130
**WebRTC-SingleClient-STUNConnection*: Testing STUN connection for a single client. Works standalone and can be deployed to clients. Make sure to set the `LocalPeerId` for each client individually.
123
131
**WebRTC-SingleClient-wLobby-STUNConnection*: A simple Lobby example for handling multiple STUN WebRTC clients. `SimpleLobbyManager.cs` shows an example, how to use **SimpleWebRTC** via C#.
124
132
**WebRTC-MultipleClients-STUNConnection*: Shows how multiple clients can be connected via peer-to-peer connections and share data, video and audio transmissions.
125
133
**WebRTC-SingleClient-STUNConnection-PhotonFusion*: Testing STUN connection for a single client using Photon Fusion 2 as signaling server. Works standalone and can be deployed to clients. Make sure to set the `LocalPeerId` for each client individually.
126
134
**WebRTC-SingleClient-STUNConnection-VisualScripting*: Using Unity Visual Scripting with SimpleWebRTC. Works with all SimpleWebRTC features and can be deployed to clients.
135
+
**WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Sender*: A simple example for a possible video sender, which can be every 3D application.
136
+
**WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Receiver*: The receiver sample for the video sender. This will most likely targeted at an XR device.
127
137
128
138
## Example code
129
139
```csharp
@@ -138,6 +148,10 @@ connection.SendDataChannelMessage("Hello Peer!"); // Send a message over the dat
Copy file name to clipboardExpand all lines: Assets/SimpleWebRTC/Runtime/Starter-Documentation.txt
+16-2Lines changed: 16 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio
7
7
- WebRTC peer-to-peer connection management
8
8
- WebSocket-based signaling
9
9
- Video and audio streaming
10
+
- Immersive video streaming (360° monoscopic or stereo over-under)
10
11
- Data channel communication
11
12
- Logging and debugging tools
12
13
- Usage with Photon Fusion 2
@@ -18,7 +19,7 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
18
19
19
20
## Simple Installation
20
21
1. Make sure, that the required dependencies are installed (`TextMeshPro`, `Unity WebRTC`, `NativeWebSocket`).
21
-
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/slug/309727](https://assetstore.unity.com/packages/slug/309727)
22
+
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727](https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727)
22
23
4. Install the package via Unity AssetStore.
23
24
24
25
## Installation using the releases page
@@ -34,6 +35,13 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
34
35
5. After the installation finished, click on the + sign in the upper left/right corner again
35
36
6. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
36
37
38
+
## Installation using Unity Package Manager with preinstalled Meta Voice SDK package
39
+
1. Create a new Unity project
40
+
2. The Meta Voice SDK already has the NativeWebSocket package integrated, so there is no need to install it manually. SimpleWebRTC will automatically try to use the NativeWebSocket package provided by Meta.
41
+
3. Open the Package Manager, click on the + sign in the upper left/right corner
42
+
4. Select "Add package from git URL"
43
+
5. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
44
+
37
45
## Manual Installation
38
46
1. Clone the repository:
39
47
```sh
@@ -117,13 +125,15 @@ The `WebRTCConnection` component includes several configurable parameters:
117
125
Modify these values in the Unity Inspector or directly in the script.
118
126
119
127
## Example
120
-
Following sample scenes are included in the pacakge:
128
+
Following sample scenes are included in the package (available at Samples tab in package manager):
121
129
* *WebSocket-TestConnection*: For testing the wecksocket connection separately.
122
130
* *WebRTC-SingleClient-STUNConnection*: Testing STUN connection for a single client. Works standalone and can be deployed to clients. Make sure to set the `LocalPeerId` for each client individually.
123
131
* *WebRTC-SingleClient-wLobby-STUNConnection*: A simple Lobby example for handling multiple STUN WebRTC clients. `SimpleLobbyManager.cs` shows an example, how to use **SimpleWebRTC** via C#.
124
132
* *WebRTC-MultipleClients-STUNConnection*: Shows how multiple clients can be connected via peer-to-peer connections and share data, video and audio transmissions.
125
133
* *WebRTC-SingleClient-STUNConnection-PhotonFusion*: Testing STUN connection for a single client using Photon Fusion 2 as signaling server. Works standalone and can be deployed to clients. Make sure to set the `LocalPeerId` for each client individually.
126
134
* *WebRTC-SingleClient-STUNConnection-VisualScripting*: Using Unity Visual Scripting with SimpleWebRTC. Works with all SimpleWebRTC features and can be deployed to clients.
135
+
* *WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Sender*: A simple example for a possible video sender, which can be every 3D application.
136
+
* *WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Receiver*: The receiver sample for the video sender. This will most likely targeted at an XR device.
127
137
128
138
## Example code
129
139
```csharp
@@ -138,6 +148,10 @@ connection.SendDataChannelMessage("Hello Peer!"); // Send a message over the dat
0 commit comments