@vkontakte/calls-sdk 2.8.11-dev.cb5b05f6.0 → 2.8.11-dev.d5496fb5.0

package/CallsSDK.d.ts

@@ -9,7 +9,7 @@ import { AddParticipantParams } from './abstract/BaseSignaling';
 import HangupReason, { HangupReasonData, CustomError } from './classes/HangupReason';
 import { MediaTrackKind } from './classes/MediaSource';
 import { AudienceModeHandsResponse } from './types/AudienceMode';
-import { TransportTopology } from './classes/transport/Transport';
+import TransportTopology from './enums/TransportTopology';
 import Api from './default/Api';
 import Signaling from './default/Signaling';
 import CallDirection from './enums/CallDirection';
@@ -30,6 +30,7 @@ import SignalingNotification from './enums/SignalingNotification';
 import UserRole from './enums/UserRole';
 import UserType from './enums/UserType';
 import { DebugMessageType } from './static/Debug';
+import * as DebugStorage from './utils/DebugStorage';
 import { ParticipantStatus } from './static/External';
 import { JSONArray, JSONObject, JSONType } from './static/Json';
 import { ParamsObject } from './static/Params';
@@ -49,7 +50,7 @@ import { IAddMovieParams, IMovieMetaData, IMoviePreview, IOnRemoteMovieData, ISh
 import MuteStates, { IMuteParticipantInternalParams, IMuteParticipantParams } from './types/MuteStates';
 import { IAPIBaseUrl, IApiEnv } from './types/Params';
 import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantsStateList, ParticipantStateMapped, ParticipantStateData, ParticipantStateDataKey, ParticipantStateDataValue } from './types/Participant';
