@vkontakte/calls-sdk 2.8.13-dev.36d30d4a.0 → 2.8.13-dev.3f06c117.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

@@ -105,7 +105,7 @@ export default class Conversation extends EventEmitter {
     private _onJoinPart2;
     private _extractExternalRooms;
     private _extractExternalRoomsData;
-    onPush(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number): Promise<void>;
+    onPush(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number, externalUserId?: string): Promise<void>;
     private _isInWaitingHall;
     private _isWaitForAdmin;
     private _isRestricted;
@@ -140,6 +140,8 @@ export default class Conversation extends EventEmitter {
      * @throws ErrorEvent
      */
     private _startConversation;
+    private _addSelfExternalUserId;
+    private _addExternalUserIdToEndpoint;
     /**
      * @throws ErrorEvent
      */
@@ -453,6 +455,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() их только

package/classes/stat/SdpStats.d.ts

@@ -32,8 +32,9 @@ export declare class SdpStats {
     /** Не смогли применить SDP собеседника */
     logSetRemoteFailed(sdp: SdpDescription, error: unknown): void;
     destroy(): void;
-    private _intervalSince;
     private _logFailure;
     private _log;
 }
+/** Браузер может спрятать локальный адрес за именем вида <uuid>.local, такой кандидат в стату не шлём */
+export declare function isIpAddress(address: string): boolean;
 export {};

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/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/PerfStatReporter.d.ts

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

package/classes/transport/ServerTransport.d.ts

@@ -83,6 +83,8 @@ 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/package.json

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

package/static/BrowserEnvironment.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Определение браузера, операционной системы и доступных возможностей.
+ */
+/**
+ * Известные браузеры
+ */
+export type BrowserName = 'Edge' | 'Chrome' | 'Firefox' | 'Yandex' | 'Opera' | 'Sferum';
+declare namespace BrowserEnvironment {
+    /**
+     * Получение и кэширование версии операционной системы
+     */
+    function initOsVersion(warn: (...args: any[]) => void): Promise<void>;
+    /**
+     * Проверяет поддержку WebRTC браузером
+     */
+    function isBrowserSupported(): boolean;
+    /**
+     * Возвращает первую отсутствующую capability в стабильном порядке.
+     */
+    function getBrowserSupportFailure(): BrowserSupportFailure | null;
+    /**
+     * Проверяет поддержку шаринга экрана браузером
+     */
+    function isScreenCapturingSupported(): boolean;
+    /**
+     * Проверяет поддержку выбора микрофона браузером, независимо от списка устройств и разрешений.
+     * Доступен до init, не запрашивает разрешения и не захватывает медиа.
+     */
+    function canSelectAudioInput(): boolean;
+    /**
+     * Проверяет поддержку выбора аудиовыхода браузером, независимо от списка устройств и разрешений.
+     * Доступен до init, не запрашивает разрешения и не меняет аудиовыход.
+     */
+    function canSelectAudioOutput(): boolean;
+    /**
+     * В некоторых браузерах H264 decoder сломан
+     */
+    function isBrokenH264Decoder(): boolean;
+    /**
+     * В некоторых браузерах VP9 encoder сломан
+     */
+    function isBrokenVP9Encoder(): boolean;
+    /**
+     * В некоторых браузерах VP9 decoder сломан
+     */
+    function isBrokenVP9Decoder(): boolean;
+    /**
+     * Может ли браузер делать H264 приоритетным
+     */
+    function canPreferH264(): boolean;
+    /**
+     * Поддержка simulcast браузером.
+     * Safari корректно поддерживает simulcast начиная с версии 18.
+     * Firefox поддерживает simulcast с VP8 начиная с версии 134.
+     */
+    function isSimulcastSupportedByBrowser(): boolean;
+    /**
+     * Имя операционной системы
+     */
+    function os(): string;
+    /**
+     * Версия операционной системы
+     */
+    function osVersion(): number | null | undefined;
+    /**
+     * Мобильный браузер или нет
+     */
+    function isMobile(): boolean;
+    /**
+     * Имя браузера
+     */
+    function browserName(): BrowserName | string;
+    /**
+     * Версия браузера
+     */
+    function browserVersion(): string;
+    /**
+     * Если браузер основан на хроме - возвращает версию
+     */
+    function baseChromeVersion(): number;
+    /**
+     * Возвращает подверсию браузера (если она есть)
+     */
+    function browserSubVersion(): string;
+    /**
+     * Браузер поддерживает захват звука при трансляции экрана
+     */
+    function isAudioShareSupported(): boolean;
+}
+export default BrowserEnvironment;

package/static/Params.d.ts

@@ -62,6 +62,8 @@ export type ParamsObject = {
     /** @hidden */
     clientType: string;
     /** @hidden */
+    useSelfExternalUserId: boolean;
+    /** @hidden */
     externalUserType: string;
     /** @hidden */
     device: string;
@@ -989,6 +991,7 @@ export default abstract class Params {
     static get statQueueEnabled(): boolean;
     static get clientType(): string;
     static set clientType(value: string);
+    static get useSelfExternalUserId(): boolean;
     static get externalUserType(): string;
     static set externalUserType(value: string);
     static get device(): string;

package/static/WebRTCUtils.d.ts

@@ -17,10 +17,6 @@ export declare enum FacingMode {
      */
     ENVIRONMENT = "environment"
 }
-/**
- * Известные браузеры
- */
-export type BrowserName = 'Edge' | 'Chrome' | 'Firefox' | 'Yandex' | 'Opera' | 'Sferum';
 declare namespace WebRTCUtils {
     /**
      * До вызова этого метода бесполезно опрашивать другие публичные методы.
@@ -118,76 +114,9 @@ declare namespace WebRTCUtils {
      * Возвращает фейковый видео mediaTrack
      */
     function getBlackMediaTrack(width?: number, height?: number): MediaStreamTrack;
-    /**
-     * Проверяет поддержку WebRTC браузером
-     */
-    function isBrowserSupported(): boolean;
-    /**
-     * Возвращает первую отсутствующую capability в стабильном порядке.
-     */
-    function getBrowserSupportFailure(): BrowserSupportFailure | null;
-    /**
-     * Проверяет поддержку шаринга экрана браузером
-     */
-    function isScreenCapturingSupported(): boolean;
-    /**
-     * В некоторых браузерах H264 decoder сломан
-     */
-    function isBrokenH264Decoder(): boolean;
-    /**
-     * В некоторых браузерах VP9 encoder сломан
-     * В симулкасте вп9 енкодер ведет себя некорректно
-     */
-    function isBrokenVP9Encoder(): boolean;
-    /**
-     * В некоторых браузерах VP9 decoder сломан
-     */
-    function isBrokenVP9Decoder(): boolean;
-    /**
-     * Может ли браузер делать H264 приоритетным
-     */
-    function canPreferH264(): boolean;
-    /**
-     * Поддержка simulcast браузером.
-     * Safari корректно поддерживает simulcast начиная с версии 18.
-     * Firefox поддерживает simulcast с VP8 начиная с версии 134.
-     */
-    function isSimulcastSupportedByBrowser(): boolean;
-    /**
-     * Имя операционной системы
-     */
-    function os(): string;
-    /**
-     * Версия операционной системы
-     */
-    function osVersion(): number | null | undefined;
-    /**
-     * Мобильный браузер или нет
-     */
-    function isMobile(): boolean;
-    /**
-     * Имя браузера
-     */
-    function browserName(): BrowserName | string;
-    /**
-     * Версия браузера
-     */
-    function browserVersion(): string;
-    /**
-     * Если браузер основан на хроме - возвращает версию
-     */
-    function baseChromeVersion(): number;
     /**
      * Возвращает AudioContext
      */
     function getAudioContext(): AudioContext;
-    /**
-     * Возвращает подверсию браузера (если она есть)
-     */
-    function browserSubVersion(): string;
-    /**
-     * Браузер поддерживает захват звука при трансляции экрана
-     */
-    function isAudioShareSupported(): boolean;
 }
 export default WebRTCUtils;

package/types/ClientStatsEvent.d.ts

@@ -1,7 +1,8 @@
+import { StatPayload } from '../classes/stat/StatQueue';
 /**
  * Событие статистики SDK, которое получает `onClientStats`
  */
-export type ClientStatsEvent = Record<string, string | number | boolean | null> & {
+export type ClientStatsEvent = StatPayload & {
     /** Имя события из `Stat`. У периодической статистики звонка его нет */
     name?: string;
     /** ID звонка, `null` — пока он неизвестен */

package/types/PerfStatReporter.d.ts

@@ -40,8 +40,33 @@ export interface ICallStatLog extends Pick<CallStatReport, 'call_topology' | 'na
     is_simulcast?: boolean;
     concealed_silent_audio_samples?: number;
     concealment_audio_avg_size?: number;
+    /** Потери исходящего видео: 100 * ΣΔpacketsLost / (ΣΔpacketsLost + ΣΔpacketsSent), по парам SSRC со свежим RR */
     video_loss?: number;
+    /** Потери исходящего аудио: 100 * ΣΔpacketsLost / (ΣΔpacketsLost + ΣΔpacketsSent), по парам SSRC со свежим RR */
     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;
+    audio_tracks?: number;
+    /** Максимум участников за интервал между отправками */
+    participants_max?: number;
+    /** Фичи, включенные в любой момент интервала */
+    active_features?: string[];
+    /** Максимальная площадь окна приложения за интервал, в мегапикселях */
+    app_total_area_mpx_max?: number;
+    [k: string]: string | string[] | number | boolean | undefined;
 }

package/types/SignalingMessage.d.ts

@@ -198,6 +198,7 @@ declare namespace SignalingMessage {
         reason: HangupType;
         errorCode?: string;
         markers?: ParticipantListMarkers;
+        externalId?: ExternalId;
     }
     export interface ClosedConversation extends Notification {
         reason: HangupType;

package/types/Statistics.d.ts

@@ -36,8 +36,14 @@ interface StatRtpOutboundVideo {
     framesSent?: number;
     framesPerSecond?: number;
     targetBitrate?: number;
+    /**
+     * Общее количество кадров, закодированных энкодером
+     */
+    framesEncoded?: number;
 }
 export interface StatRtp extends StatRtpOutboundVideo {
+    /** Время измерения, для remote-inbound-rtp — время получения RTCP Receiver Report */
+    timestamp: number;
     /**
      * Уникальный идентификатор источника синхронизации RTP
      */
@@ -65,6 +71,10 @@ export interface StatRtp extends StatRtpOutboundVideo {
      * Общее количество байтов, отправленных по этому потоку
      */
     bytesSent: number;
+    /**
+     * Общее количество байтов, отправленных повторно (ретрансмиты) по этому потоку
+     */
+    retransmittedBytesSent?: number;
     /**
      * Общее количество байтов заголовков, полученных по этому потоку
      */
@@ -73,6 +83,11 @@ export interface StatRtp extends StatRtpOutboundVideo {
      * Общее количество байтов заголовков, отправленных по этому потоку
      */
     headerBytesSent: number;
+    /**
+     * Уровень звука исходящего аудио потока в момент снятия статистики, от 0 до 1.
+     * Берется из media-source, у входящих потоков его нет.
+     */
+    audioLevel?: number;
     /**
      * Среднее значение джиттера в секундах
      * Джиттер — это вариация задержки в получении пакетов данных.
@@ -81,19 +96,15 @@ export interface StatRtp extends StatRtpOutboundVideo {
     /**
      * Общее количество потерянных пакетов
      */
-    packetsLost: number;
+    packetsLost?: number;
     /**
      * Общее количество полученных пакетов
      */
-    packetsReceived: number;
+    packetsReceived?: number;
     /**
      * Общее количество отправленных пакетов
      */
-    packetsSent: number;
-    /**
-     * Доля потерянных пакетов
-     */
-    fractionLost: number;
+    packetsSent?: number;
     /**
      * Количество Picture Loss Indication (PLI) сообщений
      * PLI — это сообщения, указывающие на потерю кадров изображения.
@@ -113,6 +124,10 @@ export interface StatRtp extends StatRtpOutboundVideo {
      * Идентификатор пользователя, связанный с этим потоком
      */
     userId?: string;
+    /**
+     * Поток демонстрации экрана (быстрая шара), а не камеры
+     */
+    isScreenShare?: boolean;
     /**
      * Пропускная способность в битах в секунду
      */