Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataStreamStats

Data stream stats.

Hierarchy

  • StreamStats
    • DataStreamStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _dataChannels

_dataChannels: DataChannelStats[]
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

getDataChannel

  • getDataChannel(): DataChannelStats
  • getDataChannel(dataChannelId: string): DataChannelStats
  • Gets the first data channel's stats.

    Returns DataChannelStats

  • Gets a data channel by its identifier.

    Parameters

    • dataChannelId: string

      The data channel identifier.

    Returns DataChannelStats

getDataChannels

  • getDataChannels(): DataChannelStats[]
  • Gets the data channels' stats.

    Returns DataChannelStats[]

getId

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

    Returns string

getIsHost

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

    Returns boolean

getIsReflexive

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

    Returns boolean

getIsRelayed

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

    Returns boolean

getTimestamp

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

    Returns DateTime

getTransport

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

    Returns TransportStats

getType

  • getType(): StreamType
  • Gets the type.

    Returns StreamType

getTypeString

  • getTypeString(): string

Protected serializeProperties

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

    Parameters

    • jsonObject: Hash<string, string>

      The JSON object.

    Returns void

setDataChannels

  • setDataChannels(value: DataChannelStats[]): void
  • internal

    Parameters

    • value: DataChannelStats[]

    Returns void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTimestamp

  • setTimestamp(value: DateTime): void
  • internal

    Parameters

    • value: DateTime

    Returns void

setTransport

  • setTransport(value: TransportStats): void
  • internal

    Parameters

    • value: TransportStats

    Returns void

setType

  • setType(value: StreamType): void
  • internal

    Parameters

    • value: StreamType

    Returns void

toJson

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

    Returns string

Static fromJson

  • fromJson(dataStreamJson: string): DataStreamStats
  • Derializes data stream stats from JSON.

    Parameters

    • dataStreamJson: string

      The data stream's stats JSON.

    Returns DataStreamStats

Static toJson

  • toJson(dataStream: DataStreamStats): string
  • Serializes data stream stats to JSON.

    Parameters

    • dataStream: DataStreamStats

      The data stream's stats.

    Returns string