summaryrefslogtreecommitdiffstats
path: root/modules/webrtc/doc_classes/WebRTCPeerConnection.xml
Commit message (Collapse)AuthorAgeFilesLines
* Avoid punning enum names in documentationHaoyu Qiu2023-11-091-1/+1
|
* Fix typo in WebRTCPeerConnection documentationazuloo2023-08-301-1/+1
|
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-061-1/+1
| | | | | | We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
* Bump version to 4.2-devRémi Verschelde2023-07-051-1/+1
| | | | Keep on waitin'
* Validate code tags in documentation for potential paramsYuri Sizov2023-04-261-8/+8
| | | | | | | Adds a check to make_rst to look for matches between the text inside of the [code][/code] tag and known param identifiers. Fixes most of what was revealed.
* Bump version to 4.1-devRémi Verschelde2023-03-011-1/+1
| | | | Can't stop, won't stop, they said, huh?
* [WebRTC] Expose more of the WebRTC API.Fabio Alessandrelli2022-09-131-0/+39
| | | | | | | | | | Add get_gathering_state() returning the iceGatheringState of the connection. Add get_signaling_state() returning the signalingState of the connection. Improve JS library.
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-17/+17
|
* [WebRTC] Static extension registration.Fabio Alessandrelli2022-06-091-0/+7
|
* Add an XML schema for documentationHugo Locurcio2022-02-151-1/+1
| | | | | | | | This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
* Improve some signal bindings to use specific `Object` subtypesRémi Verschelde2022-01-281-1/+1
|
* Dictionary: Serialize empty dict as `{}` instead of `{\n}`Rémi Verschelde2022-01-181-4/+2
| | | | | Also make sure to always convert multiline dictionaries to a single line for its EditorHelp representation, as multiline values break formatting.
* doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphsRémi Verschelde2021-10-051-1/+2
| | | | And fix up formatting not supported by makerst.
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-50/+25
| | | | | | | | For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
* Rename Reference to RefCountedPedro J. Estébanez2021-06-111-1/+1
|
* Fix typos with codespellRémi Verschelde2021-05-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Using codespell 2.0.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear dof doubleclick fave findn GIRD leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
* doc: Sync classref with current sourceRémi Verschelde2020-10-091-2/+0
|
* Fix TURN server example in WebRTC documentationPouleyKetchoupp2020-09-081-1/+1
| | | | | WebRTC GDNative plugin uses `credential` and not `credentials`. https://github.com/godotengine/webrtc-native/blob/74f2c78db5cdffa5b2b6ba9cd041061d7694400c/src/WebRTCLibPeerConnection.cpp#L35-L37
* Fix WebRTCPeerConnection set_local_description docFabio Alessandrelli2020-06-041-1/+1
| | | | | | ice_candidate_created should be emitted after set_local_description no matter the type of the description (assuming no error is returned of course).
* Update docs to version 4.0clayjohn2020-01-311-1/+1
|
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-1/+1
| | | | | | | | | | We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
* doc: Misc updates for AnimationNode* and othersRémi Verschelde2020-01-231-1/+1
| | | | | | | | | | | | | - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
* Proofread and improve the whole class referenceHugo Locurcio2019-06-271-2/+2
| | | | | | | | | | | | | - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
* doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde2019-06-271-2/+2
|
* doc: Fix formatting, typos and some descriptions in new docstringsRémi Verschelde2019-06-151-9/+7
|
* Add documentation for WebRTC classes.Fabio Alessandrelli2019-06-141-0/+63
|
* WebRTC refactor. Data channels, STUN/TURN support.Fabio Alessandrelli2019-05-161-0/+129
A big refactor to the WebRTC module. API is now considered quite stable. Highlights: - Renamed `WebRTCPeer` to `WebRTCPeerConnection`. - `WebRTCPeerConnection` no longer act as `PacketPeer`, it only handle the connection itself (a bit like `TCP_Server`) - Added new `WebRTCDataChannel` class which inherits from `PacketPeer` to handle data transfer. - Add `WebRTCPeerConnection.initialize` method to create a new connection with the desired configuration provided as dictionary ([see MDN docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection#RTCConfiguration_dictionary)). - Add `WebRTCPeerConnection.create_data_channel` method to create a data channel for the given connection. The connection must be in `STATE_NEW` as specified by the standard ([see MDN docs for options](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createDataChannel#RTCDataChannelInit_dictionary)). - Add a `data_channel_received` signal to `WebRTCPeerConnection` for in-band (not negotiated) channels. - Renamed `WebRTCPeerConnection` `offer_created` signal to `session_description_created`. - Renamed `WebRTCPeerConnection` `new_ice_candidate` signal to `ice_candidate_created`