@vkontakte/calls-sdk 2.8.13-dev.8e54394d.0 → 2.8.13-dev.90f6da61.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 (37) hide show
  1. package/CallsSDK.d.ts +33 -14
  2. package/abstract/BaseApi.d.ts +1 -1
  3. package/calls-sdk.cjs.js +7 -7
  4. package/calls-sdk.esm.js +2687 -2168
  5. package/classes/AudioOutput.d.ts +2 -0
  6. package/classes/CallRegistry.d.ts +17 -4
  7. package/classes/MediaSource.d.ts +5 -0
  8. package/classes/StatsLogger.d.ts +1 -1
  9. package/classes/conversation/Conversation.d.ts +23 -7
  10. package/classes/conversation/Conversation.testUtils.d.ts +1 -0
  11. package/classes/stat/BatteryStats.d.ts +25 -0
  12. package/classes/stat/ClientResourceStats.d.ts +41 -0
  13. package/classes/stat/ConversationStats.d.ts +5 -1
  14. package/classes/stat/NetworkAdaptationStats.d.ts +35 -0
  15. package/classes/stat/SdpStats.d.ts +2 -1
  16. package/classes/stat/StatAggregator.d.ts +3 -1
  17. package/classes/stat/StatEventCollector.d.ts +1 -1
  18. package/classes/stat/StatQueue.d.ts +2 -2
  19. package/classes/transport/DirectTransport.d.ts +5 -0
  20. package/classes/transport/PerfStatReporter.d.ts +5 -1
  21. package/classes/transport/ServerTransport.d.ts +2 -0
  22. package/classes/transport/Transport.d.ts +4 -3
  23. package/classes/transport/VadGate.d.ts +37 -0
  24. package/default/Api.d.ts +3 -0
  25. package/enums/ActiveFeature.d.ts +19 -0
  26. package/enums/Stat.d.ts +2 -0
  27. package/package.json +1 -1
  28. package/static/AuthData.d.ts +11 -1
  29. package/static/BrowserEnvironment.d.ts +90 -0
  30. package/static/External.d.ts +5 -3
  31. package/static/Params.d.ts +13 -5
  32. package/static/WebRTCUtils.d.ts +0 -71
  33. package/types/ClientStatsEvent.d.ts +2 -6
  34. package/types/FastHangup.d.ts +7 -5
  35. package/types/PerfStatReporter.d.ts +26 -1
  36. package/types/SignalingMessage.d.ts +1 -0
  37. package/types/Statistics.d.ts +22 -7
@@ -0,0 +1,90 @@
1
+ /**
2
+ * Определение браузера, операционной системы и доступных возможностей.
3
+ */
4
+ /**
5
+ * Известные браузеры
6
+ */
7
+ export type BrowserName = 'Edge' | 'Chrome' | 'Firefox' | 'Yandex' | 'Opera' | 'Sferum';
8
+ declare namespace BrowserEnvironment {
9
+ /**
10
+ * Получение и кэширование версии операционной системы
11
+ */
12
+ function initOsVersion(warn: (...args: any[]) => void): Promise<void>;
13
+ /**
14
+ * Проверяет поддержку WebRTC браузером
15
+ */
16
+ function isBrowserSupported(): boolean;
17
+ /**
18
+ * Возвращает первую отсутствующую capability в стабильном порядке.
19
+ */
20
+ function getBrowserSupportFailure(): BrowserSupportFailure | null;
21
+ /**
22
+ * Проверяет поддержку шаринга экрана браузером
23
+ */
24
+ function isScreenCapturingSupported(): boolean;
25
+ /**
26
+ * Проверяет поддержку выбора микрофона браузером, независимо от списка устройств и разрешений.
27
+ * Доступен до init, не запрашивает разрешения и не захватывает медиа.
28
+ */
29
+ function canSelectAudioInput(): boolean;
30
+ /**
31
+ * Проверяет поддержку выбора аудиовыхода браузером, независимо от списка устройств и разрешений.
32
+ * Доступен до init, не запрашивает разрешения и не меняет аудиовыход.
33
+ */
34
+ function canSelectAudioOutput(): boolean;
35
+ /**
36
+ * В некоторых браузерах H264 decoder сломан
37
+ */
38
+ function isBrokenH264Decoder(): boolean;
39
+ /**
40
+ * В некоторых браузерах VP9 encoder сломан
41
+ */
42
+ function isBrokenVP9Encoder(): boolean;
43
+ /**
44
+ * В некоторых браузерах VP9 decoder сломан
45
+ */
46
+ function isBrokenVP9Decoder(): boolean;
47
+ /**
48
+ * Может ли браузер делать H264 приоритетным
49
+ */
50
+ function canPreferH264(): boolean;
51
+ /**
52
+ * Поддержка simulcast браузером.
53
+ * Safari корректно поддерживает simulcast начиная с версии 18.
54
+ * Firefox поддерживает simulcast с VP8 начиная с версии 134.
55
+ */
56
+ function isSimulcastSupportedByBrowser(): boolean;
57
+ /**
58
+ * Имя операционной системы
59
+ */
60
+ function os(): string;
61
+ /**
62
+ * Версия операционной системы
63
+ */
64
+ function osVersion(): number | null | undefined;
65
+ /**
66
+ * Мобильный браузер или нет
67
+ */
68
+ function isMobile(): boolean;
69
+ /**
70
+ * Имя браузера
71
+ */
72
+ function browserName(): BrowserName | string;
73
+ /**
74
+ * Версия браузера
75
+ */
76
+ function browserVersion(): string;
77
+ /**
78
+ * Если браузер основан на хроме - возвращает версию
79
+ */
80
+ function baseChromeVersion(): number;
81
+ /**
82
+ * Возвращает подверсию браузера (если она есть)
83
+ */
84
+ function browserSubVersion(): string;
85
+ /**
86
+ * Браузер поддерживает захват звука при трансляции экрана
87
+ */
88
+ function isAudioShareSupported(): boolean;
89
+ }
90
+ export default BrowserEnvironment;
@@ -1,5 +1,5 @@
1
1
  import { IAsrData } from '../types/Asr';
