From 2aad7bf9940b38eaf3c2a85263e9a15dc5f850e0 Mon Sep 17 00:00:00 2001 From: abrusle <15620365+abrusle@users.noreply.github.com> Date: Sat, 23 Aug 2025 14:54:50 +0200 Subject: [PATCH] Fix typos and link tutorial in WebRTCPeerConnection docs --- modules/webrtc/doc_classes/WebRTCPeerConnection.xml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index 00d3c727fd3..9b948d3b3c3 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -4,14 +4,15 @@ Interface to a WebRTC peer connection. - A WebRTC connection between the local computer and a remote peer. Provides an interface to connect, maintain and monitor the connection. + A WebRTC connection between the local computer and a remote peer. Provides an interface to connect, maintain, and monitor the connection. Setting up a WebRTC connection between two peers may not seem a trivial task, but it can be broken down into 3 main steps: - - The peer that wants to initiate the connection ([code]A[/code] from now on) creates an offer and send it to the other peer ([code]B[/code] from now on). - - [code]B[/code] receives the offer, generate and answer, and sends it to [code]A[/code]). - - [code]A[/code] and [code]B[/code] then generates and exchange ICE candidates with each other. - After these steps, the connection should become connected. Keep on reading or look into the tutorial for more information. + - The peer that wants to initiate the connection ([code]A[/code] from now on) creates an offer and sends it to the other peer ([code]B[/code] from now on). + - [code]B[/code] receives the offer, generates an answer, and sends it to [code]A[/code]. + - [code]A[/code] and [code]B[/code] then generate and exchange ICE candidates with each other. + After these steps, the connection should be established. Refer to the linked tutorials for details. + $DOCS_URL/tutorials/networking/webrtc.html $DOCS_URL/tutorials/networking/high_level_multiplayer.html