Gjsify LogoGjsify Logo

Index

Variables

AGENT_MAX_REMOTE_CANDIDATES: number

A hard limit for the number of remote candidates. This limit is enforced to protect against malevolent remote clients.

CANDIDATE_MAX_FOUNDATION: number

The maximum size a candidate foundation can have.

CANDIDATE_MAX_LOCAL_ADDRESSES: number

The maximum number of local addresses. The constraint is that the maximum number of local addresses and number of turn servers must fit on 9 bits, to ensure candidate priority uniqueness. See also NICE_CANDIDATE_MAX_TURN_SERVERS. We choose 6 bits for the number of local addresses, and 3 bits for the number of turn servers.

CANDIDATE_MAX_TURN_SERVERS: number

The maximum number of turns servers.

Functions

  • Useful for debugging functions, just returns a static string with the candidate transport.

    Parameters

    Returns string

  • Useful for debugging functions, just returns a static string with the candidate type.

    Parameters

    Returns string

  • Returns a string representation of the state, generally to use in debug messages.

    Parameters

    Returns string

  • debugDisable(withStun: boolean): void
  • Disables libnice debug output to the terminal

    Parameters

    • withStun: boolean

      Also disable stun debugging messages

    Returns void

  • debugEnable(withStun: boolean): void
  • Enables libnice debug output to the terminal. Note that the G_MESSAGES_DEBUG and NICE_DEBUG environment variables must be set to the set of logging domains to print, in order for any output to be printed. Set them to all to print all debugging messages, or any of the following domains:

    • libnice-stun
    • libnice-tests
    • libnice-socket
    • libnice
    • libnice-pseudotcp
    • libnice-pseudotcp-verbose

    Parameters

    • withStun: boolean

      Also enable STUN debugging messages

    Returns void

  • interfacesGetIpForInterface(interfaceName: string): string | null
  • Retrieves the IP address of an interface by its name. If this fails, %NULL is returned.

    Parameters

    • interfaceName: string

      name of local interface

    Returns string | null

  • interfacesGetLocalInterfaces(): string[]
  • interfacesGetLocalIps(includeLoopback: boolean): string[]
  • Get a list of local ipv4 interface addresses

    Parameters

    • includeLoopback: boolean

      Include any loopback devices

    Returns string[]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method