@textrp/briij-js-sdk 41.0.1 → 43.0.0

package/src/webrtc/stats/statsReport.ts

@@ -1,133 +1,133 @@
-/*
-Copyright 2023 The Matrix.org Foundation C.I.C.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-import { type ConnectionStatsBandwidth, type ConnectionStatsBitrate, type PacketLoss } from "./connectionStats.ts";
-import { type TransportStats } from "./transportStats.ts";
-import { type Resolution } from "./media/mediaTrackStats.ts";
-
-export enum StatsReport {
-    CONNECTION_STATS = "StatsReport.connection_stats",
-    CALL_FEED_REPORT = "StatsReport.call_feed_report",
-    BYTE_SENT_STATS = "StatsReport.byte_sent_stats",
-    SUMMARY_STATS = "StatsReport.summary_stats",
-}
-
-/// ByteSentStatsReport ################################################################################################
-export interface ByteSentStatsReport extends Map<TrackID, ByteSend> {
-    callId?: string;
-    opponentMemberId?: string;
-    // is a map: `local trackID` => byte send
-}
-
-export type TrackID = string;
-export type ByteSend = number;
-
-/// ConnectionStatsReport ##############################################################################################
-export interface ConnectionStatsReport {
-    callId?: string;
-    opponentMemberId?: string;
-    bandwidth: ConnectionStatsBandwidth;
-    bitrate: ConnectionStatsBitrate;
-    packetLoss: PacketLoss;
-    audioConcealment: Map<TrackID, AudioConcealment>;
-    totalAudioConcealment: AudioConcealment;
-    resolution: ResolutionMap;
-    framerate: FramerateMap;
-    codec: CodecMap;
-    jitter: Map<TrackID, number>;
-    transport: TransportStats[];
-}
-
-export interface AudioConcealment {
-    concealedAudio: number;
-    totalAudioDuration: number;
-}
-
-export interface ResolutionMap {
-    local: Map<TrackID, Resolution>;
-    remote: Map<TrackID, Resolution>;
-}
-
-export interface FramerateMap {
-    local: Map<TrackID, number>;
-    remote: Map<TrackID, number>;
-}
-
-export interface CodecMap {
-    local: Map<TrackID, string>;
-    remote: Map<TrackID, string>;
-}
-
-/// SummaryStatsReport #################################################################################################
-export interface SummaryStatsReport {
-    /**
-     * Aggregated the information for percentage of received media
-     *
-     * This measure whether the current user receive data from a call participants.
-     * As soon as a participant sends at least a byte media to this user, this counts as one measurement unit.
-     * The units of measure divided by the total number of participants is a value between 0 and 1.
-     */
-    percentageReceivedMedia: number;
-    percentageReceivedAudioMedia: number;
-    percentageReceivedVideoMedia: number;
-    maxJitter: number;
-    maxPacketLoss: number;
-    percentageConcealedAudio: number;
-    peerConnections: number;
-    opponentUsersInCall?: number;
-    opponentDevicesInCall?: number;
-    diffDevicesToPeerConnections?: number;
-    ratioPeerConnectionToDevices?: number;
-    // Todo: Decide if we want an index (or a timestamp) of this report in relation to the group call, to help differenciate when issues occur and ignore/track initial connection delays.
-}
-
-/// CallFeedReport #####################################################################################################
-export interface CallFeedReport {
-    callId: string;
-    opponentMemberId: string;
-    transceiver: TransceiverStats[];
-    callFeeds: CallFeedStats[];
-}
-
-export interface CallFeedStats {
-    stream: string;
-    type: "remote" | "local";
-    audio: TrackStats | null;
-    video: TrackStats | null;
-    purpose: string;
-    prefix: string;
-    isVideoMuted: boolean;
-    isAudioMuted: boolean;
-}
-
-export interface TransceiverStats {
-    readonly mid: string;
-    readonly sender: TrackStats | null;
-    readonly receiver: TrackStats | null;
-    readonly direction: string;
-    readonly currentDirection: string;
-}
-
-export interface TrackStats {
-    readonly id: string;
-    readonly kind: "audio" | "video";
-    readonly settingDeviceId: string;
-    readonly constrainDeviceId: string;
-    readonly muted: boolean;
-    readonly enabled: boolean;
-    readonly readyState: "ended" | "live";
-    readonly label: string;
-}
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { type ConnectionStatsBandwidth, type ConnectionStatsBitrate, type PacketLoss } from "./connectionStats.ts";
+import { type TransportStats } from "./transportStats.ts";
+import { type Resolution } from "./media/mediaTrackStats.ts";
+
+export enum StatsReport {
+    CONNECTION_STATS = "StatsReport.connection_stats",
+    CALL_FEED_REPORT = "StatsReport.call_feed_report",
+    BYTE_SENT_STATS = "StatsReport.byte_sent_stats",
+    SUMMARY_STATS = "StatsReport.summary_stats",
+}
+
+/// ByteSentStatsReport ################################################################################################
+export interface ByteSentStatsReport extends Map<TrackID, ByteSend> {
+    callId?: string;
+    opponentMemberId?: string;
+    // is a map: `local trackID` => byte send
+}
+
+export type TrackID = string;
+export type ByteSend = number;
+
+/// ConnectionStatsReport ##############################################################################################
+export interface ConnectionStatsReport {
+    callId?: string;
+    opponentMemberId?: string;
+    bandwidth: ConnectionStatsBandwidth;
+    bitrate: ConnectionStatsBitrate;
+    packetLoss: PacketLoss;
+    audioConcealment: Map<TrackID, AudioConcealment>;
+    totalAudioConcealment: AudioConcealment;
+    resolution: ResolutionMap;
+    framerate: FramerateMap;
+    codec: CodecMap;
+    jitter: Map<TrackID, number>;
+    transport: TransportStats[];
+}
+
+export interface AudioConcealment {
+    concealedAudio: number;
+    totalAudioDuration: number;
+}
+
+export interface ResolutionMap {
+    local: Map<TrackID, Resolution>;
+    remote: Map<TrackID, Resolution>;
+}
+
+export interface FramerateMap {
+    local: Map<TrackID, number>;
+    remote: Map<TrackID, number>;
+}
+
+export interface CodecMap {
+    local: Map<TrackID, string>;
+    remote: Map<TrackID, string>;
+}
+
+/// SummaryStatsReport #################################################################################################
+export interface SummaryStatsReport {
+    /**
+     * Aggregated the information for percentage of received media
+     *
+     * This measure whether the current user receive data from a call participants.
+     * As soon as a participant sends at least a byte media to this user, this counts as one measurement unit.
+     * The units of measure divided by the total number of participants is a value between 0 and 1.
+     */
+    percentageReceivedMedia: number;
+    percentageReceivedAudioMedia: number;
+    percentageReceivedVideoMedia: number;
+    maxJitter: number;
+    maxPacketLoss: number;
+    percentageConcealedAudio: number;
+    peerConnections: number;
+    opponentUsersInCall?: number;
+    opponentDevicesInCall?: number;
+    diffDevicesToPeerConnections?: number;
+    ratioPeerConnectionToDevices?: number;
+    // Todo: Decide if we want an index (or a timestamp) of this report in relation to the group call, to help differenciate when issues occur and ignore/track initial connection delays.
+}
+
+/// CallFeedReport #####################################################################################################
+export interface CallFeedReport {
+    callId: string;
+    opponentMemberId: string;
+    transceiver: TransceiverStats[];
+    callFeeds: CallFeedStats[];
+}
+
+export interface CallFeedStats {
+    stream: string;
+    type: "remote" | "local";
+    audio: TrackStats | null;
+    video: TrackStats | null;
+    purpose: string;
+    prefix: string;
+    isVideoMuted: boolean;
+    isAudioMuted: boolean;
+}
+
+export interface TransceiverStats {
+    readonly mid: string;
+    readonly sender: TrackStats | null;
+    readonly receiver: TrackStats | null;
+    readonly direction: string;
+    readonly currentDirection: string;
+}
+
+export interface TrackStats {
+    readonly id: string;
+    readonly kind: "audio" | "video";
+    readonly settingDeviceId: string;
+    readonly constrainDeviceId: string;
+    readonly muted: boolean;
+    readonly enabled: boolean;
+    readonly readyState: "ended" | "live";
+    readonly label: string;
+}

