@vkontakte/calls-sdk 2.8.13-dev.0b2c361e.0 → 2.8.13-dev.0c2d0c81.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 (41) hide show
  1. package/CallsSDK.d.ts +37 -12
  2. package/abstract/BaseApi.d.ts +1 -1
  3. package/calls-sdk.cjs.js +7 -7
  4. package/calls-sdk.esm.js +2539 -1954
  5. package/classes/AudioOutput.d.ts +3 -1
  6. package/classes/MediaSource.d.ts +7 -0
  7. package/classes/StatsLogger.d.ts +1 -1
  8. package/classes/conversation/Conversation.d.ts +8 -1
  9. package/classes/stat/BatteryStats.d.ts +25 -0
  10. package/classes/stat/ClientResourceStats.d.ts +41 -0
  11. package/classes/stat/ConversationStats.d.ts +6 -1
  12. package/classes/stat/NetworkAdaptationStats.d.ts +35 -0
  13. package/classes/stat/PeerConnectionStats.d.ts +22 -0
  14. package/classes/stat/SdpStats.d.ts +40 -0
  15. package/classes/stat/Stat.testUtils.d.ts +10 -0
  16. package/classes/stat/StatAggregator.d.ts +11 -2
  17. package/classes/stat/StatEventCollector.d.ts +1 -1
  18. package/classes/stat/StatPings.d.ts +2 -0
  19. package/classes/stat/StatQueue.d.ts +2 -2
  20. package/classes/transport/DirectTransport.d.ts +7 -0
  21. package/classes/transport/PerfStatReporter.d.ts +7 -1
  22. package/classes/transport/ServerTransport.d.ts +4 -0
  23. package/default/Api.d.ts +3 -0
  24. package/default/Signaling.d.ts +3 -4
  25. package/default/SignalingTransport.d.ts +5 -1
  26. package/enums/ActiveFeature.d.ts +19 -0
  27. package/enums/Stat.d.ts +25 -1
  28. package/package.json +1 -1
  29. package/static/AuthData.d.ts +11 -1
  30. package/static/BrowserEnvironment.d.ts +90 -0
  31. package/static/External.d.ts +7 -0
  32. package/static/Params.d.ts +19 -0
  33. package/static/SimulcastInfo.d.ts +1 -0
  34. package/static/WebRTCUtils.d.ts +7 -71
  35. package/types/ClientStatsEvent.d.ts +12 -0
  36. package/types/DeviceSelection.d.ts +8 -0
  37. package/types/IEventualStatLog.d.ts +1 -1
  38. package/types/Params.d.ts +1 -1
  39. package/types/PerfStatReporter.d.ts +26 -1
  40. package/types/SignalingMessage.d.ts +1 -0
  41. 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,4 +1,5 @@
1
1
  import { IAsrData } from '../types/Asr';
2
+ import { ClientStatsEvent } from '../types/ClientStatsEvent';
2
3
  import { ConversationData } from '../types/Conversation';
3
4
  import HangupReason from '../classes/HangupReason';
4
5
  import { MediaTrackKind } from '../classes/MediaSource';
