@vkontakte/calls-sdk 2.8.11-beta.1 → 2.8.11-dev.1ead2f25.0

package/classes/CallRegistry.d.ts

@@ -0,0 +1,20 @@
+import Conversation from './Conversation';
+export interface HoldableConversation extends Conversation {
+    id: string;
+    hold(hold: boolean): Promise<void>;
+}
+export declare class CallRegistry {
+    private _conversations;
+    private _activeId;
+    add(conversation: HoldableConversation): void;
+    remove(id: string | null): void;
+    get(id: string): HoldableConversation | undefined;
+    getActive(): HoldableConversation | null;
+    getActiveId(): string | null;
+    has(id: string): boolean;
+    getAll(): HoldableConversation[];
+    setActive(id: string): Promise<void>;
+    clear(): void;
+}
+declare const callRegistry: CallRegistry;
+export { callRegistry };

package/classes/Conversation.d.ts

@@ -16,7 +16,7 @@ import { ConversationData, ConversationOnStartParams } from '../types/Conversati
 import { ExternalId, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalUserId } from '../types/ExternalId';
 import type { FastJoinHandler } from '../types/FastJoin';
 import MediaModifiers from '../types/MediaModifiers';
-import { IVideoDimentions } from '../types/MediaSettings';
+import MediaSettings, { IVideoDimentions } from '../types/MediaSettings';
 import { IAddMovieParams, IUpdateMovieData } from '../types/MovieShare';
 import MuteStates from '../types/MuteStates';
 import { CompositeUserId, IGetParticipantsParameters, ParticipantId, ParticipantStateData } from '../types/Participant';
