Class Candidate

Struct to hold information about ICE-19 compliant candidates

record

Hierarchy

Candidate

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Candidate(foundation: string, componentId: number, type: Farstream.CandidateType, proto: Farstream.NetworkProtocol, ip: string, port: number): Farstream.Candidate

- Defined in Farstream-0.1.d.ts:1476
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

baseIp: string

basePort

basePort: number

componentId

componentId: number

foundation

foundation: string

ip

ip: string

password

password: string

port

port: number

priority

priority: number

proto

proto: Farstream.NetworkProtocol

ttl

ttl: number

type

type: Farstream.CandidateType

username

username: string

Static name

name: string

Methods

copy

copy(): Farstream.Candidate

- Defined in Farstream-0.1.d.ts:1449
Copies a #FsCandidate and its contents.

Returns Farstream.Candidate

destroy

destroy(): void

- Defined in Farstream-0.1.d.ts:1450
Returns void

Static new

new(foundation: string, componentId: number, type: Farstream.CandidateType, proto: Farstream.NetworkProtocol, ip: string, port: number): Farstream.Candidate

- Defined in Farstream-0.1.d.ts:1488
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