Class ClientMetricReport

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

Constructors

constructor

new ClientMetricReport(
    logger: Logger,
    videoStreamIndex?: VideoStreamIndex,
    selfAttendeeId?: string,
): ClientMetricReport
Parameters
- logger: Logger
- OptionalvideoStreamIndex: VideoStreamIndex
- OptionalselfAttendeeId: string
Returns ClientMetricReport
- Defined in src/clientmetricreport/ClientMetricReport.ts:32

Properties

`Readonly`audioDownstreamMetricMap

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

`Readonly`audioUpstreamMetricMap

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

currentSsrcs

currentSsrcs: { [id: number]: number } = {}

currentTimestampMs

currentTimestampMs: number = 0

customStatsReports

customStatsReports: any[] = []

`Readonly`globalMetricMap

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

Canonical and derived metric maps

globalMetricReport

globalMetricReport: GlobalMetricReport = ...

`Readonly`observableMetricSpec

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

Observable metrics and related APIs

`Readonly`observableVideoMetricSpec

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

media Stream metrics

previousTimestampMs

previousTimestampMs: number = 0

rtcStatsReport

rtcStatsReport: RTCStatsReport = ...

`Readonly`streamDimensionMap

streamDimensionMap: { [id: string]: Type } = ...

Dimensions derived from metric

streamMetricReports

streamMetricReports: { [id: number]: StreamMetricReport } = {}

`Readonly`videoDownstreamMetricMap

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

`Readonly`videoUpstreamMetricMap

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

Methods

averageCpuQualityLimitationDurationPerSecondInMilliseconds

averageCpuQualityLimitationDurationPerSecondInMilliseconds(
metricName?: string,
ssrc?: number,
): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:154

averageTimeSpentPerSecondInMilliseconds

averageTimeSpentPerSecondInMilliseconds(
metricName?: string,
ssrc?: number,
): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:137

bitsPerSecond

bitsPerSecond(metricName?: string, ssrc?: number): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:114

clone

clone(): ClientMetricReport
Clones the ClientMetricReport and returns it.

Returns ClientMetricReport
- Defined in src/clientmetricreport/ClientMetricReport.ts:873

countPerSecond

countPerSecond(metricName?: string, ssrc?: number): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:97

decoderLossPercent

decoderLossPercent(metricName?: string, ssrc?: number): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:47

getMetricMap

getMetricMap(
    mediaType?: ClientMetricReportMediaType,
    direction?: ClientMetricReportDirection,
): {
    [id: string]: {
        source?: string;
        transform?: (metricName?: string, ssrc?: number) => number;
        type?: Type;
    };
}
Parameters
- OptionalmediaType: ClientMetricReportMediaType
- Optionaldirection: ClientMetricReportDirection
Returns {
    [id: string]: {
        source?: string;
        transform?: (metricName?: string, ssrc?: number) => number;
        type?: Type;
    };
}
- Defined in src/clientmetricreport/ClientMetricReport.ts:490

getObservableMetrics

getObservableMetrics(): { [id: string]: number }
Returns the value of metrics in observableMetricSpec.

Returns { [id: string]: number }
- Defined in src/clientmetricreport/ClientMetricReport.ts:801

getObservableMetricValue

getObservableMetricValue(metricName: string): number
Returns the value of the specific metric in observableMetricSpec.
Parameters
- metricName: string
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:737

getObservableVideoMetrics

getObservableVideoMetrics(): { [id: string]: { [id: string]: {} } }
Returns the value of metrics in observableVideoMetricSpec for each SSRC.

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

getObservableVideoMetricValue

getObservableVideoMetricValue(metricName: string, ssrcNum: number): number
Returns the value of the specific metric in observableVideoMetricSpec.
Parameters
- metricName: string
- ssrcNum: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:767

getRTCStatsReport

getRTCStatsReport(): RTCStatsReport
Returns the raw RTCStatsReport from RTCPeerConnection.getStats() API.

