Browse Source

Fix WebRTCPeerConnection set_local_description doc

ice_candidate_created should be emitted after set_local_description no
matter the type of the description (assuming no error is returned of
course).
Fabio Alessandrelli 5 years ago
parent
commit
39bcbf5690
1 changed files with 1 additions and 1 deletions
  1. 1 1
      modules/webrtc/doc_classes/WebRTCPeerConnection.xml

+ 1 - 1
modules/webrtc/doc_classes/WebRTCPeerConnection.xml

@@ -120,7 +120,7 @@
 			</argument>
 			<description>
 				Sets the SDP description of the local peer. This should be called in response to [signal session_description_created].
-				If [code]type[/code] is [code]answer[/code] the peer will start emitting [signal ice_candidate_created].
+				After calling this function the peer will start emitting [signal ice_candidate_created] (unless an [enum Error] different from [constant OK] is returned).
 			</description>
 		</method>
 		<method name="set_remote_description">