@vkontakte/calls-sdk 2.8.13-dev.48bea36c.0 → 2.8.13-dev.49da331a.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 (38) hide show
  1. package/CallsSDK.d.ts +26 -10
  2. package/abstract/BaseApi.d.ts +1 -1
  3. package/calls-sdk.cjs.js +7 -7
  4. package/calls-sdk.esm.js +3338 -2860
  5. package/classes/AudioOutput.d.ts +2 -0
  6. package/classes/MediaSource.d.ts +3 -0
  7. package/classes/StatsLogger.d.ts +1 -1
  8. package/classes/conversation/Conversation.d.ts +7 -1
  9. package/classes/stat/BatteryStats.d.ts +25 -0
  10. package/classes/stat/CallLifecycleStats.d.ts +10 -1
  11. package/classes/stat/CallStatTail.d.ts +76 -0
  12. package/classes/stat/ClientResourceStats.d.ts +41 -0
  13. package/classes/stat/CodecStatsAggregator.d.ts +4 -1
  14. package/classes/stat/ConversationStats.d.ts +16 -5
  15. package/classes/stat/NetworkAdaptationStats.d.ts +35 -0
  16. package/classes/stat/SdpStats.d.ts +2 -1
  17. package/classes/stat/StatAggregator.d.ts +3 -1
  18. package/classes/stat/StatDrainScheduler.d.ts +13 -0
  19. package/classes/stat/StatEventCollector.d.ts +13 -8
  20. package/classes/stat/StatPings.d.ts +3 -1
  21. package/classes/stat/StatQueue.d.ts +42 -3
  22. package/classes/stat/StatSignalingCommands.d.ts +3 -1
  23. package/classes/transport/DirectTransport.d.ts +5 -0
  24. package/classes/transport/PerfStatReporter.d.ts +5 -1
  25. package/classes/transport/ServerTransport.d.ts +2 -0
  26. package/default/Api.d.ts +3 -0
  27. package/enums/ActiveFeature.d.ts +19 -0
  28. package/enums/Stat.d.ts +2 -0
  29. package/package.json +1 -1
  30. package/static/AuthData.d.ts +11 -1
  31. package/static/BrowserEnvironment.d.ts +90 -0
  32. package/static/External.d.ts +1 -3
  33. package/static/Params.d.ts +0 -2
  34. package/static/WebRTCUtils.d.ts +0 -71
  35. package/types/PerfStatReporter.d.ts +26 -1
  36. package/types/SignalingMessage.d.ts +1 -0
  37. package/types/Statistics.d.ts +22 -7
  38. package/classes/stat/StatUnloadJournal.d.ts +0 -27
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Фичи, активные во время звонка. Уходят в метрику active_features,
3
+ * чтобы по ним разрезать остальную статистику: сколько фризов при включённой камере,
4
+ * какой битрейт при шаре и так далее.
5
+ *
6
+ * Здесь только то, что реально включено прямо сейчас, а не то, что разрешено настройками:
7
+ * иначе фича попадала бы в метрику у всех, кому ее просто не запретили.
8
+ *
9
+ * Сервер принимает только имена из своего списка, незнакомые отбрасывает с ошибкой.
10
+ * Новое имя добавляем сюда после того, как его добавят на сервере.
11
+ */
12
+ declare enum ActiveFeature {
13
+ MICROPHONE = "MICROPHONE",
14
+ CAMERA = "CAMERA",
15
+ /** Любая шара экрана, в том числе быстрая */
16
+ SCREEN = "SCREEN",
17
+ ANIMOJI = "ANIMOJI"
18
+ }
19
+ export default ActiveFeature;
package/enums/Stat.d.ts CHANGED
@@ -37,6 +37,8 @@ declare enum Stat {
37
37
  SDP_SET_REMOTE_ROLLBACK = "sdp_set_remote_rollback",
38
38
  SDP_GENERATED = "sdp_generated",
39
39
  SDP_RECEIVED = "sdp_received",
40
+ CLIENT_REQUESTED_SERVER_TOPOLOGY = "client_requested_server_topology",
41
+ VIDEO_ENCODER_CHANGED_BY_NETWORK_ADAPTER = "video_encoder_changed_by_network_adapter",
40
42
  WEBSOCKET_CONNECTED = "websocket_connected",
41
43
  WEBSOCKET_RECONNECTED = "websocket_reconnected",
42
44
  WEBSOCKET_FAILED_PINGS = "websocket_failed_pings",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vkontakte/calls-sdk",
3
- "version": "2.8.13-dev.48bea36c.0",
3
+ "version": "2.8.13-dev.49da331a.0",
4
4
  "author": "vk.com",
5
5
  "description": "Library for video calls based on the vk.com platform",
6
6
  "homepage": "https://vk.com",
@@ -1,9 +1,16 @@
1
- import type { OkUserId } from '../types/Participant';
1
+ import type { ExternalParticipantId } from '../types/ExternalId';
2
+ import type { OkUserId, ParticipantId } from '../types/Participant';
3
+ /** Свой участник и его внешний id */
4
+ export type SelfExternalId = {
5
+ participantId: ParticipantId;
6
+ externalId: ExternalParticipantId;
7
+ };
2
8
  export default abstract class AuthData {
3
9
  private static _sessionKey;
4
10
  private static _sessionSecretKey;
5
11
  private static _accessToken;
6
12
  private static _userId;
13
+ private static _selfExternalId;
7
14
  private static _reauthorizePromise;
8
15
  static get sessionKey(): string | undefined;
9
16
  static set sessionKey(value: string | undefined);
@@ -13,6 +20,9 @@ export default abstract class AuthData {
13
20
  static set accessToken(value: string | undefined);
14
21
  static get userId(): OkUserId | null;
15
22
  static set userId(value: OkUserId | null);
23
+ /** Свой участник и его внешний id из ответа auth.anonymLogin */
24
+ static get selfExternalId(): SelfExternalId | null;
25
+ static set selfExternalId(value: SelfExternalId | null);
16
26
  static isEmpty(): boolean;
17
27
  /**
18
28
  * Дедуплицирует одновременные попытки реавторизации из разных инстансов Api.
@@ -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;
@@ -515,13 +515,11 @@ declare namespace External {
515
515
  */
516
516
  function onStatistics(connection: StatResult, memory: Record<string, number>): void;
517
517
  /**
518
- * Событие статистики SDK, асинхронное
518
+ * Событие статистики SDK
519
519
  *
520
520
  * @param data Данные события с `vcid` и `ts`
521
521
  */
522
522
  function onClientStats(data: ClientStatsEvent): void;
523
- /** Синхронно сообщает хосту непериодическое событие до уничтожения звонка. */
524
- function onStatsEvent(event: ClientStatsEvent): void;
525
523
  /**
526
524
  * Ошибка воспроизведения звука
527
525
  */
@@ -820,8 +820,6 @@ export type ParamsObject = {
820
820
  * @param data Данные события
821
821
  */
822
822
  onClientStats?: (data: ClientStatsEvent) => void;
823
- /** Получено событие статистики SDK. */
824
- onStatsEvent?: (event: ClientStatsEvent) => void;
825
823
  /**
826
824
  * Ошибка воспроизведения звука
827
825
  */
@@ -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;
@@ -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
- }