@vkontakte/calls-sdk 2.8.13-dev.10d918e8.0 → 2.8.13-dev.1b7a392d.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/CallsSDK.d.ts +35 -14
  2. package/abstract/BaseApi.d.ts +5 -1
  3. package/calls-sdk.cjs.js +7 -7
  4. package/calls-sdk.esm.js +3167 -2326
  5. package/classes/AudioOutput.d.ts +3 -1
  6. package/classes/CallRegistry.d.ts +17 -4
  7. package/classes/MediaSource.d.ts +9 -0
  8. package/classes/StatsLogger.d.ts +1 -1
  9. package/classes/conversation/Conversation.d.ts +24 -7
  10. package/classes/conversation/Conversation.testUtils.d.ts +1 -0
  11. package/classes/stat/ApiCallStats.d.ts +12 -0
  12. package/classes/stat/BatteryStats.d.ts +25 -0
  13. package/classes/stat/CallLifecycleStats.d.ts +4 -1
  14. package/classes/stat/CallStatTail.d.ts +65 -0
  15. package/classes/stat/ClientResourceStats.d.ts +41 -0
  16. package/classes/stat/CodecStatsAggregator.d.ts +4 -1
  17. package/classes/stat/ConversationStats.d.ts +16 -8
  18. package/classes/stat/NetworkAdaptationStats.d.ts +35 -0
  19. package/classes/stat/PeerConnectionStats.d.ts +22 -0
  20. package/classes/stat/SdpStats.d.ts +2 -0
  21. package/classes/stat/Stat.testUtils.d.ts +17 -0
  22. package/classes/stat/StatAggregator.d.ts +11 -2
  23. package/classes/stat/StatDrainScheduler.d.ts +34 -13
  24. package/classes/stat/StatEventCollector.d.ts +7 -12
  25. package/classes/stat/StatPings.d.ts +5 -1
  26. package/classes/stat/StatQueue.d.ts +42 -3
  27. package/classes/stat/StatSignalingCommands.d.ts +3 -1
  28. package/classes/transport/DirectTransport.d.ts +6 -0
  29. package/classes/transport/PerfStatReporter.d.ts +7 -1
  30. package/classes/transport/ServerTransport.d.ts +3 -0
  31. package/default/Api.d.ts +3 -0
  32. package/default/Signaling.d.ts +9 -1
  33. package/default/SignalingTransport.d.ts +5 -1
  34. package/enums/ActiveFeature.d.ts +19 -0
  35. package/enums/Stat.d.ts +14 -1
  36. package/package.json +1 -1
  37. package/static/AuthData.d.ts +11 -1
  38. package/static/BrowserEnvironment.d.ts +90 -0
  39. package/static/External.d.ts +11 -0
  40. package/static/Params.d.ts +31 -2
  41. package/static/SimulcastInfo.d.ts +1 -0
  42. package/static/WebRTCUtils.d.ts +0 -71
  43. package/types/ClientStatsEvent.d.ts +12 -0
  44. package/types/FastHangup.d.ts +7 -5
  45. package/types/IEventualStatLog.d.ts +1 -1
  46. package/types/Params.d.ts +1 -1
  47. package/types/PerfStatReporter.d.ts +26 -1
  48. package/types/SignalingMessage.d.ts +1 -0
  49. package/types/Statistics.d.ts +22 -7
  50. package/classes/stat/StatUnloadJournal.d.ts +0 -27
@@ -2,6 +2,7 @@ import type { VideoEffects } from '@vkontakte/calls-video-effects';
2
2
  import type { EffectVoiceChange, VadControllerOptions, VadLib } from '@vkontakte/calls-audio-effects';
3
3
  import type * as Vmoji from '@vkontakte/calls-vmoji';
4
4
  import { IAsrData } from '../types/Asr';
5
+ import { ClientStatsEvent } from '../types/ClientStatsEvent';
5
6
  import { ConversationData } from '../types/Conversation';
6
7
  import HangupReason from '../classes/HangupReason';
7
8
  import { MediaTrackKind } from '../classes/MediaSource';
