Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StreamStats

Stream stats.

Hierarchy

  • BaseStats
    • StreamStats

Index

Constructors

constructor

Properties

Private _transport

_transport: TransportStats
internal

Private _type

_type: StreamType
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

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

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

Private typeFromString

  • typeFromString(typeString: string): StreamType
  • internal

    Parameters

    • typeString: string

    Returns StreamType

Private typeToString

  • typeToString(type: StreamType): string
  • internal

    Parameters

    • type: StreamType

    Returns string