Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaSenderStats

Media sender stats.

Hierarchy

  • MediaComponentStats
    • MediaSenderStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _bytesSent

_bytesSent: number
internal

Private _packetsSent

_packetsSent: number
internal

Private _roundTripTime

_roundTripTime: number
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

getBytesSent

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

    Returns number

getCodec

  • getCodec(): CodecStats
  • Gets the codec stats.

    Returns CodecStats

getFirCount

  • getFirCount(): number

getId

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

    Returns string

getNackCount

  • getNackCount(): number

getPacketsSent

  • getPacketsSent(): number
  • Gets the number of packets sent.

    Returns number

getPliCount

  • getPliCount(): number

getRoundTripTime

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

    Returns number

getSliCount

  • getSliCount(): number

getSynchronizationSource

  • getSynchronizationSource(): number

getTimestamp

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

    Returns DateTime

getTrack

  • getTrack(): MediaTrackStats
  • Gets the track's stats.

    Returns MediaTrackStats

getTypeString

  • getTypeString(): string

Protected serializeProperties

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

    Parameters

    • jsonObject: Hash<string, string>

      The JSON object.

    Returns void

setBytesSent

  • setBytesSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setCodec

  • setCodec(value: CodecStats): void
  • internal

    Parameters

    • value: CodecStats

    Returns void

setFirCount

  • setFirCount(value: number): void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setNackCount

  • setNackCount(value: number): void

setPacketsSent

  • setPacketsSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setPliCount

  • setPliCount(value: number): void

setRoundTripTime

  • setRoundTripTime(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setSliCount

  • setSliCount(value: number): void

setSynchronizationSource

  • setSynchronizationSource(value: number): void

setTimestamp

  • setTimestamp(value: DateTime): void
  • internal

    Parameters

    • value: DateTime

    Returns void

setTrack

  • setTrack(value: MediaTrackStats): void
  • internal

    Parameters

    • value: MediaTrackStats

    Returns void

toJson

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

    Returns string

Static fromJson

  • fromJson(mediaSenderJson: string): MediaSenderStats
  • Derializes media sender stats from JSON.

    Parameters

    • mediaSenderJson: string

      The media sender's stats JSON.

    Returns MediaSenderStats

Static toJson

  • toJson(mediaSender: MediaSenderStats): string
  • Serializes media sender stats to JSON.

    Parameters

    • mediaSender: MediaSenderStats

      The media sender's stats.

    Returns string