@vkontakte/calls-sdk 2.8.13-dev.0b862caf.0 → 2.8.13-dev.0c2d0c81.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';
@@ -70,6 +73,7 @@ import { FastStartHandler, FastStartParams } from './types/FastStart';
 import { FastJoinHandler, FastJoinParams, FastJoinResponse } from './types/FastJoin';
 import { FastHangupHandler, FastHangupParams, FastHangupResponse, HangupParams } from './types/FastHangup';
 import PushData from './types/PushData';
+import type { DeviceSelection, DeviceSelectionMode } from './types/DeviceSelection';
 export type { CurrentLogItem, DebugLogGetParams, DebugLogSessionInfo, DebugLogStorageStats } from './utils/DebugStorage';
 /**
  * Информация о текущем браузере
@@ -111,6 +115,12 @@ export declare const browser: {
      * Возвращает сохраненное устройство вывода
      */
     getSavedOutput: typeof WebRTCUtils.getSavedOutput;
+    /** Возвращает способ выбора и фактически используемую камеру. */
+    getCameraSelection: typeof WebRTCUtils.getCameraSelection;
+    /** Возвращает способ выбора и фактически используемый микрофон. */
+    getMicrophoneSelection: typeof WebRTCUtils.getMicrophoneSelection;
+    /** Возвращает способ выбора и фактически используемый аудиовыход. */
+    getOutputSelection: typeof WebRTCUtils.getOutputSelection;
     /**
      * Проверяет получен ли доступ к камере
      */
@@ -144,43 +154,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 +214,7 @@ export declare const browser: {
      *
      * _Метод доступен до инициализации_
      */
-    isAudioShareSupported: typeof WebRTCUtils.isAudioShareSupported;
+    isAudioShareSupported: typeof BrowserEnvironment.isAudioShareSupported;
 };
 /**
  * Вспомогательные функции
@@ -266,6 +290,11 @@ 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[]>;
+/**
+ * Запускает отправку клиентской статистики. Нужен только при
+ * `autoStartStats: false`; повторные вызовы ничего не делают.
+ */
+export declare function startStats(): void;
 /**
  * Авторизоваться для совершения звонков
  *
@@ -325,8 +354,9 @@ export declare function hangup(params?: HangupParams): Promise<void>;
  *
  * @param externalIds Внешние ID пользователей
  * @param params Параметры
+ * @returns Участники из ответа сервера в публичном формате; undefined, если активного звонка нет или сигналинг не готов.
  */
-export declare function addParticipant(externalIds: ExternalId | ExternalId[], params?: AddParticipantParams): Promise<void>;
+export declare function addParticipant(externalIds: ExternalId | ExternalId[], params?: AddParticipantParams): Promise<ExternalParticipant[] | undefined>;
 /**
  * @deprecated - используйте addParticipant
  * @param uids
@@ -804,5 +834,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, 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, DeviceSelection, DeviceSelectionMode, };
+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,17 +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;
-};
-export type ClientEvent = {
-    timestamp: number;
-    call_topology: 'D' | 'S';
-    event_type: string;
-    vcid: ConversationData['id'] | null;
-    [k: string]: string | number | boolean | null;
+    [k: string]: string | string[] | number | boolean | null;
 };
 export type LogItem = {
     count?: number;
@@ -33,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 для очистки
@@ -69,8 +66,15 @@ export default abstract class BaseApi {
     log(items: LogItem[]): void;
     /**
      * method: vchat.clientStats
+     *
+     * Резолвится только после подтверждённой сервером отправки.
+     */
+    logClientStats(items: ClientStats[]): Promise<void>;
+    /**
+     * method: vchat.clientStats под сохранённым session_key другого
+     * пользователя. Одна попытка, без перелогина; AuthData не трогает.
      */
-    logClientStats(items: ClientStats[]): void;
+    logClientStatsWith(sessionKey: string, items: ClientStats[]): Promise<void>;
     abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
     getCachedParticipantIdByExternalId(externalId: ExternalId): ParticipantId | null;
     getCachedExternalIdByParticipantId(participantId: ParticipantId): ExternalParticipantId | null;