ClientMetricReport | amazon-chime-sdk-js

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

Hierarchy

ClientMetricReport

Index

Constructors

constructor

Properties

Constructors

constructor

new ClientMetricReport(logger: Logger, videoStreamIndex?: VideoStreamIndex, selfAttendeeId?: string): ClientMetricReport

- Defined in src/clientmetricreport/ClientMetricReport.ts:30
Parameters
- logger: Logger
- Optional videoStreamIndex: VideoStreamIndex
- Optional selfAttendeeId: string
Returns ClientMetricReport

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

[id: string]: { dir?: ClientMetricReportDirection; media?: ClientMetricReportMediaType; source: string }
- Optional dir?: ClientMetricReportDirection
- Optional media?: ClientMetricReportMediaType
- source: string

Readonly observableVideoMetricSpec

observableVideoMetricSpec: {} = ...

media Stream metrics

Type declaration

[id: string]: { dir?: ClientMetricReportDirection; media?: ClientMetricReportMediaType; source: string }
- Optional dir?: ClientMetricReportDirection
- Optional media?: ClientMetricReportMediaType
- source: string

previousTimestampMs

previousTimestampMs: number = 0

rtcStatsReport

rtcStatsReport: RTCStatsReport = ...

Readonly streamDimensionMap

streamDimensionMap: {} = ...

Dimensions derived from metric

Type declaration

[id: string]: SdkStreamDimension.Type

streamMetricReports

streamMetricReports: {} = {}

Type declaration

[id: number]: StreamMetricReport

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:154
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

averageTimeSpentPerSecondInMilliseconds

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:137
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

bitsPerSecond

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:114
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

clone

clone(): ClientMetricReport

- Defined in src/clientmetricreport/ClientMetricReport.ts:835
Clones the ClientMetricReport and returns it.

Returns ClientMetricReport

countPerSecond

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:97
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

decoderLossPercent

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:47
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

getMetricMap

getMetricMap(mediaType?: ClientMetricReportMediaType, direction?: ClientMetricReportDirection): {}

- Defined in src/clientmetricreport/ClientMetricReport.ts:453
Parameters
- Optional mediaType: ClientMetricReportMediaType
- Optional direction: ClientMetricReportDirection
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

- Defined in src/clientmetricreport/ClientMetricReport.ts:700
Returns the value of the specific metric in observableMetricSpec.

Parameters
- metricName: string
Returns number

getObservableMetrics

getObservableMetrics(): {}

- Defined in src/clientmetricreport/ClientMetricReport.ts:763
Returns the value of metrics in observableMetricSpec.

Returns {}
- [id: string]: number

getObservableVideoMetricValue

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:730
Returns the value of the specific metric in observableVideoMetricSpec.

Parameters
- metricName: string
- ssrcNum: number
Returns number

getObservableVideoMetrics

getObservableVideoMetrics(): {}

- Defined in src/clientmetricreport/ClientMetricReport.ts:774
Returns the value of metrics in observableVideoMetricSpec for each SSRC.

Returns {}
- [id: string]: {}
  - [id: string]: {}

getRTCStatsReport

getRTCStatsReport(): RTCStatsReport

- Defined in src/clientmetricreport/ClientMetricReport.ts:828
Returns the raw RTCStatsReport from RTCPeerConnection.getStats() API.

Returns RTCStatsReport

getStreamDimensionMap

getStreamDimensionMap(): {}

- Defined in src/clientmetricreport/ClientMetricReport.ts:493
Returns {}
- [id: string]: SdkStreamDimension.Type

getVideoUpstreamSsrc

getVideoUpstreamSsrc(): number

- Defined in src/clientmetricreport/ClientMetricReport.ts:748
Get ssrc of upstream video stream

Returns number

ssrc of video upstream stream if it exists, otherwise null

identityValue

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:42
Metric transform functions

Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

isHardwareImplementation

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:193
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

jitterBufferMs

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:80
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

overrideObservableMetric

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:876
Overrides a specific observable metric value (e.g. with one that didn't come from the WebRTC report)

Parameters
- name: string
- value: number
Returns void

packetLossPercent

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:65
Parameters
- Optional sourceMetricName: string
- Optional ssrc: number
Returns number

print

print(): void

- Defined in src/clientmetricreport/ClientMetricReport.ts:850
Prints out the globalMetricReport, streamMetricReports and the corresponding timestamps from the current ClientMetricReport.

Returns void

removeDestroyedSsrcs

removeDestroyedSsrcs(): void

- Defined in src/clientmetricreport/ClientMetricReport.ts:865
Removes the SSRCs that are no longer valid.

Returns void

secondsToMilliseconds

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

- Defined in src/clientmetricreport/ClientMetricReport.ts:132
Parameters
- Optional metricName: string
- Optional ssrc: number
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

logger: Logger

Optional videoStreamIndex: VideoStreamIndex

Optional selfAttendeeId: string

Returns ClientMetricReport

Properties

Readonly 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

Parameters

Optional metricName: string

Optional ssrc: number

Returns number

Optional type?: SdkMetric.Type

Readonly 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

Parameters

Optional metricName: string

Optional ssrc: number

Returns number

Optional type?: SdkMetric.Type

currentSsrcs

Type declaration

[id: number]: number

currentTimestampMs

customStatsReports

Readonly globalMetricMap

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

Parameters

Optional metricName: string

Optional ssrc: number

Returns number

Optional type?: SdkMetric.Type

globalMetricReport

Readonly observableMetricSpec

Type declaration

[id: string]: { dir?: ClientMetricReportDirection; media?: ClientMetricReportMediaType; source: string }

Optional dir?: ClientMetricReportDirection

Optional media?: ClientMetricReportMediaType

source: string

Readonly observableVideoMetricSpec

Type declaration

[id: string]: { dir?: ClientMetricReportDirection; media?: ClientMetricReportMediaType; source: string }

Optional dir?: ClientMetricReportDirection

Optional media?: ClientMetricReportMediaType

source: string

previousTimestampMs

rtcStatsReport

Readonly streamDimensionMap

Type declaration

[id: string]: SdkStreamDimension.Type

streamMetricReports

Type declaration

[id: number]: StreamMetricReport

Readonly 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

Parameters

Optional metricName: string

Optional ssrc: number

Returns number

Optional type?: SdkMetric.Type

Readonly videoUpstreamMetricMap