@vkontakte/calls-sdk 2.8.13-beta.0 → 2.8.13-beta.10

package/static/Params.d.ts

@@ -2,6 +2,7 @@ import type { VideoEffects } from '@vkontakte/calls-video-effects';
 import type { EffectVoiceChange, VadControllerOptions, VadLib } from '@vkontakte/calls-audio-effects';
 import type * as Vmoji from '@vkontakte/calls-vmoji';
 import { IAsrData } from '../types/Asr';
+import { ClientStatsEvent } from '../types/ClientStatsEvent';
 import { ConversationData } from '../types/Conversation';
 import HangupReason from '../classes/HangupReason';
 import { MediaTrackKind } from '../classes/MediaSource';
@@ -37,6 +38,27 @@ export type ParamsObject = {
     platform: string;
     /** @hidden */
     clientStatsPlatform: string;
+    /**
+     * Версия приложения-хоста, уходит в статистику и сигналинг, например `'26.31.0:6822'`.
+     * По умолчанию `'0.0.0'`
+     */
+    appVersion: string;
+    /**
+     * Автоматически запускать отправку клиентской статистики при `init()`.
+     *
+     * При `false` события копятся в очереди, но не уходят в сеть, пока хост не
+     * вызовет `startStats()`.
+     *
+     * _По умолчанию: `true`_
+     */
+    autoStartStats: boolean;
+    /**
+     * Персистентная очередь клиентской статистики: события копятся в IndexedDB
+     * и уезжают пачками с подтверждением, переживая перезагрузку вкладки.
+     *
+     * _По умолчанию: `false`_
+     */
+    statQueueEnabled: boolean;
     /** @hidden */
     clientType: string;
     /** @hidden */
@@ -93,6 +115,8 @@ export type ParamsObject = {
     /** @hidden */
     signalingReconnectMaxCount: number;
     /** @hidden */
+    signalingReconnectMaxDuration: number;
+    /** @hidden */
     waitConnectionDelay: number;
     /** @hidden */
     waitResponseDelay: number;
@@ -230,6 +254,13 @@ export type ParamsObject = {
     iceRestartWaitTime: number;
     /** @hidden */
     transportConnectionWaitTime: number;
+    /**
+     * Разрешить запрашивать переход на серверную топологию не только звонящему,
+     * но и принимающей стороне, если не удалось восстановить оборвавшееся p2p-соединение
+     *
+     * _По умолчанию: `false`_
+     */
+    switchTopologyOnReconnectFromAnySide: boolean;
     /**
      * Частота получения статистики в миллисекундах
      *
@@ -269,6 +300,13 @@ export type ParamsObject = {
     perfStatReportEnabled: boolean;
     /** @hidden */
     callStatReportEnabled: boolean;
+    /**
+     * Отправлять событие статистики ice_candidate_gathering_failed
+     *
+     * _По умолчанию: `false`_
+     * @hidden
+     */
+    iceCandidateErrorStatEnabled: boolean;
     /**
      * Отдавать приоритет кодеку H264 для исходящего видео
      *
@@ -776,6 +814,12 @@ export type ParamsObject = {
      * Статистика звонка
      */
     onStatistics?: (stats: {}) => void;
+    /**
+     * Событие статистики SDK: те же данные, что уходят в статистику звонков, плюс `vcid` и `ts`
+     *
+     * @param data Данные события
+     */
+    onClientStats?: (data: ClientStatsEvent) => void;
     /**
      * Ошибка воспроизведения звука
      */
@@ -927,7 +971,13 @@ export default abstract class Params {
     static getScreenFrameRate(fastScreenShare: boolean): number;
     static get<N extends keyof ParamsObject>(name: N): ParamsObject[N];
     static get appName(): string;
-    static get appVersion(): number;
+    static get appVersion(): string;
+    /**
+     * Версия клиента для `client_version` в `auth.anonymLogin`. Бэкенд валидирует формат,
+     * поэтому это фиксированное значение, а не версия приложения-хоста (см. {@link Params.appVersion}).
+     * @hidden
+     */
+    static get apiClientVersion(): number;
     static get sdkVersion(): string;
     static get debug(): boolean;
     static get protocolVersion(): 5 | 6;
@@ -935,6 +985,8 @@ export default abstract class Params {
     static set platform(value: string);
     static get clientStatsPlatform(): string;
     static set clientStatsPlatform(value: string);
+    static get autoStartStats(): boolean;
+    static get statQueueEnabled(): boolean;
     static get clientType(): string;
     static set clientType(value: string);
     static get externalUserType(): string;
@@ -964,6 +1016,7 @@ export default abstract class Params {
     static get signalingReconnectDelay(): number;
     static get signalingReconnectMaxDelay(): number;
     static get signalingReconnectMaxCount(): number;
+    static get signalingReconnectMaxDuration(): number;
     static get waitConnectionDelay(): number;
     static get waitResponseDelay(): number;
     static get waitMessageDelay(): number;
@@ -1007,11 +1060,13 @@ export default abstract class Params {
     };
     static get iceRestartWaitTime(): number;
     static get transportConnectionWaitTime(): number;
+    static get switchTopologyOnReconnectFromAnySide(): boolean;
     static get statisticsInterval(): number;
     static set statisticsInterval(value: number);
     static get networkStatisticsInterval(): number;
     static get perfStatReportEnabled(): boolean;
     static get callStatReportEnabled(): boolean;
+    static get iceCandidateErrorStatEnabled(): boolean;
     static get enableLogPerfStatReport(): boolean;
     static get asrDataChannel(): boolean;
     static get consumerScreenDataChannelPacketSize(): number;
@@ -1083,10 +1138,14 @@ export default abstract class Params {
         videoSuspend: boolean;
         debugLog: boolean;
         callStatReportEnabled: boolean;
+        iceCandidateErrorStatEnabled: boolean;
         joinFromMultipleDevices: boolean;
         movieShare: boolean;
         clientType: string;
         clientStatsPlatform: string;
+        appVersion: string;
+        autoStartStats: boolean;
+        statQueueEnabled: boolean;
         consumerScreenDataChannelPacketSize: number;
         switchVideoAtBadNetwork: boolean;
         simulcast: boolean;

package/static/SessionStore.d.ts

@@ -0,0 +1,29 @@
+export type StoredSession = {
+    sessionKey: string;
+    /** Ключ окружения на момент сохранения, см. currentEndpoint(). */
+    endpoint: string;
+    savedAt: number;
+};
+/**
+ * Снимки сессий по uid на диске. Снимок может быть протухшим и переавторизации
+ * не подлежит, поэтому годится только для отложенных best-effort задач вроде
+ * досылки статистики.
+ */
+export default abstract class SessionStore {
+    static remember(uid: number, session: {
+        sessionKey: string;
+        endpoint: string;
+    }): void;
+    static get(uid: number): StoredSession | null;
+    static forget(uid: number): void;
+    /** Снимок живёт столько же, сколько события, которые он мог бы дослать. */
+    static prune(now?: number): void;
+    /**
+     * Ключ окружения: сессия прода не должна улететь на тестовый кластер.
+     * Адрес нормализуется так же, как в транспорте.
+     */
+    static currentEndpoint(): string;
+    private static _read;
+    private static _write;
+    private static _isValid;
+}

package/static/SimulcastInfo.d.ts

@@ -4,6 +4,7 @@ export declare const SIMULCAST_DEFAULT: {
     HEIGHT: number;
     WIDTH: number;
     BITRATE: number;
+    FPS: number;
 };
 export declare const SIMULCAST_SCALABILITY_MODE = "L1T2";
 export declare function isEqualSimulcastInfo(si1: ISimulcastInfo | null, si2: ISimulcastInfo | null): boolean;

package/static/WebRTCUtils.d.ts

@@ -2,7 +2,7 @@
  * Вспомогательный плагин для работы с WebRTC
  */
 import { IVideoDimentions } from '../types/MediaSettings';
-import type StatsLogger from '../classes/StatsLogger';
+import type StatEventCollector from '../classes/stat/StatEventCollector';
 import { type DebugLogger } from './Debug';
 /**
  * Тип камеры мобильного устройства
@@ -17,10 +17,6 @@ export declare enum FacingMode {
      */
     ENVIRONMENT = "environment"
 }
-/**
- * Известные браузеры
- */
-export type BrowserName = 'Edge' | 'Chrome' | 'Firefox' | 'Yandex' | 'Opera' | 'Sferum';
 declare namespace WebRTCUtils {
     /**
      * До вызова этого метода бесполезно опрашивать другие публичные методы.
@@ -85,24 +81,24 @@ declare namespace WebRTCUtils {
      * @param needAudio Нужно ли аудио
      * @param needEmptyTracks Добавлять ли в стрим пустые треки для отключенного видео/аудио
      */
-    function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Запрашивает трансляцию экрана пользователя с опциональным захватом звука
      */
-    function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Запрашивает камеру пользователя
      *
      * @param deviceId ID устройства
      * @param resolution Размеры видео
      */
-    function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Запрашивает микрофон пользователя
      *
      * @param deviceId ID устройства
      */
-    function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?: StatsLogger | null): Promise<MediaStream>;
+    function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
     /**
      * Устанавливает размер видео в стриме
      *
@@ -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

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

package/types/IEventualStatLog.d.ts

@@ -1,6 +1,6 @@
 import Stat from '../enums/Stat';
 export interface IEventualStatLog {
     name: Stat;
-    value?: number | null;
+    value?: number;
     [k: string]: number | string | undefined | null;
 }

package/types/Params.d.ts

@@ -1,2 +1,2 @@
-export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | string;
+export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | 'CALLS_CHELSEA' | 'CALLS_KERZH' | string;
 export type IAPIBaseUrl = string | null;

package/types/PerfStatReporter.d.ts

@@ -43,5 +43,6 @@ export interface ICallStatLog extends Pick<CallStatReport, 'call_topology' | 'na
     video_loss?: number;
     audio_loss?: number;
     cpu_hardware_concurrency?: number;
+    audio_tracks?: number;
     [k: 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;