-import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
+import ParticipantLayout, { DisplayLayoutRequest, Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
 import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
 import ParticipantPriority from './types/ParticipantPriority';
 import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
@@ -66,6 +67,8 @@ import { VmojiError } from './types/Vmoji';
 import { VolumeDetector } from './classes/VolumeDetector';
 import { FastStartHandler, FastStartParams } from './types/FastStart';
 import { FastJoinHandler, FastJoinParams, FastJoinResponse } from './types/FastJoin';
+import PushData from './types/PushData';
+export type { CurrentLogItem, DebugLogGetParams, DebugLogSessionInfo, DebugLogStorageStats } from './utils/DebugStorage';
 /**
  * Информация о текущем браузере
  */
@@ -253,6 +256,7 @@ export declare function callInternal(ids: OkUserId[], type: CallType | undefined
  */
 export declare function processPush(conversationId: string, conversationParams?: string): Promise<void>;
 export declare function processPushInternal(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number): Promise<void>;
+export declare function getInbounds(): Promise<PushData[]>;
 /**
  * Авторизоваться для совершения звонков
  *
@@ -265,11 +269,11 @@ export declare function authorize(authToken?: string, apiBaseUrl?: IAPIBaseUrl):
  *
  * @param mediaOptions Нужно ли включать камеру и микрофон
  */
-export declare function acceptCall(mediaOptions?: MediaOption[]): Promise<ConversationData>;
+export declare function acceptCall(mediaOptions?: MediaOption[], conversationId?: string): Promise<ConversationData>;
 /**
  * Отклонить входящий звонок
  */
-export declare function declineCall(): Promise<void>;
+export declare function declineCall(conversationId?: string): Promise<void>;
 /**
  * Присоединиться к активному звонку
  *
@@ -292,7 +296,7 @@ export declare function joinCallByLink(joinLink: string, mediaOptions?: MediaOpt
 /**
  * Завершить текущий разговор
  */
-export declare function hangup(): Promise<void>;
+export declare function hangup(conversationId?: string): Promise<void>;
 /**
  * Добавить собеседника в звонок
  *
@@ -340,7 +344,7 @@ export declare function changeDevice(kind: MediaDeviceKind, deviceId: string): P
  *      state Включить или выключить захват экрана
  *      settings Параметры захваты экрана
  */
-export declare function captureScreen(stateOrSettings: boolean | ScreenCaptureSettings): Promise<void>;
+export declare function captureScreen(stateOrSettings: boolean | ScreenCaptureSettings, conversationId?: string): Promise<void>;
 /**
  * Включить/выключить передачу точек вимоджи
  *
@@ -361,13 +365,13 @@ export declare function setVideoStream(stream: MediaStream, isScreen?: boolean):
  *
  * @param enabled
  */
-export declare function toggleLocalVideo(enabled: boolean): Promise<void>;
+export declare function toggleLocalVideo(enabled: boolean, conversationId?: string): Promise<void>;
 /**
  * Включить или выключить свой микрофон
  *
  * @param enabled
  */
-export declare function toggleLocalAudio(enabled: boolean): Promise<void>;
+export declare function toggleLocalAudio(enabled: boolean, conversationId?: string): Promise<void>;
 /**
  * Изменяет размеры локального видео
  *
@@ -393,12 +397,6 @@ export declare function changePriorities(priorities: ParticipantPriority[]): Pro
  * @param externalId Внешний ID пользователя
  */
 export declare function changeParticipantState(state: ParticipantStateData, externalId?: ExternalId): Promise<void>;
-/**
- * Ставит звонок на удержание
- *
- * @param hold - true/false
- */
-export declare function hold(hold: boolean): Promise<void>;
 /**
  * Принудительно опустить руки участников в текущем сессионном зале админа
  */
@@ -410,6 +408,12 @@ export declare function putHandsDown(): Promise<void>;
  * @param layout Список приоритетов
  */
 export declare function updateDisplayLayout(layout: ParticipantLayout[]): Promise<void>;
+/**
+ * Запрашивает стримы, которые клиент хочет получать для отображения.
+ *
+ * @param requests Полный список стримов, которые должны приходить на клиент
+ */
+export declare function requestDisplayLayout(requests: DisplayLayoutRequest[]): Promise<void>;
 /**
  * Выдать или забрать роли в звонке пользователю
  *
@@ -561,16 +565,6 @@ export declare function stopStream(roomId?: number | null, remove?: boolean): Pr
  * @param roomId
  */
 export declare function publishStream(roomId?: number | null): Promise<undefined>;
-/**
- * Устанавливает роль участника в запись звонка
- * Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
- * видны только те участники, у кого есть роль.
- * @param king участник показывается крупно в записи звонка (только один участник имеет такую роль)
- * @param pawns участник показывается в записи звонка
- * @param hideParticipantCount скрыть/показать количество невидимых участников
- * @param roomId комната
- */
-export declare function recordSetConf(king?: ExternalId, pawns?: ExternalId[], hideParticipantCount?: boolean, roomId?: number | null): Promise<void>;
 /**
  * Получить информацию о трансляции звонка
  */
@@ -641,6 +635,38 @@ export declare function debug(enabled: boolean): void;
  * @param args
  */
 export declare function debugMessage(type: DebugMessageType, ...args: any[]): void;
+/**
+ * Локальные отладочные логи, сохраненные в браузере.
+ *
+ * Работает при включенном параметре `debugLog: true`.
+ * Логи хранятся в IndexedDB: последние 10 звонков, максимум 25 МБ суммарно.
+ */
+export declare const debugLogs: {
+    /**
+     * Возвращает список сохраненных локальных сессий логирования.
+     */
+    list: typeof DebugStorage.list;
+    /**
+     * Возвращает логи конкретного звонка вместе с глобальным контекстом SDK.
+     */
+    get: typeof DebugStorage.get;
+    /**
+     * Возвращает логи конкретного звонка вместе с глобальным контекстом SDK JSON-строкой.
+     */
+    getJson: typeof DebugStorage.getJson;
+    /**
+     * Скачивает логи конкретного звонка вместе с глобальным контекстом SDK JSON-файлом.
+     */
+    download: typeof DebugStorage.download;
+    /**
+     * Очищает логи конкретного звонка или все локальные логи SDK.
+     */
+    clear: typeof DebugStorage.clear;
+    /**
+     * Возвращает статистику локального хранилища логов.
+     */
+    stats: typeof DebugStorage.stats;
+};
 /**
  * Отправляет клиенские логи по conversationId на сервер OK
  * @example можно посмотреть в examples/anonym/index.html
@@ -718,16 +744,7 @@ export declare function acceptPromotion(reject?: boolean): Promise<void>;
 export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<ExternalParticipantListChunk>;
 export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
 export declare function feedback(key: string): Promise<SignalingMessage>;
-export declare function userFeedbackStats(userResponse: number, reason?: string, groupCallUsersCount?: number): void;
-/**
- * Логирует клиентское событие статистики
- *
- * @param eventType Тип события
- * @param eventData Дополнительные данные события
- * @param immediatelty Отправить ли событие немедленно
- */
-export declare function logClientEvent(eventType: string, eventData?: Record<string, string | number | boolean>, immediately?: boolean): void;
-export declare function enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<void>;
+export declare function enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[], conversationId?: string): Promise<void>;
 /**
  * Удаляет записи истории звонков
  *
@@ -749,11 +766,19 @@ export declare function requestAsr(request: boolean): Promise<void>;
 export declare function startUrlSharing(sharedUrl: string): Promise<void>;
 export declare function stopUrlSharing(): Promise<void>;
 export declare function sendTestCommand(name: string, params?: any): void;
-export declare function startAnalyzingAudio(expectAudio: boolean): void;
+export declare function startAnalyzingAudio(expectAudio: boolean, expectedActiveTracks?: number | null, expectedTrackFrequencies?: number[] | null): void;
 export declare function stopAnalyzingAudio(): void;
+export declare function switchCall(conversationId: string): Promise<void>;
+export declare function getActiveCallId(): string | null;
+/**
+ * Возвращает текущее время, скорректированное на смещение относительно серверного времени.
+ * Доступно после установки соединения (начало/присоединение к звонку).
+ * Если активного звонка нет — возвращает Date.now().
+ */
+export declare function getSyncedTime(): number;
 /**
  * Версия SDK
  */
 export declare function version(): string;
-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, };
+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, };
 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

