@vkontakte/calls-sdk 2.6.2-dev.3e4fbdf.0 → 2.6.2-dev.459e12e.0

package/static/Params.d.ts

@@ -6,7 +6,9 @@ import ChatRoomEventType from '../enums/ChatRoomEventType';
 import ConversationOption from '../enums/ConversationOption';
 import FatalError from '../enums/FatalError';
 import MediaOption from '../enums/MediaOption';
+import RoomsEventType from '../enums/RoomsEventType';
 import UserRole from '../enums/UserRole';
+import { IFeaturesPerRole } from '../types/ConversationFeature';
 import { ExternalId, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalParticipantListMarkers } from '../types/ExternalId';
 import { IFeedbackExternal } from '../types/Feedback';
 import IceServer from '../types/IceServer';
@@ -15,6 +17,7 @@ import MediaSettings from '../types/MediaSettings';
 import { IOnRemoteMovieData, ISharedMovieInfo, ISharedMovieState, ISharedMovieStoppedInfo } from '../types/MovieShare';
 import MuteStates from '../types/MuteStates';
 import { ParticipantStateMapped } from '../types/Participant';
+import { Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from '../types/Room';
 import AuthData from './AuthData';
 import { DebugMessageType } from './Debug';
 import { ParticipantStatus } from './External';
@@ -172,9 +175,6 @@ export declare type ParamsObject = {
     };
     perfStatReportEnabled: boolean;
     callStatReportEnabled: boolean;
-    unifiedPlanBrowsers: {
-        [key: string]: number;
-    };
     /**
      * Отдавать приоритет кодеку H264 для исходящего видео
      *
@@ -236,28 +236,44 @@ export declare type ParamsObject = {
     breakVideoPayloadTypes: boolean;
     /**
      * Включить постраничный вывод участников. Работает только если включено videoTracksCount (слоты)
+     *
+     * _По умолчанию: `false`_
      */
     useParticipantListChunk: boolean;
     /**
-     * Индекс участника для первого chunk'а который придет при установки соединения с сервером
+     * Включить комнаты
+     *
+     * _По умолчанию: `false`_
+     */
+    useRooms: boolean;
+    /**
+     * Индекс участника для первого chunk'а который придет при установке соединения с сервером
+     *
+     * _По умолчанию: `0`_
      */
     participantListChunkInitIndex: number;
     /**
-     * Количество участников которые придут в первом chunk'е при установки соединения с сервером
+     * Количество участников которые придут в первом chunk'е при установке соединения с сервером
      * если параметр не проставлен то будет использоваться значение по умолчанию установленное на сервере
      */
     participantListChunkInitCount: number | null;
     /**
      * Включать RED-extension (redundancy) для групповых звонков
+     *
+     * _По умолчанию: `false`_
      */
     serverAudioRed: boolean;
     /**
      * Включать RED-extension (redundancy) для p2p звонков
+     *
+     * _По умолчанию: `false`_
      */
     p2pAudioRed: boolean;
     /**
      * Добавлять флаг spsPpsIdrInKeyframe для h264 кодека. В результате ключевые фреймы без sps и pps
      * не используются как ключевые. Решает проблему с артефактами на видео в случае потерь пакетов.
+     *
+     * _По умолчанию: `false`_
      */
     h264spsPpsIdrInKeyframe: boolean;
     /**
@@ -283,6 +299,11 @@ export declare type ParamsObject = {
      * @hidden
      */
     preserveAudioTracks: boolean;
+    /**
+     * Использовать congestion control для шаринга
+     * @hidden
+     */
+    screenShareCongestionControl: boolean;
     /**
      * Получен локальный стрим с камеры/микрофона
      */
@@ -330,7 +351,7 @@ export declare type ParamsObject = {
     /**
      * Начат звонок
      */
-    onConversation?: (userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[]) => void;
+    onConversation?: (userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[], rooms?: Rooms) => void;
     /**
      * Начальный список участников для постраничного звонка
      */
@@ -403,7 +424,7 @@ export declare type ParamsObject = {
     /**
      * Изменились состояния устройств пользователя или разрешения включать камеру/микрофон
      */
-    onMuteStates?: (muteStates: MuteStates, unmuteOptions: MediaOption[], mediaOptions: MediaOption[], muteAll: boolean, unmute: boolean, userId: ExternalParticipantId | null, adminId: ExternalParticipantId | null, stateUpdated?: boolean, requestedMedia?: MediaOption[]) => void;
+    onMuteStates?: (muteStates: MuteStates, unmuteOptions: MediaOption[], mediaOptions: MediaOption[], muteAll: boolean, unmute: boolean, userId: ExternalParticipantId | null, adminId: ExternalParticipantId | null, stateUpdated?: boolean, requestedMedia?: MediaOption[], roomId?: number | null) => void;
     /**
      * Изменились роли собеседника в звонке
      */
@@ -473,11 +494,11 @@ export declare type ParamsObject = {
     /**
      * Начата трансляция/запись звонка
      */
-    onRecordStarted?: (initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string) => void;
+    onRecordStarted?: (initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string, roomId?: number | null) => void;
     /**
      * Закончена трансляция/запись звонка
      */
-    onRecordStopped?: () => void;
+    onRecordStopped?: (roomId: number | null) => void;
     /**
      * Состояние своей сети
      *
@@ -524,11 +545,39 @@ export declare type ParamsObject = {
      * @param joinLink токен присоединения к звонку
      */
     onJoinLinkChanged?: (joinLink: string) => void;
+    /**
+     * Получено обновление списка комнат
+     * @param updates список обновлений по комнатам
+     */
+    onRoomsUpdated?: (updates: Partial<Record<RoomsEventType, RoomsUpdate>>) => void;
+    /**
+     * Получено обновление комнаты
+     * @param eventTypes список событий
+     * @param roomId номер комнаты
+     * @param room комната
+     */
+    onRoomUpdated?: (eventTypes: RoomsEventType[], roomId: number, room: Room | null, deactivate: boolean | null) => void;
+    /**
+     * Получение обновление списка участников в комнате
+     * @param update обновление списка участников
+     */
+    onRoomParticipantsUpdated?: (update: RoomParticipantUpdate) => void;
     /**
      * Получены новые реакции в звонке
      * @param feedback массив с реакциями
      */
     onFeedback?: (feedback: IFeedbackExternal[]) => void;
+    /**
+     * Включать capability c аудио шарой
+     */
+    audioShareCapabilityEnabled: boolean;
+    /**
+     * Изменился список ролей, которым доступны ConversationFeatures
+     *
+     * @param featuresPerRole Объект вида ключ: ConversationFeature = значение: UserRole[]
+     * (если ключ фичи отсутствует, или в ролях пустой массив, считаем фичу доступной для всех пользователей)
+     */
+    onFeaturesPerRoleChanged?: (featuresPerRole: IFeaturesPerRole) => void;
 };
 export default abstract class Params {
     private static _params;
@@ -615,12 +664,12 @@ export default abstract class Params {
     static get audioNack(): boolean;
     static get consumerScreenTrack(): boolean;
     static get producerScreenTrack(): boolean;
-    static isUnifiedPlanSupported(name: string, version: number): boolean;
     static get movieShare(): boolean;
     static get videoTracksCount(): number;
     static get breakVideoPayloadTypes(): boolean;
     static get filteredMessages(): boolean;
     static get useParticipantListChunk(): boolean;
+    static get useRooms(): boolean;
     static get participantListChunkInitIndex(): number;
     static get participantListChunkInitCount(): number;
     static get serverAudioRed(): boolean;
@@ -630,4 +679,6 @@ export default abstract class Params {
     static get filterObservers(): boolean;
     static get muteMode(): boolean;
     static get preserveAudioTracks(): boolean;
+    static get audioShareCapabilityEnabled(): boolean;
+    static get screenShareCongestionControl(): boolean;
 }

package/static/Polyfills.d.ts

@@ -0,0 +1,7 @@
+export declare const fromEntries: {
+    <T = any>(entries: Iterable<readonly [PropertyKey, T]>): {
+        [k: string]: T;
+    };
+    (entries: Iterable<readonly any[]>): any;
+};
+export declare function blobToArrayBuffer(data: Blob): Promise<ArrayBuffer>;

package/static/Utils.d.ts

@@ -6,7 +6,8 @@ import VideoSettings from '../types/VideoSettings';
 export declare const PARAMETERS_SEPARATOR = ":";
 export declare const DEVICE_IDX_PARAMETER = "d";
 declare namespace Utils {
-    function patchSDP(sdp: string, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, h264spsPpsIdrInKeyframe: boolean, isAudioNack?: boolean, preferRed?: boolean): string;
+    function patchLocalSDP(sdp: string, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, h264spsPpsIdrInKeyframe: boolean, isAudioNack?: boolean, preferRed?: boolean): string;
+    function patchRemoteSDP(sdp: string): string;
     function getPeerIdString(peerId: SignalingMessage.PeerId): string;
     function comparePeerId(peerId1: SignalingMessage.PeerId, peerId2: SignalingMessage.PeerId): boolean;
     function getPeerConnectionHostInfo(pc: RTCPeerConnection): Promise<any>;

package/static/WebRTCUtils.d.ts

@@ -10,6 +10,47 @@ export declare enum FacingMode {
     LEFT = "left",
     RIGHT = "right"
 }
+/********************* MediaConstraints *********************/
+/**
+ * Вспомогательный класс для формирования параметров, которые нужны для запроса камеры и микрофона.
+ * @hidden
+ */
+declare class MediaConstraints {
+    protected audio: MediaTrackConstraints | boolean;
+    protected video: MediaTrackConstraints | boolean;
+    private readonly needVideo;
+    constructor(audioDeviceId: boolean | string, videoDeviceId?: boolean | string, videoMaxWidth?: number, videoMaxHeight?: number);
+    /**
+     * Возвращает нативные параметры для передачи в getUserMedia.
+     */
+    getNative(): object;
+    /**
+     * Метод упрощает параметры, чтобы попробовать сделать getUserMedia еще раз при ошибке.
+     * Сначала убираются размеры, потом соотношения сторон.
+     */
+    simplify(): MediaConstraints;
+    /**
+     * Проверяет, можно ли упростить параметры.
+     */
+    canSimplify(): boolean;
+    /**
+     * Проверяет, есть ли параметры видео.
+     */
+    isVideo(): boolean;
+    /**
+     * Проверяет, есть ли параметры аудио.
+     */
+    isAudio(): boolean;
+}
+/********************* /MediaConstraints *********************/
+/********************* ScreenConstraints *********************/
+/**
+ * Вспомогательный класс для формирования параметров, которые нужны для запроса трансляции экрана.
+ * @hidden
+ */
+export declare class ScreenConstraints extends MediaConstraints {
+    constructor(width: number, height: number, withAudioShare: boolean);
+}
 declare namespace WebRTCUtils {
     /**
      * Инициализирует устройства. До вызова этого метода бесполезно опрашивать другие публичные методы
@@ -64,9 +105,9 @@ declare namespace WebRTCUtils {
      */
     function getUserMedia(needVideo?: boolean, needAudio?: boolean, needEmptyTracks?: boolean): Promise<MediaStream>;
     /**
-     * Запрашивает трансляцию экрана пользователя
+     * Запрашивает трансляцию экрана пользователя с опциональным захватом звука
      */
-    function getScreenMedia(): Promise<MediaStream>;
+    function getScreenMedia(withAudioShare: boolean): Promise<MediaStream>;
     /**
      * Запрашивает камеру пользователя
      *
@@ -100,15 +141,6 @@ declare namespace WebRTCUtils {
      * Проверяет поддержку шаринга экрана браузером
      */
     function isScreenCapturingSupported(): boolean;
-    /**
-     * Проверяет доступность кодека VP8 при использовании WebRTC.
-     * Кодек может быть доступен, даже если видео VP8 в браузере не поддерживается.
-     */
-    function canVP8(): boolean;
-    /**
-     * Проверяет используемый план (unified-plan или plan-b)
-     */
-    function isUnifiedPlan(): boolean;
     /**
      * В некоторых браузерах H264 сломан
      */
@@ -146,5 +178,6 @@ declare namespace WebRTCUtils {
      * Возвращает подверсию браузера (если она есть)
      */
     function browserSubVersion(): string;
+    function isAudioShareSupported(): boolean;
 }
 export default WebRTCUtils;

package/static/WebRTCUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/Asr.d.ts

@@ -0,0 +1,5 @@
+import { ParticipantId } from './Participant';
+export interface AsrInfo {
+    movieId: number;
+    initiatorId: ParticipantId;
+}

package/types/Conversation.d.ts

@@ -9,4 +9,5 @@ export interface IProcessMuteStateParams {
     admin?: Participant | null;
     stateUpdated?: boolean;
     requestedMedia?: MediaOption[];
+    roomId?: number | null;
 }

package/types/ConversationFeature.d.ts

@@ -0,0 +1,3 @@
+import ConversationFeature from '../enums/ConversationFeature';
+import UserRole from '../enums/UserRole';
+export declare type IFeaturesPerRole = Partial<Record<ConversationFeature, UserRole[]>>;

package/types/MediaSettings.d.ts

@@ -14,6 +14,10 @@ export declare type MediaSettings = {
      * Включена ли трансляция экрана
      */
     isScreenSharingEnabled: boolean;
+    /**
+     * Включена ли трансляция звука
+     */
+    isAudioSharingEnabled: boolean;
     videoStreams: VideoStreamInfo[];
 };
 export declare type VideoStreamInfo = {

package/types/MovieShare.d.ts

@@ -1,3 +1,4 @@
+import LiveStatus from '../enums/LiveStatus';
 import { OkUserId, CompositeUserId } from './Participant';
 import { MediaType } from './ParticipantStreamDescription';
 export interface IMoviePreview {
@@ -18,7 +19,8 @@ export declare type ISharedMovieStateResponse = [
     number,
     boolean,
     number,
-    boolean
+    boolean,
+    number
 ];
 export interface ISharedMovieState {
     participantId: CompositeUserId;
@@ -26,6 +28,7 @@ export interface ISharedMovieState {
     pause?: boolean;
     offset?: number;
     mute?: boolean;
+    liveStatus?: LiveStatus;
 }
 export interface IUpdateMovieData {
     movieId: string;

package/types/Participant.d.ts

@@ -57,6 +57,7 @@ export interface Participant {
     observedIds: CompositeUserId[];
     markers?: ExternalParticipantListMarkers;
     movieShareInfos?: ISharedMovieInfo[];
+    isInRoom?: boolean;
 }
 export interface IGetParticipantsParameters {
     externalIds: ExternalId[];

package/types/ParticipantListChunk.d.ts

@@ -10,4 +10,6 @@ export interface ParticipantListChunkParameters {
     backward?: boolean;
     /** If true then resulting chunk will start from Participant with specified marker, if such Participant (still) exists */
     includeMarker?: boolean;
+    /** optional, id of the room to get chunk for, main call if unspecified */
+    roomId?: number | null;
 }

package/types/ParticipantStreamDescription.d.ts

@@ -6,7 +6,8 @@ export declare enum MediaType {
     CAMERA = "CAMERA",
     SCREEN = "SCREEN",
     STREAM = "STREAM",
-    MOVIE = "MOVIE"
+    MOVIE = "MOVIE",
+    AUDIOSHARE = "AUDIOSHARE"
 }
 export declare function serializeParticipantStreamDescription(description: ParticipantStreamDescription): string;
 export declare function parseParticipantStreamDescription(descriptionString: string): ParticipantStreamDescription;

package/types/Room.d.ts

@@ -0,0 +1,77 @@
+import { ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk } from './ExternalId';
+import MuteStates from './MuteStates';
+import { ParticipantListMarkers } from './Participant';
+export interface Room {
+    id: number;
+    /**
+     * name of this room
+     */
+    name: string;
+    /**
+     * count of participants (read/write, optional)
+     */
+    participantCount: number;
+    /**
+     * ids of all participants (read/write, optional)
+     */
+    participantIds: ExternalParticipantId[];
+    /**
+     * ids of participants to be added to this room (read/write, optional)
+     */
+    addParticipantIds?: ExternalParticipantId[];
+    /**
+     * ids of participants to be removed from this room (read/write, optional)
+     */
+    removeParticipantIds?: ExternalParticipantId[];
+    /**
+     * if participant requested then contains first chunk of participants in this rooms
+     * (if client fails to support chunks, then contains all participant in this room)
+     * (read, optional)
+     */
+    participants?: ExternalParticipantListChunk;
+    /**
+     * if this room is active (read/write, optional)
+     */
+    active?: boolean;
+    /**
+     * global (room-wide) mute state, if any
+     */
+    muteStates?: MuteStates;
+}
+/**
+ * Initial rooms state
+ */
+export interface Rooms {
+    rooms: Room[];
+    /**
+     * current room id of participant.  if null then the partipant is in the main call
+     */
+    roomId?: number;
+}
+export interface RoomsUpdate {
+    rooms?: Room[];
+    roomIds?: number[];
+    deactivated?: boolean;
+}
+export interface RoomParticipantUpdate {
+    roomId: number | null;
+    /**
+     * total number of participants in the room
+     */
+    participantCount: number;
+    /**
+     * ids of added participants, always present (if any) so participants would be able
+     * to identify their presence in particular room
+     */
+    addedParticipantIds?: ExternalParticipantId[];
+    /**
+     * optional, data for added participants
+     */
+    addedParticipants?: ExternalParticipant[];
+    /**
+     * optional, depending on the context may contain either markers
+     * for all (sorted) lists available or be empty (if client fails to support chunked participants)
+     */
+    removedParticipantMarkers?: ParticipantListMarkers[];
+    removedParticipantIds?: ExternalParticipantId[];
+}

package/types/SignalingMessage.d.ts

@@ -5,9 +5,12 @@ import ConversationOption from '../enums/ConversationOption';
 import HangupType from '../enums/HangupType';
 import MediaOption from '../enums/MediaOption';
 import ParticipantState from '../enums/ParticipantState';
+import RoomsEventType from '../enums/RoomsEventType';
 import UserRole from '../enums/UserRole';
 import UserType from '../enums/UserType';
+import { IFeaturesPerRole } from './ConversationFeature';
 import { IFeedback } from './Feedback';
+import { AsrInfo } from './Asr';
 import MediaModifiers from './MediaModifiers';
 import MediaSettings from './MediaSettings';
 import { ISharedMovieInfo, ISharedMovieState, ISharedMovieStoppedInfo } from './MovieShare';
@@ -75,11 +78,25 @@ declare namespace SignalingMessage {
         multichatId: string | null;
         tamtamMultichatId: string | null;
         recordInfo: RecordInfo | null;
-        featuresPerRole?: Partial<Record<ConversationFeature, UserRole[]>> | null;
+        featuresPerRole?: IFeaturesPerRole | null;
         pinnedParticipantId: ParticipantId | null;
         options: ConversationOption[];
         muteStates?: MuteStates;
     }
+    export interface Room extends SignalingMessage {
+        id?: number;
+        name?: string;
+        participantCount?: number;
+        participantIds?: CompositeUserId[];
+        addParticipantIds?: CompositeUserId[];
+        removeParticipantIds?: CompositeUserId[];
+        participants?: ParticipantListChunk;
+        active?: boolean;
+        countdownSec?: number;
+        timeoutMs?: number;
+        muteStates?: MuteStates;
+        recordInfo?: RecordInfo;
+    }
     interface Notification extends SignalingMessage {
         type?: string;
         notification?: string;
@@ -156,6 +173,7 @@ declare namespace SignalingMessage {
         stateUpdated?: boolean;
         unmute?: boolean;
         muteAll?: boolean;
+        roomId?: number;
     }
     export interface PinParticipant extends Notification {
         participantId: ParticipantId;
@@ -190,7 +208,7 @@ declare namespace SignalingMessage {
     }
     export interface FeatureSetChanged extends Notification {
         features: ConversationFeature[];
-        featuresPerRole?: Partial<Record<ConversationFeature, UserRole[]>> | null;
+        featuresPerRole?: IFeaturesPerRole | null;
     }
     export interface MultipartyChatCreated extends Notification {
         chatId: string;
@@ -280,6 +298,10 @@ declare namespace SignalingMessage {
         mediaModifiers: MediaModifiers;
         participants?: ParticipantListChunk;
         chatRoom?: ChatRoom;
+        rooms?: {
+            rooms: Room[];
+            roomId?: number;
+        };
     }
     export interface JoinLinkChanged extends Notification {
         joinLink: string;
@@ -295,6 +317,35 @@ declare namespace SignalingMessage {
     }
     export interface SharedMovieStoppedInfo extends Notification, ISharedMovieStoppedInfo {
     }
+    export interface RoomsUpdated extends Notification {
+        updates: Partial<Record<RoomsEventType, {
+            rooms?: Room;
+            roomIds?: number[];
+            deactivated?: boolean;
+        }>>;
+    }
+    export interface RoomUpdated extends Notification {
+        events: RoomsEventType[];
+        room?: Room;
+        roomId: number;
+        deactivate?: boolean;
+    }
+    export interface RoomParticipantsUpdated extends Notification {
+        roomId?: number;
+        participantCount: number;
+        addedParticipantIds?: CompositeUserId[];
+        addedParticipants?: Participant[];
+        removedParticipantMarkers?: ParticipantListMarkers[];
+    }
+    export interface FeaturesPerRoleChanged extends Notification {
+        featuresPerRole?: IFeaturesPerRole | null;
+    }
+    export interface AsrStarted extends Notification {
+        asrInfo: AsrInfo;
+    }
+    export interface AsrStopped extends Notification {
+        movieId: number;
+    }
     export {};
 }
 export default SignalingMessage;

package/utils/ArrayDequeue.d.ts

@@ -0,0 +1,24 @@
+export declare class ArrayDequeue<T = any> {
+    /** очередь */
+    private readonly _queue;
+    /** курсор для чтения */
+    private _readCursor;
+    /** курсор для записи */
+    private _writeCursor;
+    /** подвинуть курсор чтения */
+    private _moveReadCursor;
+    /** сколько осталось в очереди элементов */
+    private _left;
+    constructor(length: number);
+    /** возвращает длину, переданную в конструктор */
+    get length(): number;
+    /** возвращает текущую длину очереди */
+    get left(): number;
+    toArray(): T[];
+    /** добавить элемент в очередь */
+    add(element: T): void;
+    /** вычисляет значение след курсора по кругу */
+    private nextCursor;
+    /** получить следующий элемент */
+    next(): T | null;
+}

package/utils/ArrayDequeue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/worker/LibVPxEncoderWorker.d.ts

@@ -1,4 +1,4 @@
 /// <reference lib="webworker" />
 import type libvpx from '@vkontakte/libvpx';
-declare const _default: (vpx: typeof libvpx, urlResolver: (url: string) => string) => void;
+declare const _default: (vpx: typeof libvpx, urlResolver: (url: string) => string, useCongestionControl: boolean, maxBitrate: number) => void;
 export default _default;