Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-07 13:49:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix typos and link tutorial in WebRTCPeerConnection docs

Browse source
This commit is contained in:
abrusle 2025-08-23 14:54:50 +02:00 • committed by Rémi Verschelde
parent 63e14e13f9
commit 2aad7bf994
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
modules/webrtc/doc_classes/WebRTCPeerConnection.xml
View file

@ -4,14 +4,15 @@
Interface to a WebRTC peer connection. Interface to a WebRTC peer connection.
</brief_description> </brief_description>
<description> <description>
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: 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). - 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, generate and answer, and sends it to [code]A[/code]). - [code]B[/code] receives the offer, generates an answer, and sends it to [code]A[/code].
- [code]A[/code] and [code]B[/code] then generates and exchange ICE candidates with each other. - [code]A[/code] and [code]B[/code] then generate 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. After these steps, the connection should be established. Refer to the linked tutorials for details.
</description> </description>
<tutorials> <tutorials>
<link title="WebRTC documentation">$DOCS_URL/tutorials/networking/webrtc.html</link>
<link title="High-level multiplayer">$DOCS_URL/tutorials/networking/high_level_multiplayer.html</link> <link title="High-level multiplayer">$DOCS_URL/tutorials/networking/high_level_multiplayer.html</link>
</tutorials> </tutorials>
<methods> <methods>