@vkontakte/calls-sdk 2.8.11-dev.5a5b0d53.0 → 2.8.11-dev.69b107ee.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 +51 -13
- package/abstract/BaseApi.d.ts +4 -3
- package/abstract/BaseSignaling.d.ts +2 -3
- package/calls-sdk.cjs.js +16 -13
- package/calls-sdk.esm.js +11741 -13
- package/classes/AudioFix.d.ts +5 -1
- package/classes/AudioOutput.d.ts +5 -1
- package/classes/Conversation.d.ts +9 -2
- package/classes/ConversationResponseValidator.d.ts +3 -0
- package/classes/DebugInfo.d.ts +3 -0
- package/classes/DisplayLayoutRequester.d.ts +39 -0
- package/classes/ExternalIdCache.d.ts +19 -0
- package/classes/MediaSource.d.ts +5 -1
- package/classes/ParticipantIdRegistry.d.ts +3 -0
- package/classes/ProducerCommandSerializationService.d.ts +3 -0
- package/classes/SignalingActor.d.ts +3 -1
- package/classes/SpeakerDetector.d.ts +2 -1
- package/classes/SpecListener.d.ts +5 -1
- package/classes/{Logger.d.ts → StatsLogger.d.ts} +3 -10
- package/classes/VideoEffectsFpsLimiter.d.ts +3 -0
- package/classes/asr/AsrReceiver.d.ts +3 -1
- package/classes/codec/LibVPxDecoder.d.ts +3 -0
- package/classes/codec/LibVPxEncoder.d.ts +3 -1
- package/classes/codec/WebCodecsDecoder.d.ts +3 -0
- package/classes/codec/WebCodecsEncoder.d.ts +3 -1
- package/classes/codec/WorkerBase.d.ts +5 -0
- package/classes/screenshare/BaseStreamBuilder.d.ts +4 -1
- package/classes/screenshare/CanvasRenderer.d.ts +3 -1
- package/classes/screenshare/ScreenCaptureReceiver.d.ts +7 -1
- package/classes/screenshare/ScreenCaptureSender.d.ts +5 -1
- package/classes/screenshare/ScreenCongestionControl.d.ts +3 -1
- package/classes/screenshare/StreamBuilder.d.ts +5 -1
- package/classes/screenshare/TrackGeneratorRenderer.d.ts +3 -1
- package/classes/screenshare/WebmBuilder.d.ts +3 -1
- package/classes/stat/CodecStatsAggregator.d.ts +7 -7
- package/classes/stat/ConversationStats.d.ts +21 -0
- package/classes/stat/StatAggregator.d.ts +6 -6
- package/classes/stat/StatFirstMediaReceived.d.ts +6 -2
- package/classes/stat/StatPings.d.ts +9 -9
- package/classes/stat/StatScreenShareFirstFrame.d.ts +3 -1
- package/classes/stat/StatSignalingCommands.d.ts +8 -8
- package/classes/transport/BaseTransport.d.ts +1 -1
- package/classes/transport/DirectStatReporter.d.ts +3 -1
- package/classes/transport/DirectTransport.d.ts +9 -1
- package/classes/transport/PerfStatReporter.d.ts +5 -1
- package/classes/transport/ServerTransport.d.ts +10 -2
- package/classes/transport/Transport.d.ts +11 -14
- package/default/Api.d.ts +5 -11
- package/default/Signaling.d.ts +39 -45
- package/default/SignalingTransport.d.ts +68 -0
- package/enums/HangupType.d.ts +2 -1
- package/enums/TransportState.d.ts +10 -0
- package/enums/TransportTopology.d.ts +5 -0
- package/package.json +1 -1
- package/static/Debug.d.ts +27 -8
- package/static/External.d.ts +3 -0
- package/static/Params.d.ts +14 -0
- package/static/Utils.d.ts +3 -2
- package/static/WebRTCUtils.d.ts +6 -4
- package/types/Conversation.d.ts +1 -1
- package/types/FastStart.d.ts +1 -0
- package/types/ParticipantLayout.d.ts +33 -0
- package/types/PushData.d.ts +3 -0
- package/types/SignalingMessage.d.ts +5 -1
- package/types/Statistics.d.ts +1 -1
- package/types/WebTransport.d.ts +4 -0
- package/utils/DebugStorage.d.ts +100 -1
- package/classes/stat/EventMetricsService.d.ts +0 -9
- package/static/ConversationDebugLogger.d.ts +0 -13
package/CallsSDK.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ import { AddParticipantParams } from './abstract/BaseSignaling';
|
|
|
9
9
|
import HangupReason, { HangupReasonData, CustomError } from './classes/HangupReason';
|
|
10
10
|
import { MediaTrackKind } from './classes/MediaSource';
|
|
11
11
|
import { AudienceModeHandsResponse } from './types/AudienceMode';
|
|
12
|
-
import
|
|
12
|
+
import TransportTopology from './enums/TransportTopology';
|
|
13
13
|
import Api from './default/Api';
|
|
14
14
|
import Signaling from './default/Signaling';
|
|
15
15
|
import CallDirection from './enums/CallDirection';
|
|
@@ -30,6 +30,7 @@ import SignalingNotification from './enums/SignalingNotification';
|
|
|
30
30
|
import UserRole from './enums/UserRole';
|
|
31
31
|
import UserType from './enums/UserType';
|
|
32
32
|
import { DebugMessageType } from './static/Debug';
|
|
33
|
+
import * as DebugStorage from './utils/DebugStorage';
|
|
33
34
|
import { ParticipantStatus } from './static/External';
|
|
34
35
|
import { JSONArray, JSONObject, JSONType } from './static/Json';
|
|
35
36
|
import { ParamsObject } from './static/Params';
|
|
@@ -49,7 +50,7 @@ import { IAddMovieParams, IMovieMetaData, IMoviePreview, IOnRemoteMovieData, ISh
|
|
|
49
50
|
import MuteStates, { IMuteParticipantInternalParams, IMuteParticipantParams } from './types/MuteStates';
|
|
50
51
|
import { IAPIBaseUrl, IApiEnv } from './types/Params';
|
|
51
52
|
import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantsStateList, ParticipantStateMapped, ParticipantStateData, ParticipantStateDataKey, ParticipantStateDataValue } from './types/Participant';
|
|
52
|
-
import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
|
|
53
|
+
import ParticipantLayout, { DisplayLayoutRequest, Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
|
|
53
54
|
import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
|
|
54
55
|
import ParticipantPriority from './types/ParticipantPriority';
|
|
55
56
|
import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
|
|
@@ -66,6 +67,8 @@ import { VmojiError } from './types/Vmoji';
|
|
|
66
67
|
import { VolumeDetector } from './classes/VolumeDetector';
|
|
67
68
|
import { FastStartHandler, FastStartParams } from './types/FastStart';
|
|
68
69
|
import { FastJoinHandler, FastJoinParams, FastJoinResponse } from './types/FastJoin';
|
|
70
|
+
import PushData from './types/PushData';
|
|
71
|
+
export type { CurrentLogItem, DebugLogGetParams, DebugLogSessionInfo, DebugLogStorageStats } from './utils/DebugStorage';
|
|
69
72
|
/**
|
|
70
73
|
* Информация о текущем браузере
|
|
71
74
|
*/
|
|
@@ -253,6 +256,7 @@ export declare function callInternal(ids: OkUserId[], type: CallType | undefined
|
|
|
253
256
|
*/
|
|
254
257
|
export declare function processPush(conversationId: string, conversationParams?: string): Promise<void>;
|
|
255
258
|
export declare function processPushInternal(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number): Promise<void>;
|
|
259
|
+
export declare function getInbounds(): Promise<PushData[]>;
|
|
256
260
|
/**
|
|
257
261
|
* Авторизоваться для совершения звонков
|
|
258
262
|
*
|
|
@@ -410,6 +414,12 @@ export declare function putHandsDown(): Promise<void>;
|
|
|
410
414
|
* @param layout Список приоритетов
|
|
411
415
|
*/
|
|
412
416
|
export declare function updateDisplayLayout(layout: ParticipantLayout[]): Promise<void>;
|
|
417
|
+
/**
|
|
418
|
+
* Запрашивает стримы, которые клиент хочет получать для отображения.
|
|
419
|
+
*
|
|
420
|
+
* @param requests Полный список стримов, которые должны приходить на клиент
|
|
421
|
+
*/
|
|
422
|
+
export declare function requestDisplayLayout(requests: DisplayLayoutRequest[]): Promise<void>;
|
|
413
423
|
/**
|
|
414
424
|
* Выдать или забрать роли в звонке пользователю
|
|
415
425
|
*
|
|
@@ -561,16 +571,6 @@ export declare function stopStream(roomId?: number | null, remove?: boolean): Pr
|
|
|
561
571
|
* @param roomId
|
|
562
572
|
*/
|
|
563
573
|
export declare function publishStream(roomId?: number | null): Promise<undefined>;
|
|
564
|
-
/**
|
|
565
|
-
* Устанавливает роль участника в запись звонка
|
|
566
|
-
* Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
|
|
567
|
-
* видны только те участники, у кого есть роль.
|
|
568
|
-
* @param king участник показывается крупно в записи звонка (только один участник имеет такую роль)
|
|
569
|
-
* @param pawns участник показывается в записи звонка
|
|
570
|
-
* @param hideParticipantCount скрыть/показать количество невидимых участников
|
|
571
|
-
* @param roomId комната
|
|
572
|
-
*/
|
|
573
|
-
export declare function recordSetConf(king?: ExternalId, pawns?: ExternalId[], hideParticipantCount?: boolean, roomId?: number | null): Promise<void>;
|
|
574
574
|
/**
|
|
575
575
|
* Получить информацию о трансляции звонка
|
|
576
576
|
*/
|
|
@@ -641,6 +641,38 @@ export declare function debug(enabled: boolean): void;
|
|
|
641
641
|
* @param args
|
|
642
642
|
*/
|
|
643
643
|
export declare function debugMessage(type: DebugMessageType, ...args: any[]): void;
|
|
644
|
+
/**
|
|
645
|
+
* Локальные отладочные логи, сохраненные в браузере.
|
|
646
|
+
*
|
|
647
|
+
* Работает при включенном параметре `debugLog: true`.
|
|
648
|
+
* Логи хранятся в IndexedDB: последние 10 звонков, максимум 25 МБ суммарно.
|
|
649
|
+
*/
|
|
650
|
+
export declare const debugLogs: {
|
|
651
|
+
/**
|
|
652
|
+
* Возвращает список сохраненных локальных сессий логирования.
|
|
653
|
+
*/
|
|
654
|
+
list: typeof DebugStorage.list;
|
|
655
|
+
/**
|
|
656
|
+
* Возвращает логи конкретного звонка вместе с глобальным контекстом SDK.
|
|
657
|
+
*/
|
|
658
|
+
get: typeof DebugStorage.get;
|
|
659
|
+
/**
|
|
660
|
+
* Возвращает логи конкретного звонка вместе с глобальным контекстом SDK JSON-строкой.
|
|
661
|
+
*/
|
|
662
|
+
getJson: typeof DebugStorage.getJson;
|
|
663
|
+
/**
|
|
664
|
+
* Скачивает логи конкретного звонка вместе с глобальным контекстом SDK JSON-файлом.
|
|
665
|
+
*/
|
|
666
|
+
download: typeof DebugStorage.download;
|
|
667
|
+
/**
|
|
668
|
+
* Очищает логи конкретного звонка или все локальные логи SDK.
|
|
669
|
+
*/
|
|
670
|
+
clear: typeof DebugStorage.clear;
|
|
671
|
+
/**
|
|
672
|
+
* Возвращает статистику локального хранилища логов.
|
|
673
|
+
*/
|
|
674
|
+
stats: typeof DebugStorage.stats;
|
|
675
|
+
};
|
|
644
676
|
/**
|
|
645
677
|
* Отправляет клиенские логи по conversationId на сервер OK
|
|
646
678
|
* @example можно посмотреть в examples/anonym/index.html
|
|
@@ -751,9 +783,15 @@ export declare function stopUrlSharing(): Promise<void>;
|
|
|
751
783
|
export declare function sendTestCommand(name: string, params?: any): void;
|
|
752
784
|
export declare function startAnalyzingAudio(expectAudio: boolean, expectedActiveTracks?: number | null, expectedTrackFrequencies?: number[] | null): void;
|
|
753
785
|
export declare function stopAnalyzingAudio(): void;
|
|
786
|
+
/**
|
|
787
|
+
* Возвращает текущее время, скорректированное на смещение относительно серверного времени.
|
|
788
|
+
* Доступно после установки соединения (начало/присоединение к звонку).
|
|
789
|
+
* Если активного звонка нет — возвращает Date.now().
|
|
790
|
+
*/
|
|
791
|
+
export declare function getSyncedTime(): number;
|
|
754
792
|
/**
|
|
755
793
|
* Версия SDK
|
|
756
794
|
*/
|
|
757
795
|
export declare function version(): string;
|
|
758
|
-
export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAPIBaseUrl, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, ParticipantStateData, ParticipantStateDataKey, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, ParticipantListMarker, RequestKeyFrame, Rooms, IGetParticipantsParameters, ScreenCaptureSettings, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IMovieMetaData, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IRoomId, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, IPublishStreamData, VmojiError, FastStartHandler, FastStartParams, FastJoinHandler, FastJoinParams, FastJoinResponse, };
|
|
796
|
+
export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, DisplayLayoutRequest, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAPIBaseUrl, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, ParticipantStateData, ParticipantStateDataKey, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, ParticipantListMarker, RequestKeyFrame, Rooms, IGetParticipantsParameters, ScreenCaptureSettings, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IMovieMetaData, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IRoomId, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, IPublishStreamData, VmojiError, FastStartHandler, FastStartParams, FastJoinHandler, FastJoinParams, FastJoinResponse, };
|
|
759
797
|
export { Api, AuthData, BaseLogger, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStateDataValue, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, ApiExternal, VolumeDetector, };
|
package/abstract/BaseApi.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ import ConversationParams from '../types/ConversationParams';
|
|
|
5
5
|
import ConversationResponse from '../types/ConversationResponse';
|
|
6
6
|
import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
|
|
7
7
|
import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
|
|
8
|
+
import PushData from '../types/PushData';
|
|
8
9
|
export type ClientStats = {
|
|
9
10
|
vcid: ConversationData['id'] | null;
|
|
10
11
|
[k: string]: string | number | boolean | null;
|
|
@@ -44,7 +45,7 @@ export default abstract class BaseApi {
|
|
|
44
45
|
audioOnly?: boolean;
|
|
45
46
|
waitForAdmin?: boolean;
|
|
46
47
|
closedConversation?: boolean;
|
|
47
|
-
}, speakerIds?:
|
|
48
|
+
}, speakerIds?: ExternalId[]): Promise<ConversationResponse>;
|
|
48
49
|
abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, createConversationParameters?: {
|
|
49
50
|
onlyAdminCanShareMovie?: boolean;
|
|
50
51
|
}, externalIds?: ExternalId[]): Promise<ConversationResponse>;
|
|
@@ -73,10 +74,9 @@ export default abstract class BaseApi {
|
|
|
73
74
|
*/
|
|
74
75
|
logClientEvents(items: ClientEvent[]): void;
|
|
75
76
|
abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
|
|
76
|
-
abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
|
|
77
|
-
abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
|
|
78
77
|
abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
|
|
79
78
|
getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
|
|
79
|
+
getCachedRawOkIdByExternalId(externalId: ExternalId): OkUserId | null;
|
|
80
80
|
cacheExternalId(compositeId: OkUserId | CompositeUserId | ParticipantId, externalId: ExternalParticipantId): void;
|
|
81
81
|
mapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId, okId: OkUserId | CompositeUserId): void;
|
|
82
82
|
unmapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId): void;
|
|
@@ -86,4 +86,5 @@ export default abstract class BaseApi {
|
|
|
86
86
|
removeHistoryRecords(recordIds: number[]): Promise<void>;
|
|
87
87
|
getServerTime(): Promise<number>;
|
|
88
88
|
cleanup(): void;
|
|
89
|
+
getInbounds(): Promise<PushData[]>;
|
|
89
90
|
}
|
|
@@ -3,7 +3,7 @@ import { ParticipantIdRegistry } from '../classes/ParticipantIdRegistry';
|
|
|
3
3
|
import { StreamDescriptionString } from '../types/ParticipantStreamDescription';
|
|
4
4
|
import { PerfStatReport } from '../types/PerfStatReporter';
|
|
5
5
|
import { NetworkStatReport } from '../types/NetworkStatReport';
|
|
6
|
-
import
|
|
6
|
+
import TransportTopology from '../enums/TransportTopology';
|
|
7
7
|
import ConversationFeature from '../enums/ConversationFeature';
|
|
8
8
|
import ConversationOption from '../enums/ConversationOption';
|
|
9
9
|
import MediaOption from '../enums/MediaOption';
|
|
@@ -21,7 +21,7 @@ import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/Partici
|
|
|
21
21
|
import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
|
|
22
22
|
import SignalingMessage, { GetParticipantsSignalingResponse, GetRoomsSignalingResponse } from '../types/SignalingMessage';
|
|
23
23
|
import { ChangeSimulcast } from '../types/ChangeSimulcast';
|
|
24
|
-
import { IPublishStreamData,
|
|
24
|
+
import { IPublishStreamData, IStartStreamData, IStopStreamData } from '../types/Streams';
|
|
25
25
|
import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
|
|
26
26
|
/**
|
|
27
27
|
* Параметры добавления пользователя в звонок
|
|
@@ -92,7 +92,6 @@ export default abstract class BaseSignaling extends EventEmitter {
|
|
|
92
92
|
abstract startStream(data: IStartStreamData): Promise<SignalingMessage>;
|
|
93
93
|
abstract stopStream(data: IStopStreamData): Promise<SignalingMessage>;
|
|
94
94
|
abstract publishStream(data: IPublishStreamData): Promise<SignalingMessage>;
|
|
95
|
-
abstract recordSetConf(conf: IRecordConfData): Promise<SignalingMessage>;
|
|
96
95
|
abstract getRecordStatus(): Promise<SignalingMessage>;
|
|
97
96
|
abstract switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
|
|
98
97
|
abstract reportPerfStat(report: PerfStatReport): Promise<SignalingMessage>;
|