Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaStreamStats

Media stream stats.

Hierarchy

  • StreamStats
    • MediaStreamStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _direction

_direction: StreamDirection
internal

Private _receiver

_receiver: MediaReceiverStats
internal

Private _sender

_sender: MediaSenderStats
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

getDirection

  • getDirection(): StreamDirection
  • Gets the direction.

    Returns StreamDirection

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

getReceiver

  • getReceiver(): MediaReceiverStats
  • Gets the receiver's stats.

    Returns MediaReceiverStats

getSender

  • getSender(): MediaSenderStats
  • Gets the sender's stats.

    Returns MediaSenderStats

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

setDirection

  • setDirection(value: StreamDirection): void
  • internal

    Parameters

    • value: StreamDirection

    Returns void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setReceiver

  • setReceiver(value: MediaReceiverStats): void
  • internal

    Parameters

    • value: MediaReceiverStats

    Returns void

setSender

  • setSender(value: MediaSenderStats): void
  • internal

    Parameters

    • value: MediaSenderStats

    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(mediaStreamJson: string): MediaStreamStats
  • Derializes media stream stats from JSON.

    Parameters

    • mediaStreamJson: string

      The media stream's stats JSON.

    Returns MediaStreamStats

Static fromJsonArray

  • fromJsonArray(mediaStreamsJson: string): MediaStreamStats[]
  • Derializes an array of media stream stats from JSON.

    Parameters

    • mediaStreamsJson: string

      The media streams' stats JSON.

    Returns MediaStreamStats[]

Static toJson

  • toJson(mediaStream: MediaStreamStats): string
  • Serializes media stream stats to JSON.

    Parameters

    • mediaStream: MediaStreamStats

      The media stream's stats.

    Returns string

Static toJsonArray

  • toJsonArray(mediaStreams: MediaStreamStats[]): string
  • Serializes an array of media stream stats to JSON.

    Parameters

    • mediaStreams: MediaStreamStats[]

      The media streams' stats.

    Returns string