Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConnectionStats

Connection stats.

Hierarchy

  • BaseStats
    • ConnectionStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _dataStream

_dataStream: DataStreamStats
internal

Private _mediaStreams

_mediaStreams: MediaStreamStats[]
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

getAudioStream

  • getAudioStream(): MediaStreamStats
  • Gets the first audio stream's stats.

    Returns MediaStreamStats

getAudioStreams

  • getAudioStreams(): MediaStreamStats[]
  • Gets the audio streams' stats.

    Returns MediaStreamStats[]

getDataStream

  • getDataStream(): DataStreamStats
  • Gets the data stream's stats.

    Returns DataStreamStats

getId

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

    Returns string

getIsHost

  • getIsHost(): boolean
  • Gets whether any of the streams are using a transport whose active candidate pair has a host candidate.

    Returns boolean

getIsReflexive

  • getIsReflexive(): boolean
  • Gets whether any of the streams are using a transport whose active candidate pair has a reflexive candidate.

    Returns boolean

getIsRelayed

  • getIsRelayed(): boolean
  • Gets whether any of the streams are using a transport whose active candidate pair has a relayed candidate.

    Returns boolean

getMediaStream

  • getMediaStream(mediaStreamId: string): MediaStreamStats
  • getMediaStream(): MediaStreamStats
  • Gets a media stream by its identifier.

    Parameters

    • mediaStreamId: string

      The media stream identifier.

    Returns MediaStreamStats

  • Gets the first media stream's stats.

    Returns MediaStreamStats

getMediaStreams

  • getMediaStreams(): MediaStreamStats[]
  • Gets the media streams' stats.

    Returns MediaStreamStats[]

getStreams

  • getStreams(): StreamStats[]
  • Gets the streams' stats.

    Returns StreamStats[]

getTimestamp

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

    Returns DateTime

getTypeString

  • getTypeString(): string

getVideoStream

  • getVideoStream(): MediaStreamStats
  • Gets the first video stream's stats.

    Returns MediaStreamStats

getVideoStreams

  • getVideoStreams(): MediaStreamStats[]
  • Gets the video streams' stats.

    Returns MediaStreamStats[]

Protected serializeProperties

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

    Parameters

    • jsonObject: Hash<string, string>

      The JSON object.

    Returns void

setDataStream

  • setDataStream(value: DataStreamStats): void
  • internal

    Parameters

    • value: DataStreamStats

    Returns void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setMediaStreams

  • setMediaStreams(value: MediaStreamStats[]): void
  • internal

    Parameters

    • value: MediaStreamStats[]

    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(connectionJson: string): ConnectionStats
  • Derializes connection stats from JSON.

    Parameters

    • connectionJson: string

      The connection's stats JSON.

    Returns ConnectionStats

Static toJson

  • toJson(connection: ConnectionStats): string
  • Serializes connection stats to JSON.

    Parameters

    • connection: ConnectionStats

      The connection's stats.

    Returns string