@@ -513,6 +514,12 @@ declare namespace External {
513
514
  * @param memory Статистика памяти
514
515
  */
515
516
  function onStatistics(connection: StatResult, memory: Record<string, number>): void;
517
+ /**
518
+ * Событие статистики SDK
519
+ *
520
+ * @param data Данные события с `vcid` и `ts`
521
+ */
522
+ function onClientStats(data: ClientStatsEvent): void;
516
523
  /**
517
524
  * Ошибка воспроизведения звука
518
525
  */
@@ -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
  *
@@ -804,6 +814,12 @@ export type ParamsObject = {
804
814
  * Статистика звонка
805
815
  */
806
816
  onStatistics?: (stats: {}) => void;
817
+ /**
818
+ * Событие статистики SDK: те же данные, что уходят в статистику звонков, плюс `vcid` и `ts`
819
+ *
820
+ * @param data Данные события
821
+ */
822
+ onClientStats?: (data: ClientStatsEvent) => void;
807
823
  /**
808
824
  * Ошибка воспроизведения звука
809
825
  */
@@ -1000,6 +1016,7 @@ export default abstract class Params {
1000
1016
  static get signalingReconnectDelay(): number;
1001
1017
  static get signalingReconnectMaxDelay(): number;
1002
1018
  static get signalingReconnectMaxCount(): number;
1019
+ static get signalingReconnectMaxDuration(): number;
1003
1020
  static get waitConnectionDelay(): number;
1004
1021
  static get waitResponseDelay(): number;
1005
1022
  static get waitMessageDelay(): number;
@@ -1049,6 +1066,7 @@ export default abstract class Params {
1049
1066
  static get networkStatisticsInterval(): number;
1050
1067
  static get perfStatReportEnabled(): boolean;
1051
1068
  static get callStatReportEnabled(): boolean;
1069
+ static get iceCandidateErrorStatEnabled(): boolean;
1052
1070
  static get enableLogPerfStatReport(): boolean;
1053
1071
  static get asrDataChannel(): boolean;
1054
1072
  static get consumerScreenDataChannelPacketSize(): number;
@@ -1120,6 +1138,7 @@ export default abstract class Params {
1120
1138
  videoSuspend: boolean;
1121
1139
  debugLog: boolean;
1122
1140
  callStatReportEnabled: boolean;
1141
+ iceCandidateErrorStatEnabled: boolean;
1123
1142
  joinFromMultipleDevices: boolean;
1124
1143
  movieShare: boolean;
1125
1144
  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;
@@ -4,6 +4,7 @@
4
4
  import { IVideoDimentions } from '../types/MediaSettings';
5
5
  import type StatEventCollector from '../classes/stat/StatEventCollector';
6
6
  import { type DebugLogger } from './Debug';
7
+ import { DeviceSelection } from '../types/DeviceSelection';
7
8
  /**
8
9
  * Тип камеры мобильного устройства
9
10
  */
@@ -17,10 +18,6 @@ export declare enum FacingMode {
17
18
  */
18
19
  ENVIRONMENT = "environment"
19
20
  }
20
- /**
21
- * Известные браузеры
22
- */
23
- export type BrowserName = 'Edge' | 'Chrome' | 'Firefox' | 'Yandex' | 'Opera' | 'Sferum';
24
21
  declare namespace WebRTCUtils {
25
22
  /**
26
23
  * До вызова этого метода бесполезно опрашивать другие публичные методы.
@@ -60,6 +57,12 @@ declare namespace WebRTCUtils {
60
57
  * Возвращает сохраненное устройство вывода
61
58
  */
62
59
  function getSavedOutput(): MediaDeviceInfo | null;
60
+ /** Возвращает способ выбора и фактически используемую камеру. */
61
+ function getCameraSelection(): DeviceSelection;
62
+ /** Возвращает способ выбора и фактически используемый микрофон. */
63
+ function getMicrophoneSelection(): DeviceSelection;
64
+ /** Возвращает способ выбора и фактически используемый аудиовыход. */
65
+ function getOutputSelection(): DeviceSelection;
63
66
  /**
64
67
  * Возвращает тип используемой камеры (передняя или задняя)
65
68
  */
@@ -118,76 +121,9 @@ declare namespace WebRTCUtils {
118
121
  * Возвращает фейковый видео mediaTrack
119
122
  */
120
123
  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
124
  /**
181
125
  * Возвращает AudioContext
182
126
  */
183
127
  function getAudioContext(): AudioContext;
184
- /**
185
- * Возвращает подверсию браузера (если она есть)
186
- */
187
- function browserSubVersion(): string;
188
- /**
189
- * Браузер поддерживает захват звука при трансляции экрана
190
- */
191
- function isAudioShareSupported(): boolean;
192
128
  }
193
129
  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
+ };
@@ -0,0 +1,8 @@
1
+ /** Способ выбора устройства. */
2
+ export type DeviceSelectionMode = 'default' | 'explicit';
3
+ /** Состояние выбора и фактически используемое устройство. */
4
+ export interface DeviceSelection {
5
+ mode: DeviceSelectionMode;
6
+ device: MediaDeviceInfo | null;
7
+ deviceId: string | null;
8
+ }
@@ -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
  */