@vkontakte/calls-sdk 2.8.13-dev.3b07b09d.0 → 2.8.13-dev.3f06c117.0

package/CallsSDK.d.ts

@@ -28,6 +28,7 @@ import RoomsEventType from './enums/RoomsEventType';
 import SignalingCommandType from './enums/SignalingCommandType';
 import SignalingConnectionType from './enums/SignalingConnectionType';
 import SignalingNotification from './enums/SignalingNotification';
+import Stat from './enums/Stat';
 import UserRole from './enums/UserRole';
 import UserType from './enums/UserType';
 import { DebugMessageType } from './static/Debug';
@@ -36,7 +37,8 @@ import { ParticipantStatus } from './static/External';
 import { JSONArray, JSONObject, JSONType } from './static/Json';
 import { ParamsObject } from './static/Params';
 import Utils from './static/Utils';
-import WebRTCUtils, { BrowserName, FacingMode } from './static/WebRTCUtils';
+import BrowserEnvironment, { BrowserName } from './static/BrowserEnvironment';
+import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
 import { IAsrData, IAsrStartParams, IAsrStopParams } from './types/Asr';
 import { ConversationData } from './types/Conversation';
 import { IFeaturesPerRole } from './types/ConversationFeature';
@@ -59,6 +61,7 @@ import { IRoomId, Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from './type
 import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
 import SignalingMessage, { GetRoomsSignalingResponse, GetParticipantsSignalingResponse } from './types/SignalingMessage';
 import { StatResult } from './types/Statistics';
+import { ClientStatsEvent } from './types/ClientStatsEvent';
 import { IStartStreamData, IStopStreamData, IPublishStreamData } from './types/Streams';
 import { WaitingHallResponse } from './types/WaitingHall';
 import { ArrayDequeue } from './utils/ArrayDequeue';
@@ -144,43 +147,57 @@ export declare const browser: {
      *
      * _Метод доступен до инициализации_
      */
-    isBrowserSupported: typeof WebRTCUtils.isBrowserSupported;
+    isBrowserSupported: typeof BrowserEnvironment.isBrowserSupported;
     /**
      * Проверяет поддержку трансляции экрана браузером
      *
      * _Метод доступен до инициализации_
      */
-    isScreenCapturingSupported: typeof WebRTCUtils.isScreenCapturingSupported;
+    isScreenCapturingSupported: typeof BrowserEnvironment.isScreenCapturingSupported;
+    /**
+     * Проверяет поддержку выбора микрофона браузером, независимо от списка устройств и разрешений.
+     * Не запрашивает разрешения и не захватывает медиа.
+     *
+     * _Метод доступен до инициализации_
+     */
+    canSelectAudioInput: typeof BrowserEnvironment.canSelectAudioInput;
+    /**
+     * Проверяет поддержку выбора аудиовыхода браузером, независимо от списка устройств и разрешений.
+     * Не запрашивает разрешения и не меняет аудиовыход.
+     *
+     * _Метод доступен до инициализации_
+     */
+    canSelectAudioOutput: typeof BrowserEnvironment.canSelectAudioOutput;
     /**
      * Имя операционной системы
      *
      * _Метод доступен до инициализации_
      */
-    os: typeof WebRTCUtils.os;
+    os: typeof BrowserEnvironment.os;
     /**
      * Мобильный браузер или нет
      *
      * _Метод доступен до инициализации_
      */
-    isMobile: typeof WebRTCUtils.isMobile;
+    isMobile: typeof BrowserEnvironment.isMobile;
     /**
      * Имя браузера
      *
      * _Метод доступен до инициализации_
      */
-    browserName: typeof WebRTCUtils.browserName;
+    browserName: typeof BrowserEnvironment.browserName;
     /**
      * Версия браузера
      *
      * _Метод доступен до инициализации_
      */
-    browserVersion: typeof WebRTCUtils.browserVersion;
+    browserVersion: typeof BrowserEnvironment.browserVersion;
     /**
      * Если браузер основан на хроме - возвращает версию
      *
      * _Метод доступен до инициализации_
      */
-    baseChromeVersion: typeof WebRTCUtils.baseChromeVersion;
+    baseChromeVersion: typeof BrowserEnvironment.baseChromeVersion;
     /**
      * Возвращает AudioContext
      */
@@ -190,7 +207,7 @@ export declare const browser: {
      *
      * _Метод доступен до инициализации_
      */
-    isAudioShareSupported: typeof WebRTCUtils.isAudioShareSupported;
+    isAudioShareSupported: typeof BrowserEnvironment.isAudioShareSupported;
 };
 /**
  * Вспомогательные функции
@@ -262,17 +279,14 @@ export declare function callInternal(ids: OkUserId[], type: CallType | undefined
  *
  * @param conversationId ID звонка
  * @param conversationParams conversationParams в base64
+ * @param externalUserId внешний ID пользователя, полученный из incoming push
  */
-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 processPush(conversationId: string, conversationParams?: string, externalUserId?: ExternalUserId): Promise<void>;
+export declare function processPushInternal(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number, externalUserId?: ExternalUserId): Promise<void>;
 export declare function getInbounds(): Promise<PushData[]>;
 /**
- * Запускает отправку клиентской статистики.
- *
- * Нужен только если `init()` был вызван с `autoStartStats: false`: до этого
- * момента события копятся в IndexedDB и в сеть не уходят. Первый дрейн после
- * старта забирает всё накопленное. Повторные вызовы и вызов после автостарта
- * ничего не делают, как и вызов при `statQueueEnabled: false`.
+ * Запускает отправку клиентской статистики. Нужен только при
+ * `autoStartStats: false`; повторные вызовы ничего не делают.
  */
 export declare function startStats(): void;
 /**
@@ -813,5 +827,5 @@ export declare function getSyncedTime(): number;
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, ClientHangupReason, 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, FastHangupHandler, FastHangupParams, FastHangupResponse, HangupParams, };
-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, };
+export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, ClientHangupReason, ClientStatsEvent, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, ExternalUserId, 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, FastHangupHandler, FastHangupParams, FastHangupResponse, HangupParams, };
+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, Stat, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, ApiExternal, VolumeDetector, };

package/abstract/BaseApi.d.ts

@@ -7,10 +7,11 @@ import ConversationResponse from '../types/ConversationResponse';
 import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
 import { OkUserId, ParticipantId } from '../types/Participant';
 import PushData from '../types/PushData';
+import { ApiCallStats } from '../classes/stat/ApiCallStats';
 export type ClientStats = {
     call_topology: 'D' | 'S';
     vcid: ConversationData['id'] | null;
-    [k: string]: string | number | boolean | null;
+    [k: string]: string | string[] | number | boolean | null;
 };
 export type LogItem = {
     count?: number;
@@ -26,6 +27,9 @@ export type LogItem = {
 };
 export default abstract class BaseApi {
     protected _abortSignal?: AbortSignal;
+    protected _apiCallStats: ApiCallStats | null;
+    /** Куда писать время выполнения запросов, появляется вместе со звонком */
+    setApiCallStats(apiCallStats: ApiCallStats | null): void;
     /**
      * Устанавливает сигнал прерывания для запуска звонка, если не успели отменить до установки соединения с другим участником, то он больше ни как не будет использоваться
      * @param signal - Сигнал прерывания или undefined для очистки
@@ -63,16 +67,12 @@ export default abstract class BaseApi {
     /**
      * method: vchat.clientStats
      *
-     * Резолвится только после подтверждённой сервером отправки: вызывающий
-     * код удаляет события из очереди по факту резолва.
+     * Резолвится только после подтверждённой сервером отправки.
      */
     logClientStats(items: ClientStats[]): Promise<void>;
     /**
-     * method: vchat.clientStats под сохранённым session_key другого пользователя.
-     *
-     * Одна попытка, без перелогина: не приняли — вызывающий код выбрасывает
-     * батч. Бросает сырую ошибку API или транспорта; классифицирует её
-     * вызывающий код. Состояние текущего пользователя (AuthData) не трогает.
+     * method: vchat.clientStats под сохранённым session_key другого
+     * пользователя. Одна попытка, без перелогина; AuthData не трогает.
      */
     logClientStatsWith(sessionKey: string, items: ClientStats[]): Promise<void>;
     abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;