Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaStats

Media stats.

Hierarchy

  • BaseStats
    • MediaStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _tracks

_tracks: MediaTrackStats[]
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

getTimestamp

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

    Returns DateTime

getTrack

  • getTrack(): MediaTrackStats
  • getTrack(trackId: string): MediaTrackStats
  • Gets the first track's stats.

    Returns MediaTrackStats

  • Gets a track by its identifier.

    Parameters

    • trackId: string

      The track identifier.

    Returns MediaTrackStats

getTracks

  • getTracks(): MediaTrackStats[]
  • Gets the tracks' stats.

    Returns MediaTrackStats[]

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

setTracks

  • setTracks(value: MediaTrackStats[]): void
  • internal

    Parameters

    • value: MediaTrackStats[]

    Returns void

toJson

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

    Returns string

Static fromJson

  • fromJson(mediaJson: string): MediaStats
  • Derializes media stats from JSON.

    Parameters

    • mediaJson: string

      The media's stats JSON.

    Returns MediaStats

Static toJson

  • toJson(media: MediaStats): string
  • Serializes media stats to JSON.

    Parameters

    • media: MediaStats

      The media's stats.

    Returns string