2
- import { ClientStatsEvent, StatsEvent } from '../types/ClientStatsEvent';
2
+ import { ClientStatsEvent } from '../types/ClientStatsEvent';
3
3
  import { ConversationData } from '../types/Conversation';
4
4
  import HangupReason from '../classes/HangupReason';
5
5
  import { MediaTrackKind } from '../classes/MediaSource';
@@ -520,8 +520,6 @@ declare namespace External {
520
520
  * @param data Данные события с `vcid` и `ts`
521
521
  */
522
522
  function onClientStats(data: ClientStatsEvent): void;
523
- /** Синхронно сообщает хосту непериодическое событие до уничтожения звонка. */
524
- function onStatsEvent(event: StatsEvent): void;
525
523
  /**
526
524
  * Ошибка воспроизведения звука
527
525
  */
@@ -637,6 +635,10 @@ declare namespace External {
637
635
  */
638
636
  function onParticipantIdChanged(prevId: ExternalParticipantId, newId: ExternalParticipantId, conversationId?: string): void;
639
637
  function onVideoSuspendSuggest(bandwidth: number, conversationId?: string): void;
638
+ /**
639
+ * Успешно применено первое подключение к сигналингу или переподключение.
640
+ */
641
+ function onSignalingConnected(conversationId: string): void;
640
642
  /**
641
643
  * Одобрено повышение пользователя в зеле ожидания/зале в режиме Audience
642
644
  *
@@ -2,7 +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, StatsEvent } from '../types/ClientStatsEvent';
5
+ import { ClientStatsEvent } from '../types/ClientStatsEvent';
6
6
  import { ConversationData } from '../types/Conversation';
7
7
  import HangupReason from '../classes/HangupReason';
8
8
  import { MediaTrackKind } from '../classes/MediaSource';
@@ -562,7 +562,9 @@ export type ParamsObject = {
562
562
  */
563
563
  forwardEmptyIceCandidate: boolean;
564
564
  /**
565
- * Получен локальный стрим с камеры/микрофона
565
+ * Получен локальный стрим с камеры/микрофона, в том числе до подключения сигналинга.
566
+ * Повторяется после изменения видео (включение, выключение, смена камеры).
567
+ * Повторное событие может содержать тот же MediaStream с обновлёнными треками.
566
568
  */
567
569
  onLocalStream?: (stream: MediaStream | null, mediaSettings: MediaSettings, conversationId?: string) => void;
568
570
  /**
@@ -744,7 +746,8 @@ export type ParamsObject = {
744
746
  onLocalVolume?: (volume: number, isMicEnabled: boolean) => void;
745
747
  onJoinStatus?: (available: boolean, chatId: string, conversationId?: string) => void;
746
748
  /**
747
- * Звонок был завершен
749
+ * Звонок завершён локально. При hangup callback планируется сразу, ровно один раз, без ожидания сети.
750
+ * Доставляется асинхронно; Promise hangup отдельно ждёт известную SDK работу по завершению.
748
751
  */
749
752
  onHangup?: (type: HangupReason | Error, conversationId: string | null) => void;
750
753
  /**
@@ -820,8 +823,6 @@ export type ParamsObject = {
820
823
  * @param data Данные события
821
824
  */
822
825
  onClientStats?: (data: ClientStatsEvent) => void;
823
- /** Получено непериодическое событие статистики SDK. */
824
- onStatsEvent?: (event: StatsEvent) => void;
825
826
  /**
826
827
  * Ошибка воспроизведения звука
827
828
  */
@@ -935,6 +936,13 @@ export type ParamsObject = {
935
936
  * @param bandwidth текущая полоса пропускания, kbps
936
937
  */
937
938
  onVideoSuspendSuggest?: (bandwidth: number, conversationId?: string) => void;
939
+ /**
940
+ * Первое подключение к сигналингу или переподключение успешно применено к состоянию звонка.
941
+ * Звонок зарегистрирован под conversationId, локальное управление доступно, в том числе в зале ожидания.
942
+ * Событие не означает принятие звонка собеседником или готовность WebRTC.
943
+ * Callback вызывается асинхронно; к моменту вызова звонок может уже завершиться.
944
+ */
945
+ onSignalingConnected?: (conversationId: string) => void;
938
946
  /**
939
947
  * Одобрено повышение пользователя в зале ожидания/зале в режиме Audience
940
948
  *
@@ -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;
@@ -1,7 +1,8 @@
1
+ import { StatPayload } from '../classes/stat/StatQueue';
1
2
  /**
2
3
  * Событие статистики SDK, которое получает `onClientStats`
3
4
  */
4
- export type ClientStatsEvent = Record<string, string | number | boolean | null> & {
5
+ export type ClientStatsEvent = StatPayload & {
5
6
  /** Имя события из `Stat`. У периодической статистики звонка его нет */
6
7
  name?: string;
7
8
  /** ID звонка, `null` — пока он неизвестен */
@@ -9,8 +10,3 @@ export type ClientStatsEvent = Record<string, string | number | boolean | null>
9
10
  /** Время события, мс */
10
11
  ts: number;
11
12
  };
12
- /** Событие статистики SDK без служебных полей доставки. */
13
- export type StatsEvent = {
14
- type: string;
15
- payload: Record<string, unknown>;
16
- };
@@ -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>;
@@ -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
  */