Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Candidate

A candidate.

Hierarchy

  • Candidate

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns Candidate

Properties

Private __turnTransportProtocol

__turnTransportProtocol: ProtocolType
internal

Private _dispatched

_dispatched: boolean
internal

Private _sdpCandidateAttribute

_sdpCandidateAttribute: CandidateAttribute
internal

Private _sdpMediaIndex

_sdpMediaIndex: number
internal

Methods

getDispatched

  • getDispatched(): boolean
  • Gets a value indicating whether this candidate has been already been dispatched as a part of a session description.

    Returns boolean

getSdpCandidateAttribute

  • getSdpCandidateAttribute(): CandidateAttribute
  • Gets the SDP candidate attribute.

    Returns CandidateAttribute

getSdpMediaIndex

  • getSdpMediaIndex(): number
  • Gets the media index.

    Returns number

getTurnTransportProtocol

  • getTurnTransportProtocol(): ProtocolType
  • Gets the protocol used by this candidate when communicating with the TURN (relay) server.

    Returns ProtocolType

getTypeString

  • getTypeString(): string

  • Returns string

setDispatched

  • setDispatched(value: boolean): void
  • Sets a value indicating whether this candidate has been already been dispatched as a part of a session description.

    Parameters

    • value: boolean

    Returns void

setSdpCandidateAttribute

  • setSdpCandidateAttribute(value: CandidateAttribute): void
  • Sets the SDP candidate attribute.

    Parameters

    • value: CandidateAttribute

    Returns void

setSdpMediaIndex

  • setSdpMediaIndex(value: number): void
  • Sets the media index.

    Parameters

    • value: number

    Returns void

setTurnTransportProtocol

  • setTurnTransportProtocol(value: ProtocolType): void
  • Sets the protocol used by this candidate when communicating with the TURN (relay) server.

    Parameters

    • value: ProtocolType

    Returns void

toJson

  • toJson(): string
  • Serializes this instance to JSON.

    Returns string

Static fromJson

  • fromJson(candidateJson: string): Candidate
  • Deserializes an instance from JSON.

    Parameters

    • candidateJson: string

      The JSON to deserialize.

    Returns Candidate

    The deserialized candidate.

Static toJson

  • toJson(candidate: Candidate): string
  • Serializes an instance to JSON.

    Parameters

    • candidate: Candidate

      The candidate to serialize.

    Returns string

    The serialized JSON.