@vkontakte/calls-sdk 2.6.2-dev.d0c4f88.0 → 2.6.2-dev.e25d5b7.0

package/static/External.d.ts

@@ -6,13 +6,17 @@ 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 MediaModifiers from '../types/MediaModifiers';
 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 { DebugMessageType } from './Debug';
 import { JSONObject } from './Json';
 /**
@@ -113,8 +117,9 @@ declare namespace External {
      * @param mediaModifiers Текущие настройки пользовательского медиа
      * @param muteStates Состояние устройств при входе в звонок
      * @param participants Список участников звонка (при `Params.batchParticipantsOnStart = true`)
+     * @param rooms Список комнат в звонке
      */
-    function onConversation(userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[]): void;
+    function onConversation(userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[], rooms?: Rooms): void;
     /**
      * Постраничные данные про участников при начале звонка
      * @param chunk
@@ -412,5 +417,34 @@ declare namespace External {
      * @param joinLink токен присоединения к звонку
      */
     function onJoinLinkChanged(joinLink: string): void;
+    /**
+     */
+    function onRoomsUpdated(updates: Partial<Record<RoomsEventType, RoomsUpdate>>): void;
+    /**
+     */
+    function onRoomUpdated(eventTypes: RoomsEventType[], roomId: number, room: Room | null, deactivate: boolean | null): void;
+    /**
+     */
+    function onRoomParticipantsUpdated(update: RoomParticipantUpdate): void;
+    /**
+     * Получена новая реакция
+     */
+    function onFeedback(feedback: IFeedbackExternal[]): void;
+    /**
+     * Изменилось состояние пермиссий фич в звонке
+     *
+     * @param featuresPerRole Информация о доступных фичах по ролям
+     */
+    function onFeaturesPerRoleChanged(featuresPerRole: IFeaturesPerRole): void;
+    /**
+     * Начата текстовая расшифровка звонка
+     * @param initiatorId Id пользователя, запустившего расшифровку звонка
+     * @param movieId Id расшифровки
+     */
+    function onAsrStarted(initiatorId: ExternalParticipantId, movieId: number): void;
+    /**
+     * Закончена текстовая расшифровка звонка
+     */
+    function onAsrStopped(): void;
 }
 export default External;

package/static/Params.d.ts

@@ -6,14 +6,18 @@ 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';
 import MediaModifiers from '../types/MediaModifiers';
 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';
