@vkontakte/calls-sdk 2.8.13-dev.58787f8a.0 → 2.8.13-dev.5a31cf44.0

package/classes/MediaSource.d.ts

@@ -1,5 +1,6 @@
 import type { IEffect } from '@vkontakte/calls-video-effects';
 import EventEmitter from '../classes/EventEmitter';
+import ActiveFeature from '../enums/ActiveFeature';
 import MediaOption from '../enums/MediaOption';
 import { type DebugLogger } from '../static/Debug';
 import MediaSettings, { IVideoDimentions } from '../types/MediaSettings';
@@ -77,6 +78,8 @@ export declare class MediaSource extends EventEmitter {
      */
     getMediaSettings(): MediaSettings;
     get mediaSettings(): MediaSettings;
+    /** Что сейчас включено у пользователя — для метрики active_features */
+    get activeFeatures(): ActiveFeature[];
     changeDevice(kind: MediaDeviceKind): Promise<void>;
     /**
      * Установка кастомного стрима для видео, например внешний шаринг экрана

package/classes/StatsLogger.d.ts

@@ -2,7 +2,7 @@ import BaseApi from '../abstract/BaseApi';
 import BaseLogger from '../abstract/BaseLogger';
 import StatLog from '../enums/StatLog';
 import TransportTopology from '../enums/TransportTopology';
-type ClientStatsPayload = Record<string, string | number | boolean | undefined | null>;
+type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
 export type LogClientStatsOptions = {
     immediately?: boolean;
     occurredAt?: number;

package/classes/conversation/Conversation.d.ts

@@ -66,6 +66,7 @@ export default class Conversation extends EventEmitter {
     private _reservedId;
     private readonly _onUnload;
     private readonly _onRestore;
+    private readonly _onVisibilityChange;
     private readonly _audioOutput;
     private readonly _stats;
     private _lastStalled;
@@ -452,6 +453,11 @@ export default class Conversation extends EventEmitter {
     private _onVideoSuspendSuggest;
     private _onParticipantHold;
     private _isMe;
+    /**
+     * Сколько человек сейчас в звонке. Считаем только принявших: приглашенные,
+     * у которых еще идет вызов, ресурсы не потребляют.
+     */
+    private _getParticipantsCount;
     private _getMuteStatesForRoomId;
     private _getMuteStatesForCurrentRoom;
     private _setMuteStatesForRoomId;

package/classes/stat/ClientResourceStats.d.ts

@@ -0,0 +1,41 @@
+import ActiveFeature from '../../enums/ActiveFeature';
+import { type DebugLogger } from '../../static/Debug';
+/** Метрики ресурсов клиента за интервал между отправками callStat */
+export type ClientResourceReport = {
+    /** Максимум участников за интервал */
+    participants_max?: number;
+    /** Фичи, включенные в любой момент интервала */
+    active_features?: string[];
+    /** Максимальная площадь окна за интервал, в мегапикселях */
+    app_total_area_mpx_max?: number;
+};
+export type ClientResourceSources = {
+    getParticipantsCount: () => number;
+    getActiveFeatures: () => ActiveFeature[];
+};
+/**
+ * Копит ресурсные метрики между отправками callStat: репортер забирает накопленное
+ * через takeReport() и начинает копить заново.
+ *
+ * Замеряем чаще, чем отправляем, потому что нас интересует не состояние в момент отправки,
+ * а что происходило за интервал: пик участников и все фичи, которые успели поработать.
+ */
+export declare class ClientResourceStats {
+    private readonly _sources;
+    private readonly _debug;
+    private _timer;
+    private _participantsMax;
+    private _areaMpxMax;
+    private _features;
+    constructor(sources: ClientResourceSources, debug?: DebugLogger);
+    /** Забрать накопленное за интервал и начать копить заново */
+    takeReport(): ClientResourceReport;
+    destroy(): void;
+    private _sample;
+    /**
+     * Площадь окна в физических пикселях: CSS-пиксели умножаем на devicePixelRatio,
+     * иначе одно и то же окно на экране с ретиной и без давало бы одинаковую цифру.
+     * Приложение в вебе — это одна вкладка, суммировать нечего.
+     */
+    private _measureAreaMpx;
+}

package/classes/stat/ConversationStats.d.ts

@@ -5,6 +5,7 @@ import HangupReason from '../HangupReason';
 import StatEventCollector from './StatEventCollector';
 import { ApiCallStats } from './ApiCallStats';
 import { CallLifecycleStats } from './CallLifecycleStats';
+import { ClientResourceSources, ClientResourceStats } from './ClientResourceStats';
 import { CodecStatsAggregator } from './CodecStatsAggregator';
 import { StatAggregator } from './StatAggregator';
 import { StatPings } from './StatPings';
@@ -17,9 +18,10 @@ export declare class ConversationStats {
     readonly pings: StatPings;
     readonly signalingCommands: StatSignalingCommands;
     readonly apiCalls: ApiCallStats;
+    readonly resources: ClientResourceStats;
     private readonly _api;
     private _unloading;
-    constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined);
+    constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined, resourceSources: ClientResourceSources);
     /**
      * Вызывается из pagehide-обработчика: события финиша должны пережить смерть
      * вкладки. Сводки пингов и команд сбрасываем здесь же — destroy() их только
@@ -28,6 +30,7 @@ export declare class ConversationStats {
     prepareForUnload(): void;
     /** Вкладка пережила pagehide: возвращаем запись в очередь. */
     restoreAfterUnload(): void;
