Configurations for a TURN server in setTurnServer or createClient.

Hierarchy

  • TurnServer

Index

Properties

Optional forceturn

forceturn: boolean

Sets whether to force data transfer by TURN Server:

  • true: Force data transfer.
  • false: (default) Not to force data transfer.

password

password: string

Your TURN Server password. ASCII characters only, and the string length must be greater than 0 and less than 256 bytes.

Optional tcpport

tcpport: string

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

turnServerURL: string

Your TURN Server URL address. ASCII characters only, and the string length must be greater than 0 and less than 256 bytes.

udpport

udpport: string

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

username: string

Your TURN Server username. ASCII characters only, and the string length must be greater than 0 and less than 256 bytes.