@@ -5,9 +5,10 @@ import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
 import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
 import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
+import PushData from '../types/PushData';
 export type ClientStats = {
     vcid: ConversationData['id'] | null;
-    [k: string]: string | number | null;
+    [k: string]: string | number | boolean | null;
 };
 export type ClientEvent = {
     timestamp: number;
@@ -44,7 +45,7 @@ export default abstract class BaseApi {
         audioOnly?: boolean;
         waitForAdmin?: boolean;
         closedConversation?: boolean;
-    }, speakerIds?: OkUserId[]): Promise<ConversationResponse>;
+    }, speakerIds?: ExternalId[]): Promise<ConversationResponse>;
     abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, createConversationParameters?: {
         onlyAdminCanShareMovie?: boolean;
     }, externalIds?: ExternalId[]): Promise<ConversationResponse>;
@@ -68,23 +69,18 @@ export default abstract class BaseApi {
      * method: vchat.clientStats
      */
     logClientStats(items: ClientStats[]): void;
-    /**
-     * method: vchat.clientEvents
-     */
-    logClientEvents(items: ClientEvent[]): void;
     abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
-    abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
-    abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
     abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
     getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
+    getCachedRawOkIdByExternalId(externalId: ExternalId): OkUserId | null;
     cacheExternalId(compositeId: OkUserId | CompositeUserId | ParticipantId, externalId: ExternalParticipantId): void;
     mapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId, okId: OkUserId | CompositeUserId): void;
     unmapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId): void;
     getDecorativeIdByInitialId(okId: OkUserId | CompositeUserId | ParticipantId): OkUserId | undefined;
     replaceByInitialIdIdIfExists(id: OkUserId | CompositeUserId | ParticipantId): OkUserId;
     hangupConversation(conversationId: string, reason?: HangupType): void;
