asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

77 lines
2.5 KiB
XML
Raw Normal View History

[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation 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.
2022-02-14 14:18:53 +01:00
<class name="WebRTCPeerConnectionExtension" inherits="WebRTCPeerConnection" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_add_ice_candidate" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="p_sdp_mid_name" type="String" />
<param index="1" name="p_sdp_mline_index" type="int" />
<param index="2" name="p_sdp_name" type="String" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_close" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_create_data_channel" qualifiers="virtual">
<return type="Object" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="p_label" type="String" />
<param index="1" name="p_config" type="Dictionary" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_create_offer" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_get_connection_state" qualifiers="virtual const">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="WebRTCPeerConnection.ConnectionState" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
[WebRTC] Expose more of the WebRTC API. Add get_gathering_state() returning the iceGatheringState of the connection. Add get_signaling_state() returning the signalingState of the connection. Improve JS library.
2022-09-08 04:39:32 +02:00
<method name="_get_gathering_state" qualifiers="virtual const">
<return type="int" enum="WebRTCPeerConnection.GatheringState" />
<description>
</description>
</method>
<method name="_get_signaling_state" qualifiers="virtual const">
<return type="int" enum="WebRTCPeerConnection.SignalingState" />
<description>
</description>
</method>
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<method name="_initialize" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="p_config" type="Dictionary" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_poll" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_set_local_description" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="p_type" type="String" />
<param index="1" name="p_sdp" type="String" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_set_remote_description" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="p_type" type="String" />
<param index="1" name="p_sdp" type="String" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
</methods>
</class>
Reference in a new issue Copy permalink