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: docs/examples.md
+37-9Lines changed: 37 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
This section provides an overview of the example applications included in the `webrtc-examples` Maven module. These examples demonstrate various features and capabilities of the webrtc-java library.
4
4
5
-
## PeerConnectionExample
5
+
## PeerConnection
6
6
7
-
The `PeerConnectionExample` demonstrates how to set up a peer connection with audio and video tracks to be able to send and receive media.
7
+
The [`PeerConnectionExample`](https://github.com/devopvoid/webrtc-java/blob/master/webrtc-examples/src/main/java/dev/onvoid/webrtc/examples/PeerConnectionExample.java) demonstrates how to set up a peer connection with audio and video tracks to be able to send and receive media.
8
8
9
9
**Key features demonstrated:**
10
10
- Creating a PeerConnectionFactory
@@ -15,9 +15,9 @@ The `PeerConnectionExample` demonstrates how to set up a peer connection with au
15
15
16
16
This example provides a foundation for building WebRTC applications that need to handle audio and video communication.
17
17
18
-
## WhepExample
18
+
## WHEP
19
19
20
-
The `WhepExample` demonstrates an implementation of WebRTC HTTP Egress Protocol (WHEP) client, which is a standardized protocol for WebRTC ingestion.
20
+
The [`WhepExample`](https://github.com/devopvoid/webrtc-java/blob/master/webrtc-examples/src/main/java/dev/onvoid/webrtc/examples/WhepExample.java) demonstrates an implementation of WebRTC HTTP Egress Protocol (WHEP) client, which is a standardized protocol for WebRTC ingestion.
21
21
22
22
**Key features demonstrated:**
23
23
- Setting up a WebRTC peer connection
@@ -27,9 +27,9 @@ The `WhepExample` demonstrates an implementation of WebRTC HTTP Egress Protocol
27
27
28
28
This example is useful for applications that need to receive media streams from WHEP-compatible servers, such as live streaming platforms.
29
29
30
-
## CodecListExample
30
+
## Codec List
31
31
32
-
The `CodecListExample` demonstrates how to list all supported codecs with the WebRTC peer-connection-factory.
32
+
The [`CodecListExample`](https://github.com/devopvoid/webrtc-java/blob/master/webrtc-examples/src/main/java/dev/onvoid/webrtc/examples/CodecListExample.java) demonstrates how to list all supported codecs with the WebRTC peer-connection-factory.
33
33
34
34
**Key features demonstrated:**
35
35
- Creating a PeerConnectionFactory
@@ -38,9 +38,9 @@ The `CodecListExample` demonstrates how to list all supported codecs with the We
38
38
39
39
This example is useful for understanding what codecs are available on the current system, which can help with debugging compatibility issues or optimizing media quality.
40
40
41
-
## DesktopVideoExample
41
+
## Desktop Video
42
42
43
-
The `DesktopVideoExample` demonstrates how to set up a peer connection with a desktop video source for screen or window capture.
43
+
The [`DesktopVideoExample`](https://github.com/devopvoid/webrtc-java/blob/master/webrtc-examples/src/main/java/dev/onvoid/webrtc/examples/DesktopVideoExample.java) demonstrates how to set up a peer connection with a desktop video source for screen or window capture.
44
44
45
45
**Key features demonstrated:**
46
46
- Creating a PeerConnectionFactory
@@ -52,6 +52,28 @@ The `DesktopVideoExample` demonstrates how to set up a peer connection with a de
52
52
53
53
This example is particularly useful for applications that need to implement screen sharing or remote desktop functionality.
54
54
55
+
## Web Client
56
+
57
+
The [`WebClientExample`](https://github.com/devopvoid/webrtc-java/blob/master/webrtc-examples/src/main/java/dev/onvoid/webrtc/examples/web/WebClientExample.java) demonstrates how to combine WebSocket signaling with WebRTC peer connections for real-time communication between web and Java clients.
58
+
59
+
**Key features demonstrated:**
60
+
- Connecting to a signaling server using WebSockets
- Joining and leaving rooms for multi-user communication
65
+
- Using custom audio sources for audio streaming
66
+
67
+
This example is valuable for applications that need to establish WebRTC connections between Java clients and web browsers, enabling cross-platform real-time communication with audio and video.
68
+
69
+
**Note:** Before running the WebClientExample, you need to start the WebServer first. The WebServer provides the signaling service required for WebRTC connection establishment:
Note that these examples focus on setting up the local components for WebRTC communication. In a real application, you would need to establish a connection with a remote peer through a signaling channel (e.g., WebSocket).
Note that these examples focus on setting up the local components for WebRTC communication. In a real application, you would need to establish a connection with a remote peer through a signaling channel (e.g., WebSocket). The `WebClientExample` demonstrates this by connecting to a signaling server.
0 commit comments