Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientMetricReport

ClientMetricReport gets the media metrics used by ConnectionMonitor to update connection health data.

Hierarchy

  • ClientMetricReport

Index

Constructors

constructor

Properties

Readonly audioDownstreamMetricMap

audioDownstreamMetricMap: {} = ...

Type declaration

  • [id: string]: { source?: string; transform?: (metricName?: string, ssrc?: number) => number; type?: SdkMetric.Type }
    • Optional source?: string
    • Optional transform?: (metricName?: string, ssrc?: number) => number
        • (metricName?: string, ssrc?: number): number
        • Parameters

          • Optional metricName: string
          • Optional ssrc: number

          Returns number

    • Optional type?: SdkMetric.Type

Readonly audioUpstreamMetricMap

audioUpstreamMetricMap: {} = ...

Type declaration

  • [id: string]: { source?: string; transform?: (metricName?: string, ssrc?: number) => number; type?: SdkMetric.Type }
    • Optional source?: string
    • Optional transform?: (metricName?: string, ssrc?: number) => number
        • (metricName?: string, ssrc?: number): number
        • Parameters

          • Optional metricName: string
          • Optional ssrc: number

          Returns number

    • Optional type?: SdkMetric.Type

currentSsrcs

currentSsrcs: {} = {}

Type declaration

  • [id: number]: number

currentTimestampMs

currentTimestampMs: number = 0

customStatsReports

customStatsReports: any[] = []

Readonly globalMetricMap

globalMetricMap: {} = ...

Canonical and derived metric maps

Type declaration

  • [id: string]: { source?: string; transform?: (metricName?: string, ssrc?: number) => number; type?: SdkMetric.Type }
    • Optional source?: string
    • Optional transform?: (metricName?: string, ssrc?: number) => number
        • (metricName?: string, ssrc?: number): number
        • Parameters

          • Optional metricName: string
          • Optional ssrc: number

          Returns number

    • Optional type?: SdkMetric.Type

globalMetricReport

globalMetricReport: GlobalMetricReport = ...

Readonly observableMetricSpec

observableMetricSpec: {} = ...

Observable metrics and related APIs

Type declaration

Readonly observableVideoMetricSpec

observableVideoMetricSpec: {} = ...

media Stream metrics

Type declaration

previousTimestampMs

previousTimestampMs: number = 0

rtcStatsReport

rtcStatsReport: RTCStatsReport = ...

Readonly streamDimensionMap

streamDimensionMap: {} = ...

Dimensions derived from metric

Type declaration

  • [id: string]: SdkStreamDimension.Type

streamMetricReports

streamMetricReports: {} = {}

Type declaration

Readonly videoDownstreamMetricMap

videoDownstreamMetricMap: {} = ...

Type declaration

  • [id: string]: { source?: string; transform?: (metricName?: string, ssrc?: number) => number; type?: SdkMetric.Type }
    • Optional source?: string
    • Optional transform?: (metricName?: string, ssrc?: number) => number
        • (metricName?: string, ssrc?: number): number
        • Parameters

          • Optional metricName: string
          • Optional ssrc: number

          Returns number

    • Optional type?: SdkMetric.Type

Readonly videoUpstreamMetricMap

videoUpstreamMetricMap: {} = ...

Type declaration

  • [id: string]: { source?: string; transform?: (metricName?: string, ssrc?: number) => number; type?: SdkMetric.Type }
    • Optional source?: string
    • Optional transform?: (metricName?: string, ssrc?: number) => number
        • (metricName?: string, ssrc?: number): number
        • Parameters

          • Optional metricName: string
          • Optional ssrc: number

          Returns number

    • Optional type?: SdkMetric.Type

Methods

averageCpuQualityLimitationDurationPerSecondInMilliseconds

  • averageCpuQualityLimitationDurationPerSecondInMilliseconds(metricName?: string, ssrc?: number): number

averageTimeSpentPerSecondInMilliseconds

  • averageTimeSpentPerSecondInMilliseconds(metricName?: string, ssrc?: number): number

bitsPerSecond

  • bitsPerSecond(metricName?: string, ssrc?: number): number

clone

countPerSecond

  • countPerSecond(metricName?: string, ssrc?: number): number

decoderLossPercent

  • decoderLossPercent(metricName?: string, ssrc?: number): number

getMetricMap

  • Parameters

    Returns {}

    • [id: string]: { source?: string; transform?: (metricName?: string, ssrc?: number) => number; type?: SdkMetric.Type }
      • Optional source?: string
      • Optional transform?: (metricName?: string, ssrc?: number) => number
          • (metricName?: string, ssrc?: number): number
          • Parameters

            • Optional metricName: string
            • Optional ssrc: number

            Returns number

      • Optional type?: SdkMetric.Type

getObservableMetricValue

  • getObservableMetricValue(metricName: string): number

getObservableMetrics

  • getObservableMetrics(): {}

getObservableVideoMetricValue

  • getObservableVideoMetricValue(metricName: string, ssrcNum: number): number

getObservableVideoMetrics

  • getObservableVideoMetrics(): {}

getRTCStatsReport

  • getRTCStatsReport(): RTCStatsReport

getStreamDimensionMap

  • getStreamDimensionMap(): {}

identityValue

  • identityValue(metricName?: string, ssrc?: number): number

isHardwareImplementation

  • isHardwareImplementation(metricName?: string, ssrc?: number): number

jitterBufferMs

  • jitterBufferMs(metricName?: string, ssrc?: number): number

overrideObservableMetric

  • overrideObservableMetric(name: string, value: number): void

packetLossPercent

  • packetLossPercent(sourceMetricName?: string, ssrc?: number): number

print

  • print(): void

removeDestroyedSsrcs

  • removeDestroyedSsrcs(): void

secondsToMilliseconds

  • secondsToMilliseconds(metricName?: string, ssrc?: number): number

Generated using TypeDoc