-    sendUserFeedbackStats(conversationId: string, userResponse: number, reason?: string, groupCallUsersCount?: number): void;
     removeHistoryRecords(recordIds: number[]): Promise<void>;
     getServerTime(): Promise<number>;
     cleanup(): void;
+    getInbounds(): Promise<PushData[]>;
 }

package/abstract/BaseSignaling.d.ts

@@ -1,9 +1,10 @@
 import EventEmitter from '../classes/EventEmitter';
 import { ParticipantIdRegistry } from '../classes/ParticipantIdRegistry';
+import { TCapabilities } from '../types/Capabilities';
 import { StreamDescriptionString } from '../types/ParticipantStreamDescription';
 import { PerfStatReport } from '../types/PerfStatReporter';
 import { NetworkStatReport } from '../types/NetworkStatReport';
-import { TransportTopology } from '../classes/transport/Transport';
+import TransportTopology from '../enums/TransportTopology';
 import ConversationFeature from '../enums/ConversationFeature';
 import ConversationOption from '../enums/ConversationOption';
 import MediaOption from '../enums/MediaOption';
@@ -21,7 +22,7 @@ import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/Partici
 import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
 import SignalingMessage, { GetParticipantsSignalingResponse, GetRoomsSignalingResponse } from '../types/SignalingMessage';
 import { ChangeSimulcast } from '../types/ChangeSimulcast';
-import { IPublishStreamData, IRecordConfData, IStartStreamData, IStopStreamData } from '../types/Streams';
+import { IPublishStreamData, IStartStreamData, IStopStreamData } from '../types/Streams';
 import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 /**
  * Параметры добавления пользователя в звонок
@@ -61,14 +62,12 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidate): Promise<SignalingMessage>;
     abstract changeMediaSettings(mediaSettings: MediaSettings): Promise<SignalingMessage>;
     abstract changeParticipantState(state: ParticipantStateData, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
-    abstract hold(hold: boolean): Promise<SignalingMessage>;
+    abstract hold(hold: boolean, capabilities?: TCapabilities): Promise<SignalingMessage>;
     abstract putHandsDown(): Promise<SignalingMessage>;
     abstract addParticipant(externalIds: CompositeUserId[], params?: AddParticipantParams): Promise<SignalingMessage>;
     abstract addParticipantLegacy(participantIds: CompositeUserId[], params?: AddParticipantParams): Promise<SignalingMessage>;
     abstract removeParticipant(participantId: CompositeUserId, ban?: boolean): Promise<SignalingMessage>;
-    abstract allocateConsumer(description: RTCSessionDescription | null, capabilities: {
-        [key: string]: number | boolean | string;
-    }): Promise<SignalingMessage>;
+    abstract allocateConsumer(description: RTCSessionDescription | null, capabilities: TCapabilities): Promise<SignalingMessage>;
     abstract acceptProducer(description: RTCSessionDescriptionInit, ssrcs: string[], sessionId: string): Promise<SignalingMessage>;
     /**
      * @deprecated Use updateDisplayLayout instead
@@ -92,7 +91,6 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract startStream(data: IStartStreamData): Promise<SignalingMessage>;
     abstract stopStream(data: IStopStreamData): Promise<SignalingMessage>;
     abstract publishStream(data: IPublishStreamData): Promise<SignalingMessage>;
-    abstract recordSetConf(conf: IRecordConfData): Promise<SignalingMessage>;
     abstract getRecordStatus(): Promise<SignalingMessage>;
     abstract switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
     abstract reportPerfStat(report: PerfStatReport): Promise<SignalingMessage>;