Parcourir la source

Added useTurnUdp option to API documentation (#1448)

* Added useTurnUdp option to API documentation

* Fixed typo
dev1
Greg ORIOL il y a 4 ans
Parent
révision
6551840eee
Aucun compte lié à l'adresse e-mail de l'auteur
1 fichiers modifiés avec 2 ajouts et 1 suppressions
  1. 2
    1
      doc/API.md

+ 2
- 1
doc/API.md Voir le fichier

@@ -48,7 +48,8 @@ The `options` parameter is JS object with the following properties:
48 48
     - `callStatsCustomScriptUrl` - (optional) custom url to access callstats client script
49 49
     - `disableRtx` - (optional) boolean property (default to false).  Enables/disable the use of RTX.
50 50
     - `disabledCodec` - the mime type of the code that should not be negotiated on the peerconnection.
51
-    - `preferredCodec` the mime type of the codec that needs to be made the preferred codec for the connection.
51
+    - `preferredCodec` - the mime type of the codec that needs to be made the preferred codec for the connection.
52
+    - `useTurnUdp` - boolean property (default false). Enables use of turn over udp for jvb. It is disabled because not very useful (if the client can use udp, it likely can connect to jvb directly over udp too; but it can be useful to still enable udp turn when an udp turn is known to be whitelisted on a network)
52 53
     - `disableH264` - __DEPRECATED__. Use `disabledCodec` instead.
53 54
     - `preferH264` - __DEPRECATED__. Use `preferredCodec` instead.
54 55
 

Chargement…
Annuler
Enregistrer