Returns RTCStatsReport
- Defined in src/clientmetricreport/ClientMetricReport.ts:866

getStreamDimensionMap

getStreamDimensionMap(): { [id: string]: Type }
Returns { [id: string]: Type }
- Defined in src/clientmetricreport/ClientMetricReport.ts:530

getVideoUpstreamSsrcs

getVideoUpstreamSsrcs(): number[]
Get ssrcs of upstream video streams

Returns number[]
ssrcs of video upstream streams
- Defined in src/clientmetricreport/ClientMetricReport.ts:785

identityValue

identityValue(metricName?: string, ssrc?: number): number
Metric transform functions
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:42

isHardwareImplementation

isHardwareImplementation(metricName?: string, ssrc?: number): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:193

jitterBufferMs

jitterBufferMs(metricName?: string, ssrc?: number): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:80

overrideObservableMetric

overrideObservableMetric(name: string, value: number): void
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
- Defined in src/clientmetricreport/ClientMetricReport.ts:914

packetLossPercent

packetLossPercent(sourceMetricName?: string, ssrc?: number): number
Parameters
- OptionalsourceMetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:65

print

print(): void
Prints out the globalMetricReport, streamMetricReports and the corresponding timestamps from the current ClientMetricReport.

Returns void
- Defined in src/clientmetricreport/ClientMetricReport.ts:888

removeDestroyedSsrcs

removeDestroyedSsrcs(): void
Removes the SSRCs that are no longer valid.

Returns void
- Defined in src/clientmetricreport/ClientMetricReport.ts:903

secondsToMilliseconds

secondsToMilliseconds(metricName?: string, ssrc?: number): number
Parameters
- OptionalmetricName: string
- Optionalssrc: number
Returns number
- Defined in src/clientmetricreport/ClientMetricReport.ts:132

Class ClientMetricReport

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ClientMetricReport

Properties

ReadonlyaudioDownstreamMetricMap

ReadonlyaudioUpstreamMetricMap

currentSsrcs

currentTimestampMs

customStatsReports

ReadonlyglobalMetricMap

globalMetricReport

ReadonlyobservableMetricSpec

ReadonlyobservableVideoMetricSpec

previousTimestampMs

rtcStatsReport

ReadonlystreamDimensionMap

streamMetricReports

ReadonlyvideoDownstreamMetricMap

ReadonlyvideoUpstreamMetricMap

Methods

averageCpuQualityLimitationDurationPerSecondInMilliseconds

Parameters

Returns number

averageTimeSpentPerSecondInMilliseconds

Parameters

Returns number

bitsPerSecond

Parameters

Returns number

clone

Returns ClientMetricReport

countPerSecond

Parameters

Returns number

decoderLossPercent

Parameters

Returns number

getMetricMap

Parameters

Returns { [id: string]: { source?: string; transform?: (metricName?: string, ssrc?: number) => number; type?: Type; };}

getObservableMetrics

Returns { [id: string]: number }

getObservableMetricValue

Parameters

Returns number

getObservableVideoMetrics

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

getObservableVideoMetricValue

Parameters

Returns number

getRTCStatsReport

Returns RTCStatsReport

getStreamDimensionMap

Returns { [id: string]: Type }

getVideoUpstreamSsrcs

Returns number[]

identityValue

Parameters

Returns number

isHardwareImplementation

Parameters

Returns number

jitterBufferMs

Parameters

Returns number

overrideObservableMetric

Parameters

Returns void

packetLossPercent

Parameters

Returns number

print

Returns void

removeDestroyedSsrcs

`Readonly`audioDownstreamMetricMap

`Readonly`audioUpstreamMetricMap

`Readonly`globalMetricMap

`Readonly`observableMetricSpec

`Readonly`observableVideoMetricSpec

`Readonly`streamDimensionMap

`Readonly`videoDownstreamMetricMap

`Readonly`videoUpstreamMetricMap

Returns {
[id: string]: {
source?: string;
transform?: (metricName?: string, ssrc?: number) => number;
type?: Type;
};
}