@vkontakte/calls-sdk 2.8.13-dev.0b862caf.0 → 2.8.13-dev.1736275e.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.
- package/CallsSDK.d.ts +40 -14
- package/abstract/BaseApi.d.ts +13 -9
- package/calls-sdk.cjs.js +7 -7
- package/calls-sdk.esm.js +4715 -3089
- package/classes/AudioFix.d.ts +2 -2
- package/classes/AudioOutput.d.ts +5 -3
- package/classes/CallRegistry.d.ts +17 -4
- package/classes/MediaSource.d.ts +11 -2
- package/classes/SpecListener.d.ts +2 -2
- package/classes/StatsLogger.d.ts +1 -1
- package/classes/VolumesDetector.d.ts +0 -1
- package/classes/codec/LibVPxDecoder.d.ts +2 -2
- package/classes/codec/LibVPxEncoder.d.ts +2 -2
- package/classes/codec/WebCodecsDecoder.d.ts +2 -2
- package/classes/codec/WebCodecsEncoder.d.ts +2 -2
- package/classes/codec/WorkerBase.d.ts +3 -3
- package/classes/conversation/Conversation.d.ts +25 -7
- package/classes/conversation/Conversation.testUtils.d.ts +1 -0
- package/classes/screenshare/ScreenCaptureReceiver.d.ts +2 -2
- package/classes/screenshare/ScreenCaptureSender.d.ts +2 -2
- package/classes/screenshare/StreamBuilder.d.ts +2 -2
- package/classes/stat/ApiCallStats.d.ts +12 -0
- package/classes/stat/BatteryStats.d.ts +25 -0
- package/classes/stat/CallLifecycleStats.d.ts +5 -2
- package/classes/stat/CallStatTail.d.ts +67 -0
- package/classes/stat/ClientResourceStats.d.ts +41 -0
- package/classes/stat/CodecStatsAggregator.d.ts +5 -2
- package/classes/stat/ConversationStats.d.ts +16 -3
- package/classes/stat/NetworkAdaptationStats.d.ts +35 -0
- package/classes/stat/PeerConnectionStats.d.ts +22 -0
- package/classes/stat/SdpStats.d.ts +40 -0
- package/classes/stat/Stat.testUtils.d.ts +17 -0
- package/classes/stat/StatAggregator.d.ts +12 -3
- package/classes/stat/StatClock.d.ts +28 -0
- package/classes/stat/StatDrainScheduler.d.ts +113 -0
- package/classes/stat/StatEventCollector.d.ts +47 -0
- package/classes/stat/StatPings.d.ts +6 -2
- package/classes/stat/StatQueue.d.ts +118 -0
- package/classes/stat/StatSignalingCommands.d.ts +4 -2
- package/classes/transport/DirectTransport.d.ts +13 -2
- package/classes/transport/PerfStatReporter.d.ts +7 -1
- package/classes/transport/ServerTransport.d.ts +6 -2
- package/classes/transport/SimulcastSender.d.ts +2 -2
- package/classes/transport/Transport.d.ts +2 -2
- package/default/Api.d.ts +13 -1
- package/default/Signaling.d.ts +11 -3
- package/enums/ActiveFeature.d.ts +19 -0
- package/enums/SessionError.d.ts +10 -0
- package/enums/Stat.d.ts +26 -1
- package/package.json +1 -1
- package/static/ApiTransport.d.ts +4 -0
- package/static/AuthData.d.ts +11 -1
- package/static/BrowserEnvironment.d.ts +90 -0
- package/static/External.d.ts +11 -0
- package/static/Params.d.ts +69 -3
- package/static/SessionStore.d.ts +29 -0
- package/static/SimulcastInfo.d.ts +1 -0
- package/static/WebRTCUtils.d.ts +5 -76
- package/types/ClientStatsEvent.d.ts +12 -0
- package/types/FastHangup.d.ts +7 -5
- package/types/IEventualStatLog.d.ts +1 -1
- package/types/Params.d.ts +1 -1
- package/types/PerfStatReporter.d.ts +26 -1
- package/types/SignalingMessage.d.ts +1 -0
- package/types/Statistics.d.ts +22 -7
package/static/WebRTCUtils.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Вспомогательный плагин для работы с WebRTC
|
|
3
3
|
*/
|
|
4
4
|
import { IVideoDimentions } from '../types/MediaSettings';
|
|
5
|
-
import type
|
|
5
|
+
import type StatEventCollector from '../classes/stat/StatEventCollector';
|
|
6
6
|
import { type DebugLogger } from './Debug';
|
|
7
7
|
/**
|
|
8
8
|
* Тип камеры мобильного устройства
|
|
@@ -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
|
* До вызова этого метода бесполезно опрашивать другие публичные методы.
|
|
@@ -85,24 +81,24 @@ declare namespace WebRTCUtils {
|
|
|
85
81
|
* @param needAudio Нужно ли аудио
|
|
86
82
|
* @param needEmptyTracks Добавлять ли в стрим пустые треки для отключенного видео/аудио
|
|
87
83
|
*/
|
|
88
|
-
function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?:
|
|
84
|
+
function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
|
|
89
85
|
/**
|
|
90
86
|
* Запрашивает трансляцию экрана пользователя с опциональным захватом звука
|
|
91
87
|
*/
|
|
92
|
-
function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?:
|
|
88
|
+
function getScreenMedia(fastScreenShare: boolean, withAudioShare: boolean, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
|
|
93
89
|
/**
|
|
94
90
|
* Запрашивает камеру пользователя
|
|
95
91
|
*
|
|
96
92
|
* @param deviceId ID устройства
|
|
97
93
|
* @param resolution Размеры видео
|
|
98
94
|
*/
|
|
99
|
-
function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?:
|
|
95
|
+
function getUserVideo(deviceId?: string, resolution?: IVideoDimentions, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
|
|
100
96
|
/**
|
|
101
97
|
* Запрашивает микрофон пользователя
|
|
102
98
|
*
|
|
103
99
|
* @param deviceId ID устройства
|
|
104
100
|
*/
|
|
105
|
-
function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?:
|
|
101
|
+
function getUserAudio(deviceId?: string, debug?: DebugLogger, logger?: StatEventCollector | null): Promise<MediaStream>;
|
|
106
102
|
/**
|
|
107
103
|
* Устанавливает размер видео в стриме
|
|
108
104
|
*
|
|
@@ -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
|
+
};
|
package/types/FastHangup.d.ts
CHANGED
|
@@ -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
|
|
38
|
-
*
|
|
39
|
-
*
|
|
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>;
|
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
|
-
|
|
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
|
}
|
package/types/Statistics.d.ts
CHANGED
|
@@ -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
|
|
99
|
+
packetsLost?: number;
|
|
85
100
|
/**
|
|
86
101
|
* Общее количество полученных пакетов
|
|
87
102
|
*/
|
|
88
|
-
packetsReceived
|
|
103
|
+
packetsReceived?: number;
|
|
89
104
|
/**
|
|
90
105
|
* Общее количество отправленных пакетов
|
|
91
106
|
*/
|
|
92
|
-
packetsSent
|
|
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
|
*/
|