Gjsify LogoGjsify Logo

Struct to hold information about ICE-19 compliant candidates

record

Hierarchy

  • Candidate

Index

Constructors

  • Allocates a new #FsCandidate, the rest of the fields can be optionally filled manually.

    Parameters

    • foundation: string

      The foundation of the candidate

    • componentId: number

      The component this candidate is for

    • type: Farstream.CandidateType

      The type of candidate

    • proto: Farstream.NetworkProtocol

      The protocol this component is for

    • ip: string

      The IP address of this component (can be NULL for local candidate to mean any address)

    • port: number

      the UDP/TCP port

    Returns Farstream.Candidate

Properties

baseIp: string
basePort: number
componentId: number
foundation: string
ip: string
password: string
port: number
priority: number
ttl: number
username: string
name: string

Methods

  • destroy(): void
  • Allocates a new #FsCandidate, the rest of the fields can be optionally filled manually.

    Parameters

    • foundation: string

      The foundation of the candidate

    • componentId: number

      The component this candidate is for

    • type: Farstream.CandidateType

      The type of candidate

    • proto: Farstream.NetworkProtocol

      The protocol this component is for

    • ip: string

      The IP address of this component (can be NULL for local candidate to mean any address)

    • port: number

      the UDP/TCP port

    Returns Farstream.Candidate

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