@vkontakte/calls-sdk 2.6.2-beta.25 → 2.6.2-beta.27

package/classes/Conversation.d.ts

@@ -13,6 +13,7 @@ import UserRole from '../enums/UserRole';
 import UserType from '../enums/UserType';
 import { JSONObject } from '../static/Json';
 import { IFeaturesPerRole } from '../types/ConversationFeature';
+import { AsrInfo } from '../types/Asr';
 import { ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalUserId } from '../types/ExternalId';
 import MediaModifiers from '../types/MediaModifiers';
 import { IVideoDimentions } from '../types/MediaSettings';
@@ -51,6 +52,7 @@ export declare type ConversationData = {
     needRate: boolean;
     recordInfo: RecordInfo | null;
     chatId: string | null;
+    asrInfo: AsrInfo | null;
     /**
      * Роли пользователя
      */
@@ -217,6 +219,7 @@ export default class Conversation extends EventEmitter {
     private _onChatRoomUpdated;
     private _onSharedMovieUpdate;
     private _onSharedMovieInfoStarted;
+    private _processSharedMovieInfos;
     private _processSharedMovieInfo;
     private _processConnectionSharedMovieInfo;
     private _onSharedMovieInfoStopped;
@@ -227,6 +230,8 @@ export default class Conversation extends EventEmitter {
     private _isCallAdmin;
     private _checkAdminRole;
     grantRoles(participantId: CompositeUserId, roles: UserRole[], revoke: boolean): Promise<void>;
+    startAsr(): Promise<void>;
+    stopAsr(): Promise<void>;
     muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia?: MediaOption[]): Promise<void>;
     enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<void>;
     pinParticipant(participantId: ParticipantId, unpin: boolean): Promise<void>;
@@ -251,6 +256,10 @@ export default class Conversation extends EventEmitter {
     }>;
     updateMovie(params: IUpdateMovieData): Promise<void>;
     removeMovie(movieId: string): Promise<void>;
+    updateRooms(rooms: SignalingMessage.Room[], assignRandomly: boolean): Promise<void>;
+    activateRooms(roomIds: number[], deactivate: boolean): Promise<void>;
+    switchRoom(toRoomId?: number, participantId?: ParticipantId): Promise<void>;
+    removeRooms(roomIds: number[]): Promise<void>;
     startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null): Promise<SignalingMessage>;
     stopStream(): Promise<SignalingMessage>;
     recordSetRole(participantId: ParticipantId, role: RecordRole | null): Promise<void>;
@@ -291,6 +300,7 @@ export default class Conversation extends EventEmitter {
     private _onChatMessage;
     private _onCustomData;
     private _onRecordInfo;
+    private _onAsrInfo;
     private _onRolesChanged;
     /**
      * Клиент должен немедленно выключить микрофон и/или камеру
@@ -321,6 +331,10 @@ export default class Conversation extends EventEmitter {
     private _updateDisplayLayoutFromCache;
     private _setParticipantsStatus;
     private _onJoinLinkChanged;
+    private _onRoomsUpdated;
+    private _onRoomUpdated;
+    private _convertRoomToExternal;
+    private _onRoomParticipantsUpdated;
     /** получили из сингналинга сообщение о реакции пользователей */
     private _onFeedback;
     private _isMe;

package/classes/codec/IEncoder.d.ts

@@ -4,6 +4,7 @@ export default interface IEncoder {
     requestFrame(keyFrame: boolean): void;
     isVP9(): boolean;
     destroy(): void;
+    setBitrate(bitrate: number): void;
 }
 export interface FrameMessage {
     type: MessageType;
@@ -12,4 +13,6 @@ export interface FrameMessage {
     duration?: number;
     data?: ArrayBuffer;
     error?: string;
+    width?: number;
+    height?: number;
 }

package/classes/codec/LibVPxEncoder.d.ts

@@ -4,6 +4,8 @@ import WorkerBase from './WorkerBase';
 export default class LibVPxEncoder extends WorkerBase implements IEncoder {
     private readonly _sourceTrack;
     private readonly _onFrame;
+    private readonly _useCongestionControl;
+    private readonly _maxBitrate;
     private readonly _useImageCapture;
     private _video;
     private _imageCapture;
@@ -13,7 +15,7 @@ export default class LibVPxEncoder extends WorkerBase implements IEncoder {
     private _track;
     private _frameReadTimeout;
     private _lastFrame;
-    constructor(sourceTrack: MediaStreamTrack, onFrame: OnFrameCallback);
+    constructor(sourceTrack: MediaStreamTrack, onFrame: OnFrameCallback, useCongestionControl: boolean, maxBitrate: number);
     private _createDom;
     private _removeDom;
     private _createStream;
@@ -27,6 +29,7 @@ export default class LibVPxEncoder extends WorkerBase implements IEncoder {
     private _requestFrameVideo;
     private _requestFrameBitmap;
     requestFrame(keyFrame?: boolean): void;
+    setBitrate(bitrate: number): void;
     isVP9(): boolean;
     destroy(): void;
     static isBrowserSupported(): boolean;

package/classes/codec/Types.d.ts

@@ -6,9 +6,14 @@ export declare const enum MessageType {
     INIT = "init",
     READY = "ready",
     FRAME = "frame",
+    SET_BITRATE = "set_bitrate",
     ERROR = "error",
     DEBUG = "debug",
     LOG_ERROR = "log_error"
 }
-export declare type EncodedVideoFrame = Pick<EncodedVideoChunk, 'type' | 'timestamp' | 'duration' | 'byteLength' | 'data'>;
+export declare type EncodedVideoFrame = Pick<EncodedVideoChunk, 'type' | 'timestamp' | 'duration' | 'byteLength' | 'data'> & {
+    width: number;
+    height: number;
+};
 export declare type OnFrameCallback = (chunk: EncodedVideoFrame | null, error?: string) => void;
+export declare type OnCongestionCallback = (bitrate: number) => void;

package/classes/codec/WebCodecsEncoder.d.ts

@@ -5,9 +5,12 @@ export default class WebCodecsEncoder extends WorkerBase implements IEncoder {
     private readonly _sourceTrack;
     private readonly _trackProcessor;
     private readonly _onFrame;
-    constructor(sourceTrack: MediaStreamTrack, onFrame: OnFrameCallback);
+    private readonly _useCongestionControl;
+    private readonly _maxBitrate;
+    constructor(sourceTrack: MediaStreamTrack, onFrame: OnFrameCallback, useCongestionControl: boolean, maxBitrate: number);
     init(): Promise<void>;
     requestFrame(keyFrame?: boolean): void;
+    setBitrate(bitrate: number): void;
     isVP9(): boolean;
     destroy(): void;
     static isBrowserSupported(): boolean;

package/classes/screenshare/ScreenCaptureSender.d.ts

@@ -4,6 +4,10 @@ export default class ScreenCaptureSender {
     private _destroyed;
     private _needKeyframe;
     private readonly DATA_SIZE;
+    private _congestionControl;
+    private _frameNum;
+    private _width;
+    private _height;
     constructor(track: MediaStreamTrack, datachannel: RTCDataChannel);
     private _requestFrame;
     private _wrapHeader;
@@ -12,4 +16,7 @@ export default class ScreenCaptureSender {
     private _sendChunk;
     destroy(): void;
     static isBrowserSupported(): boolean;
+    private _onCongestionCallback;
+    private _onResize;
+    private _calcMinMaxBitrate;
 }

package/classes/screenshare/ScreenCongestionControl.d.ts

@@ -0,0 +1,16 @@
+import { OnCongestionCallback } from '../codec/Types';
+export default class ScreenCongestionControl {
+    private _bitrateCalculator;
+    private _onCongestion;
+    private _minBitrate;
+    private _maxBitrate;
+    private _targetBitrate;
+    private _lastDown;
+    private _lastUp;
+    private _lastSwitch;
+    private _framesDelayed;
+    private _upPenalty;
+    constructor(onCongestion: OnCongestionCallback, minBitrate: number, maxBitrate: number);
+    checkFrame(frameNum: number, frameElapsed: number, frameSize: number): void;
+    reconfigure(minBitrate: number, maxBitrate: number): void;
+}

package/default/Signaling.d.ts

@@ -101,6 +101,10 @@ export default class Signaling extends BaseSignaling {
     addMovie(data: IAddMovieParams): Promise<SignalingMessage>;
     updateMovie(data: IUpdateMovieData): Promise<SignalingMessage>;
     removeMovie(data: any): Promise<SignalingMessage>;
+    updateRooms(rooms: SignalingMessage.Room[], assignRandomly: boolean): Promise<SignalingMessage>;
+    activateRooms(roomIds: number[], deactivate: boolean): Promise<SignalingMessage>;
+    switchRoom(toRoomId?: number, participantId?: ParticipantId): Promise<SignalingMessage>;
+    removeRooms(roomIds: number[]): Promise<SignalingMessage>;
     startStream(data: any): Promise<SignalingMessage>;
     stopStream(): Promise<SignalingMessage>;
     recordSetRole(participantId: ParticipantId, role: RecordRole | null): Promise<SignalingMessage>;
@@ -135,6 +139,8 @@ export default class Signaling extends BaseSignaling {
     readyToSend(): void;
     getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
+    startAsr(): Promise<SignalingMessage>;
+    stopAsr(): Promise<SignalingMessage>;
     protected _connect(connectionType: SignalingConnectionType): void;
     protected _disconnect(): void;
     private _onOpen;

package/enums/RoomsEventType.d.ts

@@ -0,0 +1,6 @@
+declare enum RoomsEventType {
+    UPDATE = "UPDATE",
+    REMOVE = "REMOVE",
+    ACTIVATE = "ACTIVATE"
+}
+export default RoomsEventType;

package/enums/SignalingCommandType.d.ts

@@ -36,6 +36,14 @@ declare enum SignalingCommandType {
     ADD_MOVIE = "add-movie",
     UPDATE_MOVIE = "update-movie",
     REMOVE_MOVIE = "remove-movie",
-    FEEDBACK = "feedback"
+    GET_ROOMS = "get_rooms",
+    GET_ROOM = "get_room",
+    UPDATE_ROOMS = "update-rooms",
+    ACTIVATE_ROOMS = "activate-rooms",
+    REMOVE_ROOMS = "remove-rooms",
+    SWITCH_ROOM = "switch-room",
+    FEEDBACK = "feedback",
+    ASR_START = "asr-start",
+    ASR_STOP = "asr-stop"
 }
 export default SignalingCommandType;

package/enums/SignalingNotification.d.ts

@@ -41,6 +41,11 @@ declare enum SignalingNotification {
     MOVIE_SHARE_INFO = "movie-share-info",
     MOVIE_SHARE_STARTED = "movie-share-started",
     MOVIE_SHARE_STOPPED = "movie-share-stopped",
-    FEATURES_PER_ROLE_CHANGED = "features-per-role-changed"
+    ROOM_UPDATED = "room-updated",
+    ROOMS_UPDATED = "rooms-updated",
+    ROOM_PARTICIPANTS_UPDATED = "room-participants-updated",
+    FEATURES_PER_ROLE_CHANGED = "features-per-role-changed",
+    ASR_STARTED = "asr-started",
+    ASR_STOPPED = "asr-stopped"
 }
 export default SignalingNotification;

package/package.json

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

package/static/External.d.ts

@@ -6,6 +6,7 @@ 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';
@@ -15,6 +16,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, RoomsUpdate } from '../types/Room';
 import { DebugMessageType } from './Debug';
 import { JSONObject } from './Json';
 /**
@@ -115,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?: Room[]): void;
     /**
      * Постраничные данные про участников при начале звонка
      * @param chunk
@@ -414,6 +417,15 @@ 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): void;
+    /**
+     */
+    function onRoomParticipantsUpdated(update: RoomParticipantUpdate): void;
     /**
      * Получена новая реакция
      */
@@ -424,5 +436,15 @@ declare namespace External {
      * @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,6 +6,7 @@ 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';
@@ -16,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, RoomsUpdate } from '../types/Room';
 import AuthData from './AuthData';
 import { DebugMessageType } from './Debug';
 import { ParticipantStatus } from './External';
@@ -239,6 +241,10 @@ export declare type ParamsObject = {
      * Включить постраничный вывод участников. Работает только если включено videoTracksCount (слоты)
      */
     useParticipantListChunk: boolean;
+    /**
+     * Включить комнаты
+     */
+    useRooms: boolean;
     /**
      * Индекс участника для первого chunk'а который придет при установки соединения с сервером
      */
@@ -284,6 +290,11 @@ export declare type ParamsObject = {
      * @hidden
      */
     preserveAudioTracks: boolean;
+    /**
+     * Использовать congestion control для шаринга
+     * @hidden
+     */
+    screenShareCongestionControl: boolean;
     /**
      * Получен локальный стрим с камеры/микрофона
      */
@@ -331,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?: Room[]) => void;
     /**
      * Начальный список участников для постраничного звонка
      */
@@ -525,6 +536,23 @@ 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) => void;
+    /**
+     * Получение обновление списка участников в комнате
+     * @param update обновление списка участников
+     */
+    onRoomParticipantsUpdated?: (update: RoomParticipantUpdate) => void;
     /**
      * Получены новые реакции в звонке
      * @param feedback массив с реакциями
@@ -633,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;
@@ -643,4 +672,5 @@ export default abstract class Params {
     static get muteMode(): boolean;
     static get preserveAudioTracks(): boolean;
     static get audioShareCapabilityEnabled(): boolean;
+    static get screenShareCongestionControl(): boolean;
 }

package/types/Asr.d.ts

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

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

@@ -0,0 +1,60 @@
+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;
+}
+export interface RoomsUpdate {
+    rooms?: Room[];
+    roomIds?: number[];
+}
+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,10 +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';
@@ -81,6 +83,16 @@ declare namespace SignalingMessage {
         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;
+    }
     interface Notification extends SignalingMessage {
         type?: string;
         notification?: string;
@@ -281,6 +293,10 @@ declare namespace SignalingMessage {
         mediaModifiers: MediaModifiers;
         participants?: ParticipantListChunk;
         chatRoom?: ChatRoom;
+        rooms?: {
+            rooms: Room[];
+            roomId?: number;
+        };
     }
     export interface JoinLinkChanged extends Notification {
         joinLink: string;
@@ -296,9 +312,34 @@ declare namespace SignalingMessage {
     }
     export interface SharedMovieStoppedInfo extends Notification, ISharedMovieStoppedInfo {
     }
+    export interface RoomsUpdated extends Notification {
+        updates: Partial<Record<RoomsEventType, {
+            rooms?: Room;
+            roomIds?: number[];
+        }>>;
+    }
+    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/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;