@@ -25,6 +29,7 @@ import { FacingMode } from './WebRTCUtils';
 export declare type ParamsObject = {
     platform: string;
     clientType: string;
+    externalUserType: string;
     device: string;
     /**
      * API ключ приложения
@@ -236,6 +241,10 @@ export declare type ParamsObject = {
      * Включить постраничный вывод участников. Работает только если включено videoTracksCount (слоты)
      */
     useParticipantListChunk: boolean;
+    /**
+     * Включить комнаты
+     */
+    useRooms: boolean;
     /**
      * Индекс участника для первого chunk'а который придет при установки соединения с сервером
      */
@@ -281,6 +290,11 @@ export declare type ParamsObject = {
      * @hidden
      */
     preserveAudioTracks: boolean;
+    /**
+     * Использовать congestion control для шаринга
+     * @hidden
+     */
+    screenShareCongestionControl: boolean;
     /**
      * Получен локальный стрим с камеры/микрофона
      */
@@ -328,7 +342,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;
     /**
      * Начальный список участников для постраничного звонка
      */
@@ -522,6 +536,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;
@@ -538,6 +585,8 @@ export default abstract class Params {
     static set platform(value: string);
     static get clientType(): string;
     static set clientType(value: string);
+    static get externalUserType(): string;
+    static set externalUserType(value: string);
     static get device(): string;
     static get apiKey(): string;
     static get apiEnv(): string;
@@ -612,6 +661,7 @@ export default abstract class Params {
     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;
@@ -621,4 +671,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/WebRTCUtils.d.ts

@@ -66,7 +66,7 @@ declare namespace WebRTCUtils {
     /**
      * Запрашивает трансляцию экрана пользователя
      */
-    function getScreenMedia(): Promise<MediaStream>;
+    function getScreenMedia(withAudioShare: boolean): Promise<MediaStream>;
     /**
      * Запрашивает камеру пользователя
      *
@@ -146,5 +146,6 @@ declare namespace WebRTCUtils {
      * Возвращает подверсию браузера (если она есть)
      */
     function browserSubVersion(): string;
+    function isAudioShareSupported(): boolean;
 }
 export default WebRTCUtils;

package/types/Asr.d.ts

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

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/ConversationParams.d.ts

@@ -10,5 +10,6 @@ declare type ConversationParams = {
     isp_as_org?: string;
     loc_cc?: string;
     loc_reg?: string;
+    external_user_type: string;
 };
 export default ConversationParams;

package/types/Feedback.d.ts

@@ -0,0 +1,22 @@
+import { CompositeUserId } from './Participant';
+import { ExternalParticipantId } from './ExternalId';
+interface IFeedbackItem {
+    participantId: CompositeUserId;
+    /** event timestamps for this participant, chronologically */
+    times: number[];
+}
+export interface IFeedbackItemExternal extends Omit<IFeedbackItem, 'participantId'> {
+    participantId: ExternalParticipantId;
+}
+export interface IFeedback {
+    /** feedback ID; key values should be negotiated by clients themselves, like in ParticipantState, and have just the same restrictions; on backend the values of these keys are not bound in any way to those in ParticipantState */
+    key: string;
+    /** total amount of reactions of this type from the start of this call */
+    totalCount: number;
+    /** list of items containing initiator & all related data, if any */
+    items: IFeedbackItem[];
+}
+export interface IFeedbackExternal extends Omit<IFeedback, 'items'> {
+    items: IFeedbackItemExternal[];
+}
+export {};

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 {
@@ -13,13 +14,28 @@ export interface IAddMovieParams {
         thumbnails?: IMoviePreview[];
     };
 }
-export declare type ISharedMovieStateResponse = [number, number, boolean, number, number];
+export declare type ISharedMovieStateResponse = [
+    number,
+    number,
+    boolean,
+    number,
+    boolean,
+    number
+];
 export interface ISharedMovieState {
     participantId: CompositeUserId;
     gain?: number;
     pause?: boolean;
     offset?: number;
-    duration?: number;
+    mute?: boolean;
+    liveStatus?: LiveStatus;
+}
+export interface IUpdateMovieData {
+    movieId: string;
+    gain?: number;
+    pause?: boolean;
+    offset?: number;
+    mute?: boolean;
 }
 export interface ISharedMovieInfo {
     movieId: OkUserId;

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;
 }

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,71 @@
+import { ExternalParticipantId, ExternalParticipantListChunk } from './ExternalId';
+import { Participant, 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;
+}
+/**
+ * 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;
+    /**
+     * 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?: Participant[];
+    /**
+     * 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[];
+}

package/types/SignalingMessage.d.ts

@@ -5,8 +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';
@@ -74,10 +78,23 @@ declare namespace SignalingMessage {
         multichatId: string | null;
         tamtamMultichatId: string | null;
         recordInfo: RecordInfo | 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;
+    }
     interface Notification extends SignalingMessage {
         type?: string;
         notification?: string;
@@ -188,6 +205,7 @@ declare namespace SignalingMessage {
     }
     export interface FeatureSetChanged extends Notification {
         features: ConversationFeature[];
+        featuresPerRole?: IFeaturesPerRole | null;
     }
     export interface MultipartyChatCreated extends Notification {
         chatId: string;
@@ -277,10 +295,17 @@ declare namespace SignalingMessage {
         mediaModifiers: MediaModifiers;
         participants?: ParticipantListChunk;
         chatRoom?: ChatRoom;
+        rooms?: {
+            rooms: Room[];
+            roomId?: number;
+        };
     }
     export interface JoinLinkChanged extends Notification {
         joinLink: string;
     }
+    export interface Feedback extends Notification {
+        feedback: IFeedback[];
+    }
     export interface SharedMovieState extends Notification {
         data: ISharedMovieState[];
     }
@@ -289,6 +314,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/types/WaitingHall.d.ts

@@ -1,6 +1,7 @@
 import { ExternalId } from './ExternalId';
 import { CompositeUserId } from './Participant';
 import SignalingMessage from './SignalingMessage';
+import { IFeedback } from './Feedback';
 export declare type WaitingParticipantId = {
     addedTs: number;
     id: CompositeUserId;
@@ -9,18 +10,11 @@ export declare type WaitingParticipant = {
     id: WaitingParticipantId;
     externalId?: SignalingMessage.ExternalId;
 };
-export declare type Feedback = {
-    key: string;
-    totalCount: number;
-    currentCount: number;
-    timeout: number;
-    participantIds: CompositeUserId[];
-};
 export declare type ChatRoom = {
     totalCount: number;
     firstParticipants?: WaitingParticipant[];
     handCount?: number;
-    feedback?: Feedback[];
+    feedback?: IFeedback[];
 };
 /**
  * Ответ на запрос `getWaitingHall`

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;