@vkontakte/calls-sdk 2.6.2-dev.f69c395.0 → 2.6.3-beta.0

package/static/Params.d.ts

@@ -6,13 +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';
@@ -24,6 +29,7 @@ import { FacingMode } from './WebRTCUtils';
 export declare type ParamsObject = {
     platform: string;
     clientType: string;
+    externalUserType: string;
     device: string;
     /**
      * API ключ приложения
@@ -43,6 +49,11 @@ export declare type ParamsObject = {
      * Домен, чтобы попасть в тестовую группу. Для тестирования экспериментальных улучшений существуют отдельные сервера, чтобы собирать фидбек и уже потом раскатывать на всех юзеров. Если передать сюда специальный ключ, то конверсейшн будет обрабатываться на таком сервере.
      */
     domain: string;
+    /**
+     * Домен, куда будет ходить Ok api за данными
+     * @hidden
+     */
+    externalDomain: string;
     iceServers: IceServer[];
     wssBase: string;
     wssToken: string;
@@ -164,9 +175,6 @@ export declare type ParamsObject = {
     };
     perfStatReportEnabled: boolean;
     callStatReportEnabled: boolean;
-    unifiedPlanBrowsers: {
-        [key: string]: number;
-    };
     /**
      * Отдавать приоритет кодеку H264 для исходящего видео
      *
@@ -201,6 +209,7 @@ export declare type ParamsObject = {
     producerCommandDataChannel: boolean;
     consumerScreenDataChannel: boolean;
     producerScreenDataChannel: boolean;
+    asrDataChannel: boolean;
     /**
      * Размер пакета для отправки трансляции экрана в датаканал в байтах.
      * Максимальный размер пакета 65536 bytes в хроме, но по стандарту лучше максимум 16 Кб.
@@ -228,25 +237,46 @@ 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;
     /**
      * Получать список участников звонка третьим аргументом в `onConversation`
      * @hidden
@@ -270,6 +300,18 @@ export declare type ParamsObject = {
      * @hidden
      */
     preserveAudioTracks: boolean;
+    /**
+     * Использовать congestion control для шаринга
+     * @hidden
+     */
+    screenShareCongestionControl: boolean;
+    /**
+     * Настройки api
+     */
+    api: {
+        /** таймаут для батчинга на получение externalId */
+        userIdsByOkBatchedTimeout: number;
+    };
     /**
      * Получен локальный стрим с камеры/микрофона
      */
@@ -300,11 +342,24 @@ export declare type ParamsObject = {
      * Получен стрим трансляция или мувик от собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
      */
-    onRemoteLive?: (userId: ExternalParticipantId, streamId: string, stream: MediaStream | null) => void;
+    onRemoteLive?: (userId: ExternalParticipantId, data: IOnRemoteMovieData) => void;
+    /**
+     * Получен собственный стрим трансляция или мувик.
+     * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
+     */
+    onLocalLive?: (userId: ExternalParticipantId, data: IOnRemoteMovieData) => void;
+    /**
+     * Получено обновление стрима или лайва от собеседника.
+     */
+    onRemoteLiveUpdate?: (userId: ExternalParticipantId, data: ISharedMovieState) => void;
+    /**
+     * Получено обновление собственного стрима или лайва.
+     */
+    onLocalLiveUpdate?: (userId: ExternalParticipantId, data: ISharedMovieState) => void;
     /**
      * Начат звонок
      */
-    onConversation?: (userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[]) => void;
+    onConversation?: (userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[], rooms?: Rooms) => void;
     /**
      * Начальный список участников для постраничного звонка
      */
@@ -313,6 +368,26 @@ export declare type ParamsObject = {
      * Изменились данные стрима собеседника
      */
     onRemoteMediaSettings?: (userId: ExternalParticipantId, mediaSettings: MediaSettings, markers?: ExternalParticipantListMarkers) => void;
+    /**
+     * Изменились данные стрима собеседника
+     */
+    onLocalMediaSettings?: (userId: ExternalParticipantId, mediaSettings: MediaSettings) => void;
+    /**
+     * Полученны данные по стримам (лайв/мувик) от собеседника
+     */
+    onRemoteSharedMovieInfo?: (userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo) => void;
+    /**
+     * Полученны данные по остановленным стримам (лайв/мувик) от собеседника
+     */
+    onRemoteSharedMovieStoppedInfo?: (userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo) => void;
+    /**
+     * Полученны данные по собственным стримам (лайв/мувик)
+     */
+    onLocalSharedMovieInfo?: (userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo) => void;
+    /**
+     * Полученны данные по собственным остановленным стримам (лайв/мувик)
+     */
+    onLocalSharedMovieStoppedInfo?: (userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo) => void;
     /**
      * Добавили участника
      */
@@ -341,7 +416,7 @@ export declare type ParamsObject = {
     /**
      * Ошибка получения трека с камеры или микрофона
      */
-    onPermissionsError?: (error: FatalError) => void;
+    onPermissionsError?: (error: FatalError, original: Error) => void;
     /**
      * Пользователь отключился от звонка
      */
@@ -357,7 +432,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;
     /**
      * Изменились роли собеседника в звонке
      */
@@ -427,11 +502,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;
     /**
      * Состояние своей сети
      *
@@ -478,6 +553,49 @@ 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 roomId номер сессионного зала
+     */
+    onRoomSwitched?: (roomId: number | null) => void;
+    /**
+     * Установить id сессионного зала на старте звонка
+     * @param roomId номер сессионного зала
+     */
+    onRoomStart?: (roomId: number | null) => void;
+    /**
+     * Получены новые реакции в звонке
+     * @param feedback массив с реакциями
+     */
+    onFeedback?: (feedback: IFeedbackExternal[], roomId: number | null) => void;
+    /**
+     * Включать capability c аудио шарой
+     */
+    audioShareCapabilityEnabled: boolean;
+    /**
+     * Изменился список ролей, которым доступны ConversationFeatures
+     *
+     * @param featuresPerRole Объект вида ключ: ConversationFeature = значение: UserRole[]
+     * (если ключ фичи отсутствует, или в ролях пустой массив, считаем фичу доступной для всех пользователей)
+     */
+    onFeaturesPerRoleChanged?: (featuresPerRole: IFeaturesPerRole) => void;
 };
 export default abstract class Params {
     private static _params;
@@ -494,6 +612,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;
@@ -503,6 +623,7 @@ export default abstract class Params {
     static get anonymToken(): string;
     static set anonymToken(value: string);
     static get domain(): string;
+    static get externalDomain(): string;
     static get iceServers(): IceServer[];
     static set iceServers(value: IceServer[]);
     static get wssBase(): string;
@@ -552,6 +673,7 @@ export default abstract class Params {
     static get producerCommandDataChannel(): boolean;
     static get consumerScreenDataChannel(): boolean;
     static get producerScreenDataChannel(): boolean;
+    static get asrDataChannel(): boolean;
     static get consumerScreenDataChannelPacketSize(): number;
     static get screenShareWebmBuilder(): boolean;
     static get noiseSuppression(): boolean;
@@ -561,18 +683,25 @@ 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;
     static get p2pAudioRed(): boolean;
+    static get h264spsPpsIdrInKeyframe(): boolean;
     static get batchParticipantsOnStart(): boolean;
     static get filterObservers(): boolean;
     static get muteMode(): boolean;
     static get preserveAudioTracks(): boolean;
+    static get audioShareCapabilityEnabled(): boolean;
+    static get screenShareCongestionControl(): boolean;
+    static get api(): {
+        /** таймаут для батчинга на получение externalId */
+        userIdsByOkBatchedTimeout: number;
+    };
 }

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, 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,11 @@
+import { ParticipantId } from './Participant';
+export interface AsrInfo {
+    movieId: number;
+    initiatorId: ParticipantId;
+}
+export interface AsrTranscription {
+    participantId: ParticipantId;
+    text: string;
+    timestamp: number;
+    duration: number;
+}

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

@@ -1,6 +1,7 @@
 import MediaOption from '../enums/MediaOption';
 import { ParticipantStatus } from '../static/External';
 import MediaSettings from './MediaSettings';
+import { ISharedMovieInfo } from './MovieShare';
 import MuteStates from './MuteStates';
 import { ParticipantListMarker, ParticipantListType, ParticipantStateMapped } from './Participant';
 import SignalingMessage from './SignalingMessage';
@@ -94,6 +95,7 @@ export interface ExternalParticipant {
      */
     unmuteOptions: MediaOption[];
     markers?: ExternalParticipantListMarkers;
+    movieShareInfos?: ISharedMovieInfo[];
 }
 export interface ExternalParticipantListChunk {
     participants: ExternalParticipant[];

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,12 +14,16 @@ export declare type MediaSettings = {
      * Включена ли трансляция экрана
      */
     isScreenSharingEnabled: boolean;
+    /**
+     * Включена ли трансляция звука
+     */
+    isAudioSharingEnabled: boolean;
     videoStreams: VideoStreamInfo[];
 };
 export declare type VideoStreamInfo = {
     id: string;
     source: string;
-    vkMovieId?: string;
+    externalMovieId?: string;
 };
 export default MediaSettings;
 export declare function compareMediaSettings(ms1: MediaSettings, ms2: MediaSettings): boolean;