@@ -49,10 +49,8 @@ export default class Conversation extends EventEmitter {
     private _lastSignalledActiveSpeakerId;
     private _isRealTimeAsrRequested;
     private _serverSettings;
-    private static _current;
-    private static _activationMutex;
-    private static _delayedHangup;
-    private static _abortController;
+    private _delayedHangup;
+    private _abortController;
     private readonly _onUnload;
     private readonly _audioOutput;
     private _lastStalled;
@@ -69,6 +67,10 @@ export default class Conversation extends EventEmitter {
     static current(): Conversation | null;
     static hangupAfterInit(): void;
     static id(): string | null;
+    get id(): string;
+    get externalId(): ExternalParticipantId | undefined;
+    get mediaSettings(): MediaSettings | undefined;
+    get isCallHeld(): boolean;
     onStart({ opponentIds, opponentType, mediaOptions, payload, joiningAllowed, requireAuthToJoin, onlyAdminCanShareMovie, externalIds, onFastStart, conversationId, }: ConversationOnStartParams): Promise<ConversationData>;
     onJoin(joinArgs: {
         conversationId?: string;
@@ -393,6 +395,7 @@ export default class Conversation extends EventEmitter {
     private _onFeedback;
     private _onDecorativeParticipantIdChanged;
     private _onVideoSuspendSuggest;
+    private _onParticipantHold;
     private _isMe;
     private _getMuteStatesForRoomId;
     private _getMuteStatesForCurrentRoom;
@@ -402,6 +405,8 @@ export default class Conversation extends EventEmitter {
     private _getParticipants;
     private _getParticipant;
 }
+declare function _resetPendingInstance(): void;
+export { _resetPendingInstance };
 export declare class UpdateDisplayLayoutError extends Error {
     readonly participantErrors: {
         externalId: ExternalParticipantId;

package/classes/MediaSource.d.ts

@@ -45,6 +45,7 @@ export declare class MediaSource extends EventEmitter {
     /** Трек аудио эффектов. Не изменяется на протяжении всего времени */
     private _audioEffectsTrack;
     private _mediaSettings;
+    private _lastMediaSettings;
     private _videoStatusOnScreenCapturingEnabled;
     private _effect;
     private _audioEffectParams;
@@ -63,7 +64,11 @@ export declare class MediaSource extends EventEmitter {
     getSendAudioTrack(): MediaStreamTrack | null;
     get isAnimojiRequested(): boolean;
     addTrackToPeerConnection(pc: RTCPeerConnection, observer: boolean, noDataChannel: boolean): void;
+    /**
+     * @deprecated Используйте гетер mediaSettings
+     */
     getMediaSettings(): MediaSettings;
+    get mediaSettings(): MediaSettings;
     changeDevice(kind: MediaDeviceKind): Promise<void>;
     /**
      * Установка кастомного стрима для видео, например внешний шаринг экрана
@@ -91,6 +96,8 @@ export declare class MediaSource extends EventEmitter {
     private _setEffect;
     private _stopEffect;
     destroy(): void;
+    stopLocalMedia(): Promise<void>;
+    resumeLocalMedia(): Promise<void>;
     toggleScreenCapturing(settings: ScreenCaptureSettings): Promise<void>;
     disableScreenCapturing(): Promise<void>;
     private videoTrackMuteHandler;

package/classes/SignalingActor.d.ts

@@ -3,7 +3,12 @@ export declare class SignalingActor {
     private processor;
     private queue;
     private isProcessing;
+    private isHeld;
+    private isDestroyed;
     constructor(processor: (message: SignalingMessage) => Promise<unknown> | unknown);
     add(message: SignalingMessage): void;
+    hold(): void;
+    unhold(): void;
+    destroy(): void;
     private processQueue;
 }

package/default/Signaling.d.ts

@@ -173,6 +173,7 @@ export default class Signaling extends BaseSignaling {
     protected _handleCachedMessages(): void;
     private _throwError;
     private _onError;
+    private _serializeErrorEvent;
     protected _onClose(event: CloseEvent): void;
     protected _closeSocket(error?: Error | null): void;
     protected _reconnect(): void;

package/enums/SignalingNotification.d.ts

@@ -50,6 +50,7 @@ declare enum SignalingNotification {
     ASR_STARTED = "asr-started",
     ASR_STOPPED = "asr-stopped",
     DECORATIVE_PARTICIPANT_ID_CHANGED = "decorative-participant-id-changed",
-    VIDEO_SUSPEND_SUGGEST = "video-suspend-suggest"
+    VIDEO_SUSPEND_SUGGEST = "video-suspend-suggest",
+    HOLD = "hold"
 }
 export default SignalingNotification;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.11-beta.1",
+  "version": "2.8.11-dev.1ead2f25.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/static/Capabilities.d.ts

@@ -0,0 +1,5 @@
+import { TCapabilities } from '../types/Capabilities';
+declare namespace Capabilities {
+    function get(): TCapabilities;
+}
+export default Capabilities;

package/static/Debug.d.ts

@@ -8,10 +8,10 @@ export declare enum DebugMessageType {
     ERROR = "ERROR"
 }
 declare namespace Debug {
-    let debug: Function;
-    let log: Function;
-    let warn: Function;
-    let error: Function;
+    function debug(...args: any[]): void;
+    function log(...args: any[]): void;
+    function warn(...args: any[]): void;
+    function error(...args: any[]): void;
     function enabled(): boolean;
     function toggle(enable: boolean): void;
     function send(type: DebugMessageType, ...args: any[]): void;

package/static/External.d.ts

@@ -35,7 +35,8 @@ export declare enum ParticipantStatus {
     RECONNECT = "RECONNECT",
     ERROR = "ERROR",
     HANGUP = "HANGUP",
-    PERMISSIONS = "PERMISSIONS"
+    PERMISSIONS = "PERMISSIONS",
+    ONHOLD = "ONHOLD"
 }
 /**
  * Функции обратного вызова для передачи в параметрах инициализации
@@ -47,8 +48,9 @@ declare namespace External {
      *
      * @param stream
      * @param mediaSettings
+     * @param conversationId ID звонка
      */
-    function onLocalStream(stream: MediaStream | null, mediaSettings: MediaSettings): void;
+    function onLocalStream(stream: MediaStream | null, mediaSettings: MediaSettings, conversationId?: string): void;
     /**
      * Локальный стрим с экрана добавлен/удалён
      *
@@ -80,16 +82,18 @@ declare namespace External {
      * Изменился статус локального соединения
      *
      * @param status
+     * @param conversationId ID звонка
      */
-    function onLocalStatus(status: ParticipantStatus): void;
+    function onLocalStatus(status: ParticipantStatus, conversationId?: string): void;
     /**
      * Получен стрим собеседника.
      * Если сервер закончил стримить собеседника, вместо стрима будет передан null
      *
      * @param userId
      * @param stream
+     * @param conversationId ID звонка
      */
-    function onRemoteStream(userId: ExternalParticipantId, stream: MediaStream | null): void;
+    function onRemoteStream(userId: ExternalParticipantId, stream: MediaStream | null, conversationId?: string): void;
     /**
      * Получен стрим лайв от собеседника.
      * Если сервер закончил стримить собеседника, вместо стрима будет передан null
@@ -126,8 +130,9 @@ declare namespace External {
      *
      * @param userId
      * @param stream
+     * @param conversationId ID звонка
      */
-    function onRemoteScreenStream(userId: ExternalParticipantId, stream: MediaStream | null): void;
+    function onRemoteScreenStream(userId: ExternalParticipantId, stream: MediaStream | null, conversationId?: string): void;
     /**
      * Получен стрим вимоджи собеседника.
      * Если сервер закончил стримить собеседника, вместо стрима будет передан null
@@ -152,8 +157,9 @@ declare namespace External {
      * @param muteStates Состояние устройств при входе в звонок
      * @param participants Список участников звонка
      * @param rooms Список сессионных залов в звонке
+     * @param conversationId ID звонка
      */
-    function onConversation(userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants: ExternalParticipant[], rooms?: Rooms): void;
+    function onConversation(userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants: ExternalParticipant[], rooms?: Rooms, conversationId?: string): void;
     /**
      * Постраничные данные про участников при начале звонка
      * @param chunk
@@ -219,15 +225,17 @@ declare namespace External {
      *
      * @param userId
      * @param markers
+     * @param conversationId ID звонка
      */
-    function onParticipantAdded(userId: ExternalId, markers: ExternalParticipantListMarkers | null): void;
+    function onParticipantAdded(userId: ExternalId, markers: ExternalParticipantListMarkers | null, conversationId?: string): void;
     /**
      * Участник подключился
      *
      * @param userId
      * @param markers
+     * @param conversationId ID звонка
      */
-    function onParticipantJoined(userId: ExternalId, markers: ExternalParticipantListMarkers | null): void;
+    function onParticipantJoined(userId: ExternalId, markers: ExternalParticipantListMarkers | null, conversationId?: string): void;
     function onLocalParticipantState(participantState: ParticipantStateMapped, global?: boolean): void;
     /**
      * Изменились данные состояний собеседника
@@ -250,8 +258,9 @@ declare namespace External {
      * @param userIds
      * @param status
      * @param data
+     * @param conversationId ID звонка
      */
-    function onRemoteStatus(userIds: ExternalParticipantId[], status: ParticipantStatus, data?: any): void;
+    function onRemoteStatus(userIds: ExternalParticipantId[], status: ParticipantStatus, data?: any, conversationId?: string): void;
     /**
      * Разрешения на доступы были запрошены в браузере
      */
@@ -268,23 +277,26 @@ declare namespace External {
      *
      * @param userId
      * @param markers
+     * @param conversationId ID звонка
      */
-    function onRemoteRemoved(userId: ExternalParticipantId, markers: ExternalParticipantListMarkers | null): void;
+    function onRemoteRemoved(userId: ExternalParticipantId, markers: ExternalParticipantListMarkers | null, conversationId?: string): void;
     /**
      * Изменилось состояние звонка
      *
      * @param isCallActive Активен ли сейчас звонок
      * @param canAddParticipants Можно ли добавлять собеседников
      * @param conversation Информация о звонке
+     * @param conversationId ID звонка
      */
-    function onCallState(isCallActive: boolean, canAddParticipants: boolean, conversation: ConversationData): void;
+    function onCallState(isCallActive: boolean, canAddParticipants: boolean, conversation: ConversationData, conversationId?: string): void;
     /**
      * Изменилось состояние камеры или микрофона
      *
      * @param mediaOption Тип устройства
      * @param enabled Включено или выключено
+     * @param conversationId ID звонка
      */
-    function onDeviceSwitched(mediaOption: MediaOption, enabled: boolean): void;
+    function onDeviceSwitched(mediaOption: MediaOption, enabled: boolean, conversationId?: string): void;
     /**
      * Изменились состояния устройств пользователя или разрешения включать камеру/микрофон
      *
@@ -339,21 +351,32 @@ declare namespace External {
     function onOptionsChanged(options: ConversationOption[]): void;
     /**
      * Входящий звонок был принят мной
+     *
+     * @param conversationId ID звонка
+     */
+    function onCallAccepted(conversationId?: string): void;
+    /**
+     * Установление определенного звонка как активного
+     *
+     * @param conversationId ID звонка
      */
-    function onCallAccepted(): void;
+    function onCallActive(conversationId: string): void;
     /**
      * Исходящий звонок был принят кем-то
+     *
      * @param userId
      * @param capabilities
+     * @param conversationId ID звонка
      */
-    function onAcceptedCall(userId: ExternalId, capabilities: ParticipantCapabilities): void;
+    function onAcceptedCall(userId: ExternalId, capabilities: ParticipantCapabilities, conversationId?: string): void;
     function onRateNeeded(): void;
     /**
      * Изменился говорящий в звонке
      *
      * @param userId
+     * @param conversationId ID звонка
      */
-    function onSpeakerChanged(userId: ExternalParticipantId): void;
+    function onSpeakerChanged(userId: ExternalParticipantId, conversationId?: string): void;
     /**
      * Громкость собеседников
      *

package/static/Params.d.ts

@@ -343,6 +343,9 @@ export type ParamsObject = {
      * Включает поддержку режима WAIT_FOR_ADMIN в звонках.
      */
     waitForAdminInGroupCalls: boolean;
+    /**
+     * Включает поддержку удержания звонка
+     */
     hold: boolean;
     /**
      * Индекс участника для первого chunk'а который придет при установке соединения с сервером
@@ -490,7 +493,7 @@ export type ParamsObject = {
     /**
      * Получен локальный стрим с камеры/микрофона
      */
-    onLocalStream?: (stream: MediaStream | null, mediaSettings: MediaSettings) => void;
+    onLocalStream?: (stream: MediaStream | null, mediaSettings: MediaSettings, conversationId?: string) => void;
     /**
      * Локальный стрим изменился
      */
@@ -510,12 +513,12 @@ export type ParamsObject = {
     /**
      * Изменился статус локального соединения
      */
-    onLocalStatus?: (status: ParticipantStatus) => void;
+    onLocalStatus?: (status: ParticipantStatus, conversationId?: string) => void;
     /**
      * Получен стрим собеседника.
      * Если сервер закончил стримить собеседника, вместо стрима будет передан null
      */
-    onRemoteStream?: (userId: ExternalParticipantId, stream: MediaStream | null) => void;
+    onRemoteStream?: (userId: ExternalParticipantId, stream: MediaStream | null, conversationId?: string) => void;
     /**
      * Cтрим собеседника приостановлен/возобновлен.
      */
@@ -524,7 +527,7 @@ export type ParamsObject = {
      * Получен стрим с экрана собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
      */
-    onRemoteScreenStream?: (userId: ExternalParticipantId, stream: MediaStream | null) => void;
+    onRemoteScreenStream?: (userId: ExternalParticipantId, stream: MediaStream | null, conversationId?: string) => void;
     /**
      * Получен стрим вимоджи собеседника.
      * Если сервер закончил стримить вимоджи собеседника, вместо стрима будет передан null
@@ -551,7 +554,7 @@ export type ParamsObject = {
     /**
      * Начат звонок
      */
-    onConversation?: (userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants: ExternalParticipant[], rooms?: Rooms) => void;
+    onConversation?: (userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants: ExternalParticipant[], rooms?: Rooms, conversationId?: string) => void;
     /**
      * Начальный список участников для постраничного звонка
      */
@@ -583,11 +586,11 @@ export type ParamsObject = {
     /**
      * Добавили участника
      */
-    onParticipantAdded?: (userId: ExternalParticipantId, markers: ExternalParticipantListMarkers | null) => void;
+    onParticipantAdded?: (userId: ExternalParticipantId, markers: ExternalParticipantListMarkers | null, conversationId?: string) => void;
     /**
      * Участник присоединился к звонку
      */
-    onParticipantJoined?: (userId: ExternalParticipantId, markers: ExternalParticipantListMarkers) => void;
+    onParticipantJoined?: (userId: ExternalParticipantId, markers: ExternalParticipantListMarkers, conversationId?: string) => void;
     /**
      * Получены данные по изменению локальных состояний со стороны админа
      * Например, принудительно опущена рука
@@ -607,7 +610,7 @@ export type ParamsObject = {
     /**
      * Изменился статус соединения собеседников
      */
-    onRemoteStatus?: (userIds: ExternalParticipantId[], status: ParticipantStatus, data: any) => void;
+    onRemoteStatus?: (userIds: ExternalParticipantId[], status: ParticipantStatus, data: any, conversationId?: string) => void;
     /**
      * Разрешения на доступы были запрошены в браузере
      */
@@ -619,15 +622,15 @@ export type ParamsObject = {
     /**
      * Пользователь отключился от звонка
      */
-    onRemoteRemoved?: (userId: ExternalParticipantId, markers: ExternalParticipantListMarkers | null) => void;
+    onRemoteRemoved?: (userId: ExternalParticipantId, markers: ExternalParticipantListMarkers | null, conversationId?: string) => void;
     /**
      * Изменилось состояние звонка
      */
-    onCallState?: (isCallActive: boolean, canAddParticipants: boolean, conversation: ConversationData) => void;
+    onCallState?: (isCallActive: boolean, canAddParticipants: boolean, conversation: ConversationData, conversationId?: string) => void;
     /**
      * Изменилось состояние камеры или микрофона
      */
-    onDeviceSwitched?: (mediaOption: MediaOption, enabled: boolean) => void;
+    onDeviceSwitched?: (mediaOption: MediaOption, enabled: boolean, conversationId?: string) => void;
     /**
      * Изменились состояния устройств пользователя или разрешения включать камеру/микрофон
      */
@@ -656,7 +659,7 @@ export type ParamsObject = {
     /**
      * Изменился говорящий в звонке
      */
-    onSpeakerChanged?: (userId: ExternalParticipantId) => void;
+    onSpeakerChanged?: (userId: ExternalParticipantId, conversationId?: string) => void;
     /**
      * Громкость собеседников
      */
@@ -676,12 +679,12 @@ export type ParamsObject = {
     /**
      * Входящий звонок был принят мной
      */
-    onCallAccepted?: () => void;
+    onCallAccepted?: (conversationId?: string) => void;
     /**
      * Исходящий звонок был принят кем-то
      * @param userId
      */
-    onAcceptedCall?: (userId: ExternalParticipantId, capabilities: ParticipantCapabilities) => void;
+    onAcceptedCall?: (userId: ExternalParticipantId, capabilities: ParticipantCapabilities, conversationId?: string) => void;
     /**
      * Список устройств изменился
      */
@@ -859,6 +862,12 @@ export type ParamsObject = {
      * @param demoted участник разжалован
      */
     onPromoted?: (demoted: boolean) => void;
+    /**
+     * Активным установлен определенный звонок
+     *
+     * @param conversationId ID звонка
+     */
+    onCallActive?: (conversationId: string) => void;
     /**
      * Собеседник подключился к сигналлингу
      */

package/types/Capabilities.d.ts

@@ -0,0 +1,24 @@
+export type TCapabilities = {
+    estimatedPerformanceIndex: number;
+    audioMix: boolean;
+    consumerUpdate: boolean;
+    producerNotificationDataChannelVersion: number;
+    producerCommandDataChannelVersion: number;
+    consumerScreenDataChannelVersion: number;
+    producerScreenDataChannelVersion: number;
+    asrDataChannelVersion: number;
+    animojiDataChannelVersion: number;
+    animojiBackendRender: boolean;
+    onDemandTracks: boolean;
+    unifiedPlan: boolean;
+    singleSession: boolean;
+    videoTracksCount: number;
+    red: boolean;
+    audioShare: boolean;
+    fastScreenShare: boolean;
+    videoSuspend: boolean;
+    simulcast: boolean;
+    consumerFastScreenShare: boolean;
+    consumerFastScreenShareQualityOnDemand: boolean;
+    transparentAudio: boolean;
+};

package/types/SignalingMessage.d.ts

@@ -452,6 +452,10 @@ declare namespace SignalingMessage {
     export interface VideoSuspendSuggest extends Notification {
         bandwidth: number;
     }
+    export interface Hold extends Notification {
+        participantId: ParticipantId;
+        hold: boolean;
+    }
     export {};
 }
 export default SignalingMessage;

package/types/WebTransport.d.ts

@@ -20,6 +20,7 @@ declare class WebTransportEventual {
     private readChunks;
     private readLoop;
     send(data: string): Promise<void>;
+    private createErrorEvent;
     close(code?: number, reason?: string): void;
     static isBrowserSupported(): boolean;
 }