+    resetPingBaseline(): void;
     logHangup(reason: HangupReason): void;
     flushCallMetrics(): void;
     destroy(): void;

package/classes/stat/NetworkAdaptationStats.d.ts

@@ -0,0 +1,35 @@
+import { StatAggregator } from './StatAggregator';
+/** Причина события client_requested_server_topology */
+export declare const enum ServerTopologyReason {
+    NO_CONNECTION_TIMEOUT = "no_connection_timeout",
+    CONNECTION_FAILED = "connection_failed",
+    SUCCESS_CONNECTION = "success_connection",
+    /** Возможна на бэке, в вебе пока не поддержана */
+    NO_DATA_TIMEOUT = "no_data_timeout",
+    /** Возможна на бэке, в вебе пока не поддержана */
+    SUCCESS_AUDIO = "success_audio",
+    /** Возможна на бэке, в вебе пока не поддержана */
+    CONNECTION_ACCEPTED_FAILED = "connection_accepted_failed"
+}
+export declare const enum NetworkQuality {
+    GOOD = "good",
+    BAD_1 = "bad_1",
+    BAD_2 = "bad_2"
+}
+export type VideoEncoderChange = {
+    /** Круговая задержка, мс */
+    rtt: number;
+    /** Потери, проценты */
+    loss: number;
+    networkQuality: NetworkQuality;
+    /** mimeType исходящего видео, например video/VP8 */
+    mimeType: string | undefined;
+    source: 'camera' | 'screencast' | 'all';
+};
+/** Отправляет в стату решения клиента по смене топологии и настроек видеоэнкодера */
+export declare class NetworkAdaptationStats {
+    private readonly _statAggregator;
+    constructor(statAggregator: StatAggregator | null);
+    logServerTopologyRequested(reason: ServerTopologyReason, elapsed: number): void;
+    logVideoEncoderChanged(change: VideoEncoderChange): void;
+}

package/classes/stat/SdpStats.d.ts

@@ -32,6 +32,7 @@ export declare class SdpStats {
     /** Не смогли применить SDP собеседника */
     logSetRemoteFailed(sdp: SdpDescription, error: unknown): void;
     destroy(): void;
+    private _intervalSince;
     private _logFailure;
     private _log;
 }

package/classes/stat/StatAggregator.d.ts

@@ -1,11 +1,13 @@
 import { ICallStatLog } from '../../types/PerfStatReporter';
 import { IEventualStatLog } from '../../types/IEventualStatLog';
 import StatEventCollector from './StatEventCollector';