package/src/webrtc/stats/statsReportEmitter.ts

@@ -1,49 +1,49 @@
-/*
-Copyright 2023 The Matrix.org Foundation C.I.C.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-import { TypedEventEmitter } from "../../models/typed-event-emitter.ts";
-import {
-    type ByteSentStatsReport,
-    type CallFeedReport,
-    type ConnectionStatsReport,
-    StatsReport,
-    type SummaryStatsReport,
-} from "./statsReport.ts";
-
-export type StatsReportHandlerMap = {
-    [StatsReport.BYTE_SENT_STATS]: (report: ByteSentStatsReport) => void;
-    [StatsReport.CONNECTION_STATS]: (report: ConnectionStatsReport) => void;
-    [StatsReport.CALL_FEED_REPORT]: (report: CallFeedReport) => void;
-    [StatsReport.SUMMARY_STATS]: (report: SummaryStatsReport) => void;
-};
-
-export class StatsReportEmitter extends TypedEventEmitter<StatsReport, StatsReportHandlerMap> {
-    public emitByteSendReport(byteSentStats: ByteSentStatsReport): void {
-        this.emit(StatsReport.BYTE_SENT_STATS, byteSentStats);
-    }
-
-    public emitConnectionStatsReport(report: ConnectionStatsReport): void {
-        this.emit(StatsReport.CONNECTION_STATS, report);
-    }
-
-    public emitCallFeedReport(report: CallFeedReport): void {
-        this.emit(StatsReport.CALL_FEED_REPORT, report);
-    }
-
-    public emitSummaryStatsReport(report: SummaryStatsReport): void {
-        this.emit(StatsReport.SUMMARY_STATS, report);
-    }
-}
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { TypedEventEmitter } from "../../models/typed-event-emitter.ts";
+import {
+    type ByteSentStatsReport,
+    type CallFeedReport,
+    type ConnectionStatsReport,
+    StatsReport,
+    type SummaryStatsReport,
+} from "./statsReport.ts";
+
+export type StatsReportHandlerMap = {
+    [StatsReport.BYTE_SENT_STATS]: (report: ByteSentStatsReport) => void;
+    [StatsReport.CONNECTION_STATS]: (report: ConnectionStatsReport) => void;
+    [StatsReport.CALL_FEED_REPORT]: (report: CallFeedReport) => void;
+    [StatsReport.SUMMARY_STATS]: (report: SummaryStatsReport) => void;
+};
+
+export class StatsReportEmitter extends TypedEventEmitter<StatsReport, StatsReportHandlerMap> {
+    public emitByteSendReport(byteSentStats: ByteSentStatsReport): void {
+        this.emit(StatsReport.BYTE_SENT_STATS, byteSentStats);
+    }
+
+    public emitConnectionStatsReport(report: ConnectionStatsReport): void {
+        this.emit(StatsReport.CONNECTION_STATS, report);
+    }
+
+    public emitCallFeedReport(report: CallFeedReport): void {
+        this.emit(StatsReport.CALL_FEED_REPORT, report);
+    }
+
+    public emitSummaryStatsReport(report: SummaryStatsReport): void {
+        this.emit(StatsReport.SUMMARY_STATS, report);
+    }
+}