Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CandidatePairStats

Candidate pair stats.

Hierarchy

  • BaseStats
    • CandidatePairStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _bytesReceived

_bytesReceived: number
internal

Private _bytesSent

_bytesSent: number
internal

Private _consentRequestsReceived

_consentRequestsReceived: number
internal

Private _consentRequestsSent

_consentRequestsSent: number
internal

Private _consentResponsesReceived

_consentResponsesReceived: number
internal

Private _consentResponsesSent

_consentResponsesSent: number
internal

Private _currentRoundTripTime

_currentRoundTripTime: number
internal

Private _localCandidateId

_localCandidateId: string
internal

Private _nominated

_nominated: boolean
internal

Private _priority

_priority: number
internal

Private _remoteCandidateId

_remoteCandidateId: string
internal

Private _requestsSent

_requestsSent: number
internal

Private _responsesReceived

_responsesReceived: number
internal

Private _state

_state: CandidatePairState
internal

Private _totalRoundTripTime

_totalRoundTripTime: number
internal

Private _transportId

_transportId: string
internal

Methods

Protected deserializeProperties

  • deserializeProperties(key: string, valueJson: string): void
  • Deserializes the properties.

    Parameters

    • key: string

      The key.

    • valueJson: string

      The value in JSON format.

    Returns void

getBytesReceived

  • getBytesReceived(): number
  • Gets the number of bytes received.

    Returns number

getBytesSent

  • getBytesSent(): number
  • Gets the number of bytes sent.

    Returns number

getConsentRequestsReceived

  • getConsentRequestsReceived(): number
  • Gets the number of consent requests received.

    Returns number

getConsentRequestsSent

  • getConsentRequestsSent(): number
  • Gets the number of consent requests sent.

    Returns number

getConsentResponsesReceived

  • getConsentResponsesReceived(): number
  • Gets the number of consent responses received.

    Returns number

getConsentResponsesSent

  • getConsentResponsesSent(): number
  • Gets the number of consent responses sent.

    Returns number

getCurrentRoundTripTime

  • getCurrentRoundTripTime(): number
  • Gets the current round trip time in milliseconds.

    Returns number

getId

  • getId(): string
  • Gets the identifier of the object generating these stats.

    Returns string

getLocalCandidateId

  • getLocalCandidateId(): string
  • Gets the local candidate identifier.

    Returns string

getNominated

  • getNominated(): boolean
  • Gets whether the candidate pair is nominated.

    Returns boolean

getPriority

  • getPriority(): number
  • Gets the priority.

    Returns number

getRemoteCandidateId

  • getRemoteCandidateId(): string
  • Gets the remote candidate identifier.

    Returns string

getRequestsSent

  • getRequestsSent(): number
  • Gets the number of requests sent.

    Returns number

getResponsesReceived

  • getResponsesReceived(): number
  • Gets the number of responses received.

    Returns number

getState

  • getState(): CandidatePairState
  • Gets the state.

    Returns CandidatePairState

getTimestamp

  • getTimestamp(): DateTime
  • Gets the timestamp when these stats were generated.

    Returns DateTime

getTotalRoundTripTime

  • getTotalRoundTripTime(): number
  • Gets the total round trip time in milliseconds.

    Returns number

getTransportId

  • getTransportId(): string
  • Gets the transport identifier.

    Returns string

getTypeString

  • getTypeString(): string

Protected serializeProperties

  • serializeProperties(jsonObject: Hash<string, string>): void
  • Serializes the properties.

    Parameters

    • jsonObject: Hash<string, string>

      The JSON object.

    Returns void

setBytesReceived

  • setBytesReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setBytesSent

  • setBytesSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setConsentRequestsReceived

  • setConsentRequestsReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setConsentRequestsSent

  • setConsentRequestsSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setConsentResponsesReceived

  • setConsentResponsesReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setConsentResponsesSent

  • setConsentResponsesSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setCurrentRoundTripTime

  • setCurrentRoundTripTime(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setLocalCandidateId

  • setLocalCandidateId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setNominated

  • setNominated(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setPriority

  • setPriority(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setRemoteCandidateId

  • setRemoteCandidateId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setRequestsSent

  • setRequestsSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setResponsesReceived

  • setResponsesReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setState

  • setState(value: CandidatePairState): void
  • internal

    Parameters

    • value: CandidatePairState

    Returns void

setTimestamp

  • setTimestamp(value: DateTime): void
  • internal

    Parameters

    • value: DateTime

    Returns void

setTotalRoundTripTime

  • setTotalRoundTripTime(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setTransportId

  • setTransportId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private stateFromString

  • stateFromString(stateString: string): CandidatePairState
  • internal

    Parameters

    • stateString: string

    Returns CandidatePairState

Private stateToString

  • stateToString(state: CandidatePairState): string
  • internal

    Parameters

    • state: CandidatePairState

    Returns string

toJson

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

    Returns string

Static fromJson

  • fromJson(candidatePairJson: string): CandidatePairStats
  • Derializes candidate pair stats from JSON.

    Parameters

    • candidatePairJson: string

      The candidate pair's stats JSON.

    Returns CandidatePairStats

Static fromJsonArray

  • fromJsonArray(candidatePairsJson: string): CandidatePairStats[]
  • Derializes an array of candidate pair stats from JSON.

    Parameters

    • candidatePairsJson: string

      The candidate pairs' stats JSON.

    Returns CandidatePairStats[]

Static toJson

  • toJson(candidatePair: CandidatePairStats): string
  • Serializes candidate pair stats to JSON.

    Parameters

    • candidatePair: CandidatePairStats

      The candidate pair's stats.

    Returns string

Static toJsonArray

  • toJsonArray(candidatePairs: CandidatePairStats[]): string
  • Serializes an array of candidate pair stats to JSON.

    Parameters

    • candidatePairs: CandidatePairStats[]

      The candidate pairs' stats.

    Returns string