+import { ClientResourceStats } from './ClientResourceStats';
 export declare class StatAggregator {
     private readonly _logger;
+    private readonly _resources;
     private readonly _eventualLogs;
     private _lastCallStatContext;
-    constructor(logger: StatEventCollector);
+    constructor(logger: StatEventCollector, resources?: ClientResourceStats | null);
     logCallStat(params: ICallStatLog): void;
     /**
      * Событие уходит с теми полями, что переданы. Без value — уходит без value.

package/classes/stat/StatEventCollector.d.ts

@@ -2,7 +2,7 @@ import BaseApi from '../../abstract/BaseApi';
 import BaseLogger from '../../abstract/BaseLogger';
 import StatLog from '../../enums/StatLog';
 import TransportTopology from '../../enums/TransportTopology';
-type ClientStatsPayload = Record<string, string | number | boolean | undefined | null>;
+type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
 export type LogClientStatsOptions = {
     /** Время наступления события. По умолчанию — момент записи. */
     occurredAt?: number;

package/classes/stat/StatPings.d.ts

@@ -12,5 +12,7 @@ export declare class StatPings {
     mark(transport: SignalingTransportType): void;
     /** Отправляем данные в стату */
     logMetrics(): void;
+    /** Сбрасываем baseline после скрытия страницы, чтобы фоновой простой не стал интервалом ping. */
+    resetBaseline(): void;
     destroy(): void;
 }

package/classes/stat/StatQueue.d.ts

@@ -2,8 +2,8 @@
 export declare const RECORD_LIMIT = 5000;
 /** Срок жизни события в очереди. */
 export declare const MAX_AGE_MS: number;
-/** Произвольный набор скалярных полей события. */
-export type StatPayload = Record<string, string | number | boolean | null>;
+/** Произвольный набор полей события: скаляры и списки строк. */
+export type StatPayload = Record<string, string | string[] | number | boolean | null>;
 /** Запись очереди без сгенерированного ключа. */
 export type StatQueueEntry = {
     /** userId владельца события. Не может быть неизвестным. */

package/classes/transport/DirectTransport.d.ts

@@ -31,6 +31,10 @@ export default class DirectTransport extends BaseTransport {
     private _lastStat;
     private _fingerprint;
     private _neverConnected;
+    private _connectionStartedAt;
+    private _connectionLostAt;
+    /** Запросили переход на серверную топологию, не дождавшись первого подключения p2p */
+    private _serverRequestedOnNoConnection;
     private _serverSettings;
     private _prevConsumerSettings;
     private _networkLimitsForVideo;
@@ -41,6 +45,7 @@ export default class DirectTransport extends BaseTransport {
     private _directStatReporter;
     private readonly _sdpStats;
     private readonly _peerConnectionStats;
+    private readonly _networkAdaptationStats;
     private readonly _debug;
     private readonly _logger;
     private readonly _statAggregator;

package/classes/transport/PerfStatReporter.d.ts

@@ -8,10 +8,8 @@ export default class PerfStatReporter extends EventEmitter {
     private _previousPerfStatReportTimestamp;
     private _previousNetworkStatReportTimestamp;
     private _previousCallStatReportTimestamp;
-    private _previousCounters;
+    private _previousCallStatReport;
     private _previousRemoteInboundRtps;
-    private _previousInboundRtps;
-    private _previousOutboundRtps;
     private _previousCandidatePair;
     private _screenShareStats;
     private _signaling;
@@ -27,7 +25,6 @@ export default class PerfStatReporter extends EventEmitter {
     private _reportCallStats;
     private _reportCandidatePair;
     private _calculatePacketLoss;
-    private _calculateOutboundDeltas;
     private _handleScreenSharingStat;
     private _handleTransportStateChanged;
 }

package/classes/transport/ServerTransport.d.ts

@@ -83,8 +83,6 @@ export default class ServerTransport extends BaseTransport {
     private _startSettingsInterval;
     private _stopSettingsInterval;
     private _collectStat;
-    /** mid потока быстрой шары, чтобы отделить его от камеры в статистике */
-    private _getScreenShareMid;
     private _reportStats;
     private _detectStaleTracks;
     private _allocateConsumer;

package/enums/ActiveFeature.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Фичи, активные во время звонка. Уходят в метрику active_features,
+ * чтобы по ним разрезать остальную статистику: сколько фризов при включённой камере,
+ * какой битрейт при шаре и так далее.
+ *
+ * Здесь только то, что реально включено прямо сейчас, а не то, что разрешено настройками:
+ * иначе фича попадала бы в метрику у всех, кому ее просто не запретили.
+ *
+ * Сервер принимает только имена из своего списка, незнакомые отбрасывает с ошибкой.
+ * Новое имя добавляем сюда после того, как его добавят на сервере.
+ */
+declare enum ActiveFeature {
+    MICROPHONE = "MICROPHONE",
+    CAMERA = "CAMERA",
+    /** Любая шара экрана, в том числе быстрая */
+    SCREEN = "SCREEN",
+    ANIMOJI = "ANIMOJI"
+}
+export default ActiveFeature;

package/enums/Stat.d.ts

@@ -37,6 +37,8 @@ declare enum Stat {
     SDP_SET_REMOTE_ROLLBACK = "sdp_set_remote_rollback",
     SDP_GENERATED = "sdp_generated",
     SDP_RECEIVED = "sdp_received",
+    CLIENT_REQUESTED_SERVER_TOPOLOGY = "client_requested_server_topology",
+    VIDEO_ENCODER_CHANGED_BY_NETWORK_ADAPTER = "video_encoder_changed_by_network_adapter",
     WEBSOCKET_CONNECTED = "websocket_connected",
     WEBSOCKET_RECONNECTED = "websocket_reconnected",
     WEBSOCKET_FAILED_PINGS = "websocket_failed_pings",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.13-dev.58787f8a.0",
+  "version": "2.8.13-dev.5a31cf44.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/types/PerfStatReporter.d.ts

@@ -42,22 +42,12 @@ export interface ICallStatLog extends Pick<CallStatReport, 'call_topology' | 'na
     concealment_audio_avg_size?: number;
     video_loss?: number;
     audio_loss?: number;
-    /** Потери входящего видео за период, в процентах */
-    in_video_loss?: number;
-    /** Потери входящего аудио за период, в процентах */
-    in_audio_loss?: number;
-    /** Байты, отправленные по исходящим аудио потокам за период, включая шару звука */
-    audio_bytes_sent?: number;
-    /** Уровень исходящего звука в шкале 16-битного PCM, от 0 до 32767 */
-    audio_level?: number;
-    /** Битрейт исходящего видео без ретрансмитов, кибибит/с */
-    br_encode?: number;
-    /** Битрейт отправки видео камеры, кибибит/с */
-    br_transmit?: number;
-    /** Битрейт ретрансмитов видео камеры, кибибит/с */
-    br_retransmit?: number;
-    /** Кадры камеры, закодированные энкодером за период */
-    frames_encoded?: number;
     cpu_hardware_concurrency?: number;
-    [k: string]: string | number | boolean | undefined;
+    /** Максимум участников за интервал между отправками */
+    participants_max?: number;
+    /** Фичи, включенные в любой момент интервала */
+    active_features?: string[];
+    /** Максимальная площадь окна приложения за интервал, в мегапикселях */
+    app_total_area_mpx_max?: number;
+    [k: string]: string | string[] | number | boolean | undefined;
 }

package/types/Statistics.d.ts

@@ -36,10 +36,6 @@ interface StatRtpOutboundVideo {
     framesSent?: number;
     framesPerSecond?: number;
     targetBitrate?: number;
-    /**
-     * Общее количество кадров, закодированных энкодером
-     */
-    framesEncoded?: number;
 }
 export interface StatRtp extends StatRtpOutboundVideo {
     /**
@@ -69,10 +65,6 @@ export interface StatRtp extends StatRtpOutboundVideo {
      * Общее количество байтов, отправленных по этому потоку
      */
     bytesSent: number;
-    /**
-     * Общее количество байтов, отправленных повторно (ретрансмиты) по этому потоку
-     */
-    retransmittedBytesSent?: number;
     /**
      * Общее количество байтов заголовков, полученных по этому потоку
      */
@@ -81,11 +73,6 @@ export interface StatRtp extends StatRtpOutboundVideo {
      * Общее количество байтов заголовков, отправленных по этому потоку
      */
     headerBytesSent: number;
-    /**
-     * Уровень звука исходящего аудио потока в момент снятия статистики, от 0 до 1.
-     * Берется из media-source, у входящих потоков его нет.
-     */
-    audioLevel?: number;
     /**
      * Среднее значение джиттера в секундах
      * Джиттер — это вариация задержки в получении пакетов данных.
@@ -126,10 +113,6 @@ export interface StatRtp extends StatRtpOutboundVideo {
      * Идентификатор пользователя, связанный с этим потоком
      */
     userId?: string;
-    /**
-     * Поток демонстрации экрана (быстрая шара), а не камеры
-     */
-    isScreenShare?: boolean;
     /**
      * Пропускная способность в битах в секунду
      */