Documentation
Video Call (Legacy)
Agora Web SDK API Reference
Hierarchy
- TurnServer
Index
Properties
Optional forceturn
Sets whether to force data transfer by TURN Server:
true: Force data transfer.false: (default) Not to force data transfer.
password
Your TURN Server password. ASCII characters only, and the string length must be greater than 0 and less than 256 bytes.
Optional tcpport
The TCP port(s) you want add to TURN Server. Numeric characters only, and the string length must be greater than 0 and less than 256 bytes.
turnServerURL
Your TURN Server URL address. ASCII characters only, and the string length must be greater than 0 and less than 256 bytes.
udpport
The UDP port(s) you want to add to TURN Server. Numeric characters only, and the string length must be greater than 0 and less than 256 bytes.
username
Your TURN Server username. ASCII characters only, and the string length must be greater than 0 and less than 256 bytes.
Configurations for a TURN server in setTurnServer or createClient.