Gjsify LogoGjsify Logo

A structure to represent an ICE candidate The priority is an integer as specified in the ICE draft 19. If you are using the MSN or the GOOGLE compatibility mode (which are based on ICE draft 6, which uses a floating point qvalue as priority), then the priority value will represent the qvalue multiplied by 1000.

record

Hierarchy

  • Candidate

Index

Constructors

Properties

The #NiceAddress of the candidate

field
baseAddr: Nice.Address

The #NiceAddress of the base address used by the candidate

field
componentId: number

The ID of the component to which belongs the candidate

field
foundation: number[]

The foundation of the candidate

field
password: string

The candidate-specific password to use (overrides the one set by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials())

field
priority: number

The priority of the candidate see note

field
streamId: number

The ID of the stream to which belongs the candidate

field

The transport being used for the candidate

field

The type of candidate

field
username: string

The candidate-specific username to use (overrides the one set by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials())

field
name: string

Methods

  • Verifies that the candidates point to the same place, meaning they have the same transport and the same address. It ignores all other aspects.

    Parameters

    Returns boolean

  • free(): void
  • 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

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