@vkontakte/calls-sdk 2.8.13-dev.8011fb16.0 → 2.8.13-dev.81c10b88.0

package/classes/AudioOutput.d.ts

@@ -8,7 +8,7 @@ import { StatFirstMediaReceived } from './stat/StatFirstMediaReceived';
 export default class AudioOutput {
     protected _audioElement: HTMLAudioElement | null;
     protected readonly _debug: DebugLogger;
-    private readonly _preparedAudioElement;
+    private _preparedAudioElement;
     private _audioTracks;
     private readonly _allowMultipleTracks;
     private _volume;

package/classes/stat/ApiCallStats.d.ts

@@ -0,0 +1,12 @@
+import { StatAggregator } from './StatAggregator';
+/** Отправляет в стату время выполнения запросов к API */
+export declare class ApiCallStats {
+    private readonly _statAggregator;
+    constructor(statAggregator: StatAggregator | null);
+    /**
+     * @param method название метода API, например `vchat.getConversationParams`
+     * @param duration время от запроса до ответа, мс
+     * @param error описание ошибки, если запрос не удался
+     */
+    log(method: string, duration: number, error?: string): void;
+}

package/classes/stat/ConversationStats.d.ts

@@ -3,6 +3,7 @@ import BaseLogger from '../../abstract/BaseLogger';
 import TransportTopology from '../../enums/TransportTopology';
 import HangupReason from '../HangupReason';
 import StatEventCollector from './StatEventCollector';
+import { ApiCallStats } from './ApiCallStats';
 import { CallLifecycleStats } from './CallLifecycleStats';
 import { CodecStatsAggregator } from './CodecStatsAggregator';
 import { StatAggregator } from './StatAggregator';
@@ -15,6 +16,8 @@ export declare class ConversationStats {
     readonly codecStatsAggregator: CodecStatsAggregator;
     readonly pings: StatPings;
     readonly signalingCommands: StatSignalingCommands;
+    readonly apiCalls: ApiCallStats;
+    private readonly _api;
     private _unloading;
     constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined);
     /**

package/classes/stat/PeerConnectionStats.d.ts

@@ -0,0 +1,22 @@
+import { StatAggregator } from './StatAggregator';
+/** Стата жизненного цикла RTCPeerConnection */
+export declare class PeerConnectionStats {
+    private readonly _statAggregator;
+    private _pc;
+    private _lastSignalingStateChange;
+    private _lastGatheringStateChange;
+    private _lastConnectionState;
+    private readonly _handleConnectionStateChange;
+    private readonly _handleSignalingStateChange;
+    private readonly _handleGatheringStateChange;
+    private readonly _handleIceCandidateError;
+    constructor(statAggregator: StatAggregator | null);
+    observe(pc: RTCPeerConnection): void;
+    /** Вызывать перед закрытием соединения: отсюда уходят последнее состояние и closed */
+    stop(): void;
+    logIceRestart(): void;
+    logIceCandidateAddFailed(candidate: RTCIceCandidateInit, error: unknown): void;
+    private _sinceLastChange;
+    private _logConnectionState;
+    private _log;
+}

package/classes/stat/SdpStats.d.ts

@@ -0,0 +1,38 @@
+import { StatAggregator } from './StatAggregator';
+type SdpDescription = {
+    type: RTCSdpType;
+    sdp?: string;
+};
+/**
+ * Отправляет в стату согласование SDP: что сгенерировали, что получили от собеседника
+ * и на какой операции сломались.
+ */
+export declare class SdpStats {
+    private readonly _statAggregator;
+    private _pc;
+    private _gatheringStartedAt;
+    private _remoteSdpReceivedAt;
+    private readonly _handleGatheringStateChange;
+    constructor(statAggregator: StatAggregator | null);
+    /** Начинает следить за сбором кандидатов, предыдущее соединение перестает слушать */
+    observe(pc: RTCPeerConnection): void;
+    stop(): void;
+    /** Сгенерировали свой SDP */
+    logSdpGenerated(type: RTCSdpType): void;
+    /** Собрали свой ICE-кандидат */
+    logCandidateGenerated(candidate: RTCIceCandidate): void;
+    /** Получили SDP от собеседника */
+    logSdpReceived(type: RTCSdpType): void;
+    /** Получили ICE-кандидата от собеседника */
+    logCandidateReceived(candidate: RTCIceCandidateInit): void;
+    /** Не смогли сгенерировать SDP */
+    logCreateFailed(type: RTCSdpType, error: unknown): void;
+    /** Не смогли применить свой SDP */
+    logSetLocalFailed(sdp: SdpDescription, error: unknown): void;
+    /** Не смогли применить SDP собеседника */
+    logSetRemoteFailed(sdp: SdpDescription, error: unknown): void;
+    destroy(): void;
+    private _logFailure;
+    private _log;
+}
+export {};

package/classes/stat/StatAggregator.d.ts

@@ -7,8 +7,15 @@ export declare class StatAggregator {
     private _lastCallStatContext;
     constructor(logger: StatEventCollector);
     logCallStat(params: ICallStatLog): void;
-    /** @link https://wiki.odkl.ru/pages/viewpage.action?pageId=100892588 */
+    /**
+     * Событие уходит с теми полями, что переданы. Без value — уходит без value.
+     * @link https://wiki.odkl.ru/pages/viewpage.action?pageId=100892588
+     */
     logEventualStat(params: IEventualStatLog): void;
+    /** value — время от метки с тем же именем, что у события. Метки нет — событие не отправляем. */
+    logEventualStatSinceMark(params: IEventualStatLog & {
+        value?: never;
+    }): void;
     destroy(): void;
     private _getCallStatContext;
     private _flushEventualStats;

package/classes/transport/DirectTransport.d.ts

@@ -39,6 +39,8 @@ export default class DirectTransport extends BaseTransport {
     private _lastBadConnection;
     private _perfStatReporter;
     private _directStatReporter;
+    private readonly _sdpStats;
+    private readonly _peerConnectionStats;
     private readonly _debug;
     private readonly _logger;
     private readonly _statAggregator;

package/classes/transport/PerfStatReporter.d.ts

@@ -10,6 +10,7 @@ export default class PerfStatReporter extends EventEmitter {
     private _previousCallStatReportTimestamp;
     private _previousCallStatReport;
     private _previousRemoteInboundRtps;
+    private _previousCandidatePair;
     private _screenShareStats;
     private _signaling;
     private readonly _directTopology;
@@ -22,6 +23,7 @@ export default class PerfStatReporter extends EventEmitter {
     private reportPerfStats;
     private reportNetworkStats;
     private _reportCallStats;
+    private _reportCandidatePair;
     private _calculatePacketLoss;
     private _handleScreenSharingStat;
     private _handleTransportStateChanged;

package/classes/transport/ServerTransport.d.ts

@@ -45,6 +45,8 @@ export default class ServerTransport extends BaseTransport {
     private readonly _debug;
     private readonly _logger;
     private readonly _statAggregator;
+    private readonly _sdpStats;
+    private readonly _peerConnectionStats;
     private readonly _codecStatsAggregator;
     private readonly _simulcast;
     constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);

package/default/Signaling.d.ts

@@ -42,6 +42,8 @@ export default class Signaling extends BaseSignaling {
     private connected;
     private listenersReady;
     private peerId;
+    /** Когда началась череда падений соединения, от неё считаем *_timeout */
+    private reconnectStartedAt;
     private connectionMessageWaitTimer;
     private participantIdRegistry;
     private producerNotificationDataChannel;
@@ -164,7 +166,8 @@ export default class Signaling extends BaseSignaling {
     private _handleCachedMessages;
     private _throwError;
     private _onError;
-    private _serializeErrorEvent;
+    /** Причина ошибки для статы: короткий читаемый текст */
+    private _describeErrorEvent;
     private _onClose;
     private _terminate;
     private _fail;
@@ -182,10 +185,15 @@ export default class Signaling extends BaseSignaling {
     private _onTransportConnecting;
     private _onTransportFailed;
     private _onTransportReconnectScheduled;
+    /** Попыток восстановить соединение больше не будет: отправляем, сколько длилась череда падений */
+    private _logReconnectTimeout;
     private _onTransportConnectionDead;
     private _attachNotificationCallError;
     private _createSignalingCallError;
     private _getSocketType;
     private _markTransportStat;
+    /** Событие уходит с переданными полями, без value — уходит без value */
     private _logTransportStat;
+    /** value — время от метки, поставленной в _markTransportStat; метки нет — событие не отправляем */
+    private _logTransportStatSinceMark;
 }

package/enums/Stat.d.ts

@@ -1,4 +1,7 @@
-declare const enum Stat {
+/**
+ * Имена событий статистики — поле `name` в данных `onClientStats`
+ */
+declare enum Stat {
     CALL_INIT = "call_init",
     CALL_START = "call_start",
     CALL_ACCEPTED_OUTGOING = "call_accepted_outgoing",
@@ -14,6 +17,26 @@ declare const enum Stat {
     USER_FEEDBACK_RECEIVED = "UserFeedbackReceived",
     SIGNALING_PING_SUMMARY = "signaling_ping_summary",
     SIGNALING_COMMAND_SUMMARY = "signaling_command_summary",
+    API_CALL = "api_call",
+    CONNECTION_STATE_CHANGED = "connection_state_changed",
+    SIGNALING_STATE_CHANGED = "signaling_state_changed",
+    GATHERING_STATE_CHANGED = "gathering_state_changed",
+    ICE_RESTART = "ice_restart",
+    ICE_CANDIDATES_CHANGED = "ice_candidates_changed",
+    ICE_CANDIDATE_GATHERING_FAILED = "ice_candidate_gathering_failed",
+    ICE_CANDIDATE_ADD_FAILED = "ice_candidate_add_failed",
+    SDP_CREATE_OFFER = "sdp_create_offer",
+    SDP_CREATE_ANSWER = "sdp_create_answer",
+    SDP_SET_LOCAL_OFFER = "sdp_set_local_offer",
+    SDP_SET_LOCAL_PRANSWER = "sdp_set_local_pranswer",
+    SDP_SET_LOCAL_ANSWER = "sdp_set_local_answer",
+    SDP_SET_LOCAL_ROLLBACK = "sdp_set_local_rollback",
+    SDP_SET_REMOTE_OFFER = "sdp_set_remote_offer",
+    SDP_SET_REMOTE_PRANSWER = "sdp_set_remote_pranswer",
+    SDP_SET_REMOTE_ANSWER = "sdp_set_remote_answer",
+    SDP_SET_REMOTE_ROLLBACK = "sdp_set_remote_rollback",
+    SDP_GENERATED = "sdp_generated",
+    SDP_RECEIVED = "sdp_received",
     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.8011fb16.0",
+  "version": "2.8.13-dev.81c10b88.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/static/External.d.ts

@@ -1,4 +1,5 @@
 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';
@@ -513,6 +514,12 @@ declare namespace External {
      * @param memory Статистика памяти
      */
     function onStatistics(connection: StatResult, memory: Record<string, number>): void;
+    /**
+     * Событие статистики SDK
+     *
+     * @param data Данные события с `vcid` и `ts`
+     */
+    function onClientStats(data: ClientStatsEvent): void;
     /**
      * Ошибка воспроизведения звука
      */

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';
@@ -297,6 +298,13 @@ export type ParamsObject = {
     perfStatReportEnabled: boolean;
     /** @hidden */
     callStatReportEnabled: boolean;
+    /**
+     * Отправлять событие статистики ice_candidate_gathering_failed
+     *
+     * _По умолчанию: `false`_
+     * @hidden
+     */
+    iceCandidateErrorStatEnabled: boolean;
     /**
      * Отдавать приоритет кодеку H264 для исходящего видео
      *
@@ -804,6 +812,12 @@ export type ParamsObject = {
      * Статистика звонка
      */
     onStatistics?: (stats: {}) => void;
+    /**
+     * Событие статистики SDK: те же данные, что уходят в статистику звонков, плюс `vcid` и `ts`
+     *
+     * @param data Данные события
+     */
+    onClientStats?: (data: ClientStatsEvent) => void;
     /**
      * Ошибка воспроизведения звука
      */
@@ -1049,6 +1063,7 @@ export default abstract class Params {
     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;
@@ -1120,6 +1135,7 @@ export default abstract class Params {
         videoSuspend: boolean;
         debugLog: boolean;
         callStatReportEnabled: boolean;
+        iceCandidateErrorStatEnabled: boolean;
         joinFromMultipleDevices: boolean;
         movieShare: boolean;
         clientType: string;

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/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;
 }