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. See also fs_candidate_new_full()

    Parameters

    • foundation: string

      The foundation of the candidate

    • component_id: 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

base_ip: string

IP of base in dotted format as defined in ICE-19.

field
base_port: number

Port of base as defined in ICE-19.

field
component_id: number

value between 1 and 256 indicating which component this candidate represents (1 is RTP, 2 is RTCP, #FsComponentType can be used here)

field
foundation: string

a string representing the foundation of this candidate (maximum 32 chars)

field
ip: string

IP in dotted format

field
password: string

Username to use to connect to client if necessary, NULL otherwise

field
port: number

Port to use

field
priority: number

Value between 0 and (2^31 - 1) representing the priority

field

#FsNetworkProtocol for ip protocol to use as candidate

field
ttl: number

The TTL used when sending Multicast packet (0 = auto)

field

The #FsCandidateType of the candidate

field
username: string

Username to use to connect to client if necessary, NULL otherwise

field
name: string

Methods

  • Allocates a new #FsCandidate, the rest of the fields can be optionally filled manually. See also fs_candidate_new_full()

    Parameters

    • foundation: string

      The foundation of the candidate

    • component_id: 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

  • Allocates a new #FsCandidate, filling all the fields. See also fs_candidate_new()

    Parameters

    • foundation: string

      The foundation of the candidate

    • component_id: number

      The component this candidate 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

    • base_ip: string

      IP of base in dotted format as defined in ICE-19.

    • base_port: number

      Port of base as defined in ICE-19.

    • proto: Farstream.NetworkProtocol

      The protocol this component is for

    • priority: number

      Value between 0 and (2^31 - 1) representing the priority

    • type: Farstream.CandidateType

      The type of candidate

    • username: string

      Username to use to connect to client if necessary, NULL otherwise

    • password: string

      Username to use to connect to client if necessary, NULL otherwise

    • ttl: number

      The TTL used when sending Multicast packet (0 = auto)

    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