Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TransportStats

Transport stats.

Hierarchy

  • BaseStats
    • TransportStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _activeCandidatePair

_activeCandidatePair: CandidatePairStats
internal

Private _bytesReceived

_bytesReceived: number
internal

Private _bytesSent

_bytesSent: number
internal

Private _candidatePairs

_candidatePairs: CandidatePairStats[]
internal

Private _localCandidates

_localCandidates: CandidateStats[]
internal

Private _localCertificate

_localCertificate: CertificateStats
internal

Private _remoteCandidates

_remoteCandidates: CandidateStats[]
internal

Private _remoteCertificate

_remoteCertificate: CertificateStats
internal

Private _rtcpTransport

_rtcpTransport: TransportStats
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

getActiveCandidatePair

  • getActiveCandidatePair(): CandidatePairStats
  • Gets the active candidate pair's stats.

    Returns CandidatePairStats

getBytesReceived

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

    Returns number

getBytesSent

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

    Returns number

getCandidatePair

  • getCandidatePair(candidatePairId: string): CandidatePairStats
  • Gets a candidate pair by its identifier.

    Parameters

    • candidatePairId: string

      The candidate pair identifier.

    Returns CandidatePairStats

getCandidatePairs

  • getCandidatePairs(): CandidatePairStats[]
  • Gets the candidate pairs' stats.

    Returns CandidatePairStats[]

getId

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

    Returns string

getIsHost

  • getIsHost(): boolean
  • Gets whether the active candidate pair has a host candidate.

    Returns boolean

getIsReflexive

  • getIsReflexive(): boolean
  • Gets whether the active candidate pair has a reflexive candidate.

    Returns boolean

getIsRelayed

  • getIsRelayed(): boolean
  • Gets whether the active candidate pair has a relayed candidate.

    Returns boolean

getLocalCandidate

  • getLocalCandidate(candidateId: string): CandidateStats
  • Gets a local candidate by its identifier.

    Parameters

    • candidateId: string

      The candidate identifier.

    Returns CandidateStats

getLocalCandidates

  • getLocalCandidates(): CandidateStats[]
  • Gets the local candidates' stats.

    Returns CandidateStats[]

getLocalCertificate

  • getLocalCertificate(): CertificateStats
  • Gets the local certificate's stats.

    Returns CertificateStats

getRemoteCandidate

  • getRemoteCandidate(candidateId: string): CandidateStats
  • Gets a remote candidate by its identifier.

    Parameters

    • candidateId: string

      The candidate identifier.

    Returns CandidateStats

getRemoteCandidates

  • getRemoteCandidates(): CandidateStats[]
  • Gets the remote candidates' stats.

    Returns CandidateStats[]

getRemoteCertificate

  • getRemoteCertificate(): CertificateStats
  • Gets the remote certificate's stats.

    Returns CertificateStats

getRtcpTransport

  • getRtcpTransport(): TransportStats
  • Gets the RTCP transport's stats.

    Returns TransportStats

getTimestamp

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

    Returns DateTime

getTypeString

  • getTypeString(): string

Protected serializeProperties

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

    Parameters

    • jsonObject: Hash<string, string>

      The JSON object.

    Returns void

setActiveCandidatePair

  • setActiveCandidatePair(value: CandidatePairStats): void
  • internal

    Parameters

    • value: CandidatePairStats

    Returns void

setBytesReceived

  • setBytesReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setBytesSent

  • setBytesSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setCandidatePairs

  • setCandidatePairs(value: CandidatePairStats[]): void
  • internal

    Parameters

    • value: CandidatePairStats[]

    Returns void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setLocalCandidates

  • setLocalCandidates(value: CandidateStats[]): void
  • internal

    Parameters

    • value: CandidateStats[]

    Returns void

setLocalCertificate

  • setLocalCertificate(value: CertificateStats): void
  • internal

    Parameters

    • value: CertificateStats

    Returns void

setRemoteCandidates

  • setRemoteCandidates(value: CandidateStats[]): void
  • internal

    Parameters

    • value: CandidateStats[]

    Returns void

setRemoteCertificate

  • setRemoteCertificate(value: CertificateStats): void
  • internal

    Parameters

    • value: CertificateStats

    Returns void

setRtcpTransport

  • setRtcpTransport(value: TransportStats): void
  • internal

    Parameters

    • value: TransportStats

    Returns void

setTimestamp

  • setTimestamp(value: DateTime): void
  • internal

    Parameters

    • value: DateTime

    Returns void

toJson

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

    Returns string

Static fromJson

  • fromJson(transportJson: string): TransportStats
  • Derializes transport stats from JSON.

    Parameters

    • transportJson: string

      The transport's stats JSON.

    Returns TransportStats

Static toJson

  • toJson(transport: TransportStats): string
  • Serializes transport stats to JSON.

    Parameters

    • transport: TransportStats

      The transport's stats.

    Returns string