Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaTrackStats

Media track stats.

Hierarchy

  • BaseStats
    • MediaTrackStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _detached

_detached: boolean
internal

Private _frameHeight

_frameHeight: number
internal

Private _frameRate

_frameRate: number
internal

Private _frameWidth

_frameWidth: number
internal

Private _framesCorrupted

_framesCorrupted: number
internal

Private _framesDecoded

_framesDecoded: number
internal

Private _framesDropped

_framesDropped: number
internal

Private _framesEncoded

_framesEncoded: number
internal

Private _framesReceived

_framesReceived: number
internal

Private _framesSent

_framesSent: number
internal

Private _stopped

_stopped: boolean
internal

Private _synchronizationSources

_synchronizationSources: 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

getDetached

  • getDetached(): boolean
  • Gets whether the track is detached.

    Returns boolean

getFrameHeight

  • getFrameHeight(): number
  • Gets the frame height. Video-only. Set by encoder or decoder.

    Returns number

getFrameRate

  • getFrameRate(): number
  • Gets the frame rate. Video-only. Set by encoder or decoder.

    Returns number

getFrameWidth

  • getFrameWidth(): number
  • Gets the frame width. Video-only. Set by encoder or decoder.

    Returns number

getFramesCorrupted

  • getFramesCorrupted(): number
  • Gets the number of corrupted frames. Video-only. Set by depacketizer.

    Returns number

getFramesDecoded

  • getFramesDecoded(): number
  • Gets the number of frames decoded. Set by decoder.

    Returns number

getFramesDropped

  • getFramesDropped(): number
  • Gets the number of frames dropped. Video-only. Set by depacketizer.

    Returns number

getFramesEncoded

  • getFramesEncoded(): number
  • Gets the number of frames encoded. Set by encoded.

    Returns number

getFramesReceived

  • getFramesReceived(): number
  • Gets the number of frames received. Set by depacketizer.

    Returns number

getFramesSent

  • getFramesSent(): number
  • Gets the number of frames sent. Set by packetizer.

    Returns number

getId

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

    Returns string

getStopped

  • getStopped(): boolean
  • Gets whether the track is stopped. Set by source.

    Returns boolean

getSynchronizationSource

  • getSynchronizationSource(): number
  • Gets the first synchronization source.

    Returns number

getSynchronizationSources

  • getSynchronizationSources(): number[]
  • Gets the synchronization sources.

    Returns number[]

getTimestamp

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

    Returns DateTime

getTypeString

  • getTypeString(): string

Protected serializeProperties

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

    Parameters

    • jsonObject: Hash<string, string>

      The JSON object.

    Returns void

setDetached

  • setDetached(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setFrameHeight

  • setFrameHeight(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFrameRate

  • setFrameRate(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFrameWidth

  • setFrameWidth(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFramesCorrupted

  • setFramesCorrupted(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFramesDecoded

  • setFramesDecoded(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFramesDropped

  • setFramesDropped(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFramesEncoded

  • setFramesEncoded(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFramesReceived

  • setFramesReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFramesSent

  • setFramesSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setStopped

  • setStopped(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setSynchronizationSources

  • setSynchronizationSources(value: number[]): void
  • internal

    Parameters

    • value: number[]

    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(mediaTrackJson: string): MediaTrackStats
  • Derializes media track stats from JSON.

    Parameters

    • mediaTrackJson: string

      The media track's stats JSON.

    Returns MediaTrackStats

Static fromJsonArray

  • fromJsonArray(mediaTracksJson: string): MediaTrackStats[]
  • Derializes an array of media track stats from JSON.

    Parameters

    • mediaTracksJson: string

      The media tracks' stats JSON.

    Returns MediaTrackStats[]

Static toJson

  • toJson(mediaTrack: MediaTrackStats): string
  • Serializes media track stats to JSON.

    Parameters

    • mediaTrack: MediaTrackStats

      The media track's stats.

    Returns string

Static toJsonArray

  • toJsonArray(mediaTracks: MediaTrackStats[]): string
  • Serializes an array of media track stats to JSON.

    Parameters

    • mediaTracks: MediaTrackStats[]

      The media tracks' stats.

    Returns string