@@ -114,6 +115,8 @@ export type ParamsObject = {
114
115
  /** @hidden */
115
116
  signalingReconnectMaxCount: number;
116
117
  /** @hidden */
118
+ signalingReconnectMaxDuration: number;
119
+ /** @hidden */
117
120
  waitConnectionDelay: number;
118
121
  /** @hidden */
119
122
  waitResponseDelay: number;
@@ -297,6 +300,13 @@ export type ParamsObject = {
297
300
  perfStatReportEnabled: boolean;
298
301
  /** @hidden */
299
302
  callStatReportEnabled: boolean;
303
+ /**
304
+ * Отправлять событие статистики ice_candidate_gathering_failed
305
+ *
306
+ * _По умолчанию: `false`_
307
+ * @hidden
308
+ */
309
+ iceCandidateErrorStatEnabled: boolean;
300
310
  /**
301
311
  * Отдавать приоритет кодеку H264 для исходящего видео
302
312
  *
@@ -552,7 +562,9 @@ export type ParamsObject = {
552
562
  */
553
563
  forwardEmptyIceCandidate: boolean;
554
564
  /**
555
- * Получен локальный стрим с камеры/микрофона
565
+ * Получен локальный стрим с камеры/микрофона, в том числе до подключения сигналинга.
566
+ * Повторяется после изменения видео (включение, выключение, смена камеры).
567
+ * Повторное событие может содержать тот же MediaStream с обновлёнными треками.
556
568
  */
557
569
  onLocalStream?: (stream: MediaStream | null, mediaSettings: MediaSettings, conversationId?: string) => void;
558
570
  /**
@@ -734,7 +746,8 @@ export type ParamsObject = {
734
746
  onLocalVolume?: (volume: number, isMicEnabled: boolean) => void;
735
747
  onJoinStatus?: (available: boolean, chatId: string, conversationId?: string) => void;
736
748
  /**
737
- * Звонок был завершен
749
+ * Звонок завершён локально. При hangup callback планируется сразу, ровно один раз, без ожидания сети.
750
+ * Доставляется асинхронно; Promise hangup отдельно ждёт известную SDK работу по завершению.
738
751
  */
739
752
  onHangup?: (type: HangupReason | Error, conversationId: string | null) => void;
740
753
  /**
@@ -804,6 +817,12 @@ export type ParamsObject = {
804
817
  * Статистика звонка
805
818
  */
806
819
  onStatistics?: (stats: {}) => void;
820
+ /**
821
+ * Событие статистики SDK: те же данные, что уходят в статистику звонков, плюс `vcid` и `ts`
822
+ *
823
+ * @param data Данные события
824
+ */
825
+ onClientStats?: (data: ClientStatsEvent) => void;
807
826
  /**
808
827
  * Ошибка воспроизведения звука
809
828
  */
@@ -917,6 +936,13 @@ export type ParamsObject = {
917
936
  * @param bandwidth текущая полоса пропускания, kbps
918
937
  */
919
938
  onVideoSuspendSuggest?: (bandwidth: number, conversationId?: string) => void;
939
+ /**
940
+ * Первое подключение к сигналингу или переподключение успешно применено к состоянию звонка.
941
+ * Звонок зарегистрирован под conversationId, локальное управление доступно, в том числе в зале ожидания.
942
+ * Событие не означает принятие звонка собеседником или готовность WebRTC.
943
+ * Callback вызывается асинхронно; к моменту вызова звонок может уже завершиться.
944
+ */
945
+ onSignalingConnected?: (conversationId: string) => void;
920
946
  /**
921
947
  * Одобрено повышение пользователя в зале ожидания/зале в режиме Audience
922
948
  *
@@ -1000,6 +1026,7 @@ export default abstract class Params {
1000
1026
  static get signalingReconnectDelay(): number;
1001
1027
  static get signalingReconnectMaxDelay(): number;
1002
1028
  static get signalingReconnectMaxCount(): number;
1029
+ static get signalingReconnectMaxDuration(): number;
1003
1030
  static get waitConnectionDelay(): number;
1004
1031
  static get waitResponseDelay(): number;
1005
1032
  static get waitMessageDelay(): number;
@@ -1049,6 +1076,7 @@ export default abstract class Params {
1049
1076
  static get networkStatisticsInterval(): number;
1050
1077
  static get perfStatReportEnabled(): boolean;
1051
1078
  static get callStatReportEnabled(): boolean;
1079
+ static get iceCandidateErrorStatEnabled(): boolean;
1052
1080
  static get enableLogPerfStatReport(): boolean;
1053
1081
  static get asrDataChannel(): boolean;
1054
1082
  static get consumerScreenDataChannelPacketSize(): number;
@@ -1120,6 +1148,7 @@ export default abstract class Params {
1120
1148
  videoSuspend: boolean;
1121
1149
  debugLog: boolean;
1122
1150
  callStatReportEnabled: boolean;
1151
+ iceCandidateErrorStatEnabled: boolean;
1123
1152
  joinFromMultipleDevices: boolean;
1124
1153
  movieShare: boolean;
1125
1154
  clientType: string;
@@ -4,6 +4,7 @@ export declare const SIMULCAST_DEFAULT: {
4
4
  HEIGHT: number;
5
5
  WIDTH: number;
6
6
  BITRATE: number;
7
+ FPS: number;
7
8
  };
8
9
  export declare const SIMULCAST_SCALABILITY_MODE = "L1T2";
9
10
  export declare function isEqualSimulcastInfo(si1: ISimulcastInfo | null, si2: ISimulcastInfo | null): boolean;
@@ -17,10 +17,6 @@ export declare enum FacingMode {
17
17
  */
18
18
  ENVIRONMENT = "environment"
19
19
  }
20
- /**
21
- * Известные браузеры
22
- */
23
- export type BrowserName = 'Edge' | 'Chrome' | 'Firefox' | 'Yandex' | 'Opera' | 'Sferum';
24
20
  declare namespace WebRTCUtils {
25
21
  /**
26
22
  * До вызова этого метода бесполезно опрашивать другие публичные методы.
@@ -118,76 +114,9 @@ declare namespace WebRTCUtils {
118
114
  * Возвращает фейковый видео mediaTrack
119
115
  */
120
116
  function getBlackMediaTrack(width?: number, height?: number): MediaStreamTrack;
121
- /**
122
- * Проверяет поддержку WebRTC браузером
123
- */
124
- function isBrowserSupported(): boolean;
125
- /**
126
- * Возвращает первую отсутствующую capability в стабильном порядке.
127
- */
128
- function getBrowserSupportFailure(): BrowserSupportFailure | null;
129
- /**
130
- * Проверяет поддержку шаринга экрана браузером
131
- */
132
- function isScreenCapturingSupported(): boolean;
133
- /**
134
- * В некоторых браузерах H264 decoder сломан
135
- */
136
- function isBrokenH264Decoder(): boolean;
137
- /**
138
- * В некоторых браузерах VP9 encoder сломан
139
- * В симулкасте вп9 енкодер ведет себя некорректно
140
- */
141
- function isBrokenVP9Encoder(): boolean;
142
- /**
143
- * В некоторых браузерах VP9 decoder сломан
144
- */
145
- function isBrokenVP9Decoder(): boolean;
146
- /**
147
- * Может ли браузер делать H264 приоритетным
148
- */
149
- function canPreferH264(): boolean;
150
- /**
151
- * Поддержка simulcast браузером.
152
- * Safari корректно поддерживает simulcast начиная с версии 18.
153
- * Firefox поддерживает simulcast с VP8 начиная с версии 134.
154
- */
155
- function isSimulcastSupportedByBrowser(): boolean;
156
- /**
157
- * Имя операционной системы
158
- */
159
- function os(): string;
160
- /**
161
- * Версия операционной системы
162
- */
163
- function osVersion(): number | null | undefined;
164
- /**
165
- * Мобильный браузер или нет
166
- */
167
- function isMobile(): boolean;
168
- /**
169
- * Имя браузера
170
- */
171
- function browserName(): BrowserName | string;
172
- /**
173
- * Версия браузера
174
- */
175
- function browserVersion(): string;
176
- /**
177
- * Если браузер основан на хроме - возвращает версию
178
- */
179
- function baseChromeVersion(): number;
180
117
  /**
181
118
  * Возвращает AudioContext
182
119
  */
183
120
  function getAudioContext(): AudioContext;
184
- /**
185
- * Возвращает подверсию браузера (если она есть)
186
- */
187
- function browserSubVersion(): string;
188
- /**
189
- * Браузер поддерживает захват звука при трансляции экрана
190
- */
191
- function isAudioShareSupported(): boolean;
192
121
  }
193
122
  export default WebRTCUtils;
@@ -0,0 +1,12 @@
1
+ import { StatPayload } from '../classes/stat/StatQueue';
2
+ /**
3
+ * Событие статистики SDK, которое получает `onClientStats`
4
+ */
5
+ export type ClientStatsEvent = StatPayload & {
6
+ /** Имя события из `Stat`. У периодической статистики звонка его нет */
7
+ name?: string;
8
+ /** ID звонка, `null` — пока он неизвестен */
9
+ vcid: string | null;
10
+ /** Время события, мс */
11
+ ts: number;
12
+ };
@@ -34,13 +34,15 @@ export interface FastHangupResponse {
34
34
  *
35
35
  * `reason` и `conversationId` идут в signaling hangup.
36
36
  * `onFastHangup` заменяет Calls API `vchat.hangupConversation`, если обработчик передан
37
- * (явный hangup/decline или delayed hangup во время init).
38
- * Если обработчик не передан, API hangup не вызывается — кроме закрытия вкладки (`pagehide`),
39
- * где SDK всегда шлёт beacon, и delayed hangup без handler.
37
+ * (явный hangup/decline, включая отмену инициализации).
38
+ * При `hangup` без обработчика SDK отправляет Calls API beacon, если серверный ID уже известен.
39
+ * При `declineCall` без обработчика остаётся только signaling hangup.
40
+ * На закрытии вкладки (`pagehide`) SDK всегда использует beacon вместо обработчика.
40
41
  */
41
42
  export interface HangupParams {
42
43
  /**
43
- * ID звонка. Если опущен — завершается текущий активный звонок.
44
+ * Текущий или исходный ID для локального hangup; declineCall требует текущий ID готового звонка.
45
+ * Без ID: активный готовый, затем первый готовый, а для hangup — также единственный готовящийся звонок.
44
46
  */
45
47
  conversationId?: string;
46
48
  /**
@@ -61,6 +63,6 @@ export interface HangupParams {
61
63
  * На `pagehide` не используется — SDK всегда отправляет `sendBeacon`.
62
64
  *
63
65
  * @param params Параметры запроса
64
- * @param signal AbortSignal текущего звонка, если он ещё жив на момент вызова
66
+ * @param signal При `hangup` — отдельный AbortSignal завершения, при `declineCall` — сигнал текущего звонка, если он есть
65
67
  */
66
68
  export type FastHangupHandler = (params: FastHangupParams, signal?: AbortSignal) => Promise<FastHangupResponse>;
@@ -1,6 +1,6 @@
1
1
  import Stat from '../enums/Stat';
2
2
  export interface IEventualStatLog {
3
3
  name: Stat;
4
- value?: number | null;
4
+ value?: number;
5
5
  [k: string]: number | string | undefined | null;
6
6
  }
package/types/Params.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | string;
1
+ export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | 'CALLS_CHELSEA' | 'CALLS_KERZH' | string;
2
2
  export type IAPIBaseUrl = string | null;
@@ -40,8 +40,33 @@ export interface ICallStatLog extends Pick<CallStatReport, 'call_topology' | 'na
40
40
  is_simulcast?: boolean;
41
41
  concealed_silent_audio_samples?: number;
42
42
  concealment_audio_avg_size?: number;
43
+ /** Потери исходящего видео: 100 * ΣΔpacketsLost / (ΣΔpacketsLost + ΣΔpacketsSent), по парам SSRC со свежим RR */
43
44
  video_loss?: number;
45
+ /** Потери исходящего аудио: 100 * ΣΔpacketsLost / (ΣΔpacketsLost + ΣΔpacketsSent), по парам SSRC со свежим RR */
44
46
  audio_loss?: number;
47
+ /** Потери входящего видео за период, в процентах */
48
+ in_video_loss?: number;
49
+ /** Потери входящего аудио за период, в процентах */
50
+ in_audio_loss?: number;
51
+ /** Байты, отправленные по исходящим аудио потокам за период, включая шару звука */
52
+ audio_bytes_sent?: number;
53
+ /** Уровень исходящего звука в шкале 16-битного PCM, от 0 до 32767 */
54
+ audio_level?: number;
55
+ /** Битрейт исходящего видео без ретрансмитов, кибибит/с */
56
+ br_encode?: number;
57
+ /** Битрейт отправки видео камеры, кибибит/с */
58
+ br_transmit?: number;
59
+ /** Битрейт ретрансмитов видео камеры, кибибит/с */
60
+ br_retransmit?: number;
61
+ /** Кадры камеры, закодированные энкодером за период */
62
+ frames_encoded?: number;
45
63
  cpu_hardware_concurrency?: number;
46
- [k: string]: string | number | boolean | undefined;
64
+ audio_tracks?: number;
65
+ /** Максимум участников за интервал между отправками */
66
+ participants_max?: number;
67
+ /** Фичи, включенные в любой момент интервала */
68
+ active_features?: string[];
69
+ /** Максимальная площадь окна приложения за интервал, в мегапикселях */
70
+ app_total_area_mpx_max?: number;
71
+ [k: string]: string | string[] | number | boolean | undefined;
47
72
  }
@@ -198,6 +198,7 @@ declare namespace SignalingMessage {
198
198
  reason: HangupType;
199
199
  errorCode?: string;
200
200
  markers?: ParticipantListMarkers;
201
+ externalId?: ExternalId;
201
202
  }
202
203
  export interface ClosedConversation extends Notification {
203
204
  reason: HangupType;
@@ -36,8 +36,14 @@ interface StatRtpOutboundVideo {
36
36
  framesSent?: number;
37
37
  framesPerSecond?: number;
38
38
  targetBitrate?: number;
39
+ /**
40
+ * Общее количество кадров, закодированных энкодером
41
+ */
42
+ framesEncoded?: number;
39
43
  }
40
44
  export interface StatRtp extends StatRtpOutboundVideo {
45
+ /** Время измерения, для remote-inbound-rtp — время получения RTCP Receiver Report */
46
+ timestamp: number;
41
47
  /**
42
48
  * Уникальный идентификатор источника синхронизации RTP
43
49
  */
@@ -65,6 +71,10 @@ export interface StatRtp extends StatRtpOutboundVideo {
65
71
  * Общее количество байтов, отправленных по этому потоку
66
72
  */
67
73
  bytesSent: number;
74
+ /**
75
+ * Общее количество байтов, отправленных повторно (ретрансмиты) по этому потоку
76
+ */
77
+ retransmittedBytesSent?: number;
68
78
  /**
69
79
  * Общее количество байтов заголовков, полученных по этому потоку
70
80
  */
@@ -73,6 +83,11 @@ export interface StatRtp extends StatRtpOutboundVideo {
73
83
  * Общее количество байтов заголовков, отправленных по этому потоку
74
84
  */
75
85
  headerBytesSent: number;
86
+ /**
87
+ * Уровень звука исходящего аудио потока в момент снятия статистики, от 0 до 1.
88
+ * Берется из media-source, у входящих потоков его нет.
89
+ */
90
+ audioLevel?: number;
76
91
  /**
77
92
  * Среднее значение джиттера в секундах
78
93
  * Джиттер — это вариация задержки в получении пакетов данных.
@@ -81,19 +96,15 @@ export interface StatRtp extends StatRtpOutboundVideo {
81
96
  /**
82
97
  * Общее количество потерянных пакетов
83
98
  */
84
- packetsLost: number;
99
+ packetsLost?: number;
85
100
  /**
86
101
  * Общее количество полученных пакетов
87
102
  */
88
- packetsReceived: number;
103
+ packetsReceived?: number;
89
104
  /**
90
105
  * Общее количество отправленных пакетов
91
106
  */
92
- packetsSent: number;
93
- /**
94
- * Доля потерянных пакетов
95
- */
96
- fractionLost: number;
107
+ packetsSent?: number;
97
108
  /**
98
109
  * Количество Picture Loss Indication (PLI) сообщений
99
110
  * PLI — это сообщения, указывающие на потерю кадров изображения.
@@ -113,6 +124,10 @@ export interface StatRtp extends StatRtpOutboundVideo {
113
124
  * Идентификатор пользователя, связанный с этим потоком
114
125
  */
115
126
  userId?: string;
127
+ /**
128
+ * Поток демонстрации экрана (быстрая шара), а не камеры
129
+ */
130
+ isScreenShare?: boolean;
116
131
  /**
117
132
  * Пропускная способность в битах в секунду
118
133
  */
@@ -1,27 +0,0 @@
1
- import { StatQueueEntry } from './StatQueue';
2
- /**
3
- * Синхронный журнал умирающей вкладки поверх localStorage: транзакция
4
- * IndexedDB из pagehide не успевает закоммититься. Следующий старт SDK
5
- * переносит журнал в очередь. Ключ уникален на вкладку.
6
- */
7
- export default abstract class StatUnloadJournal {
8
- private static _tabKey;
9
- private static _entries;
10
- /**
11
- * Открывает новый журнал для этой вкладки. Без сброса пережившая pagehide
12
- * вкладка записала бы во второй журнал уже перенесённые события.
13
- */
14
- static beginTabSession(): void;
15
- static writeSync(entry: StatQueueEntry): boolean;
16
- /**
17
- * Переносит журналы всех закрытых вкладок в очередь. Журнал стирается
18
- * независимо от исхода: повторные попытки дали бы дубли.
19
- *
20
- * @returns число перенесённых событий.
21
- */
22
- static drainToQueue(): Promise<number>;
23
- /** Читает журнал и сразу удаляет его. null — ключа уже нет или хранилище недоступно. */
24
- private static _take;
25
- private static _storage;
26
- private static _isValidEntry;
27
- }