@vkontakte/calls-sdk 2.8.4-dev.e953776.0 → 2.8.4-dev.f08cd2d.0

package/static/Params.d.ts

@@ -19,8 +19,10 @@ import MediaSettings from '../types/MediaSettings';
 import { IOnRemoteMovieData, ISharedMovieInfo, ISharedMovieState, ISharedMovieStoppedInfo } from '../types/MovieShare';
 import MuteStates from '../types/MuteStates';
 import { ParticipantStateMapped } from '../types/Participant';
+import { MediaType } from '../types/ParticipantStreamDescription';
 import { IRoomId, Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from '../types/Room';
 import { IApiEnv } from '../types/Params';
+import { VmojiError } from '../types/Vmoji';
 import { DebugMessageType } from './Debug';
 import { ParticipantStatus } from './External';
 import { JSONObject } from './Json';
@@ -32,6 +34,8 @@ export type ParamsObject = {
     /** @hidden */
     platform: string;
     /** @hidden */
+    clientStatsPlatform: string;
+    /** @hidden */
     clientType: string;
     /** @hidden */
     externalUserType: string;
@@ -222,6 +226,17 @@ export type ParamsObject = {
     perfStatReportEnabled: boolean;
     /** @hidden */
     callStatReportEnabled: boolean;
+    /**
+     * Включает использование обновленного API и формата
+     * логирования статистики качества аудио/видео.
+     * Требует указания clientStatsPlatform.
+     *
+     * _По умолчанию: `false`_
+     * @hidden
+     */
+    useCallStatReportNewAPI: boolean;
+    /** @hidden */
+    networkStatReportEnabled: boolean;
     /**
      * Включает извлечение `remote-inbound-rtp` для использования в статистике.
      * Используется для вычисления `video_loss` и `audio_loss`.
@@ -313,6 +328,13 @@ export type ParamsObject = {
     movieShare: boolean;
     /** @hidden */
     breakVideoPayloadTypes: boolean;
+    /**
+     * Включить звонки контактам
+     *
+     * _По умолчанию: `false`_
+     * @hidden
+     */
+    useCallsToContacts: boolean;
     /**
      * Включить постраничный вывод участников. Работает только если включено videoTracksCount (слоты)
      *
@@ -325,6 +347,12 @@ export type ParamsObject = {
      * _По умолчанию: `false`_
      */
     useRooms: boolean;
+    /**
+     * Включить чат румы
+     *
+     * _По умолчанию: `false`_
+     */
+    useChatRooms: boolean;
     /**
      * Индекс участника для первого chunk'а который придет при установке соединения с сервером
      *
@@ -445,6 +473,10 @@ export type ParamsObject = {
      * Локальный стрим вимоджи добавлен/удалён
      */
     onVmojiStream?: (stream: MediaStream | null, mediaSettings: MediaSettings) => void;
+    /**
+     * Произошла ошибка вимоджи
+     */
+    onVmojiError?: (error: VmojiError) => void;
     /**
      * Изменился статус локального соединения
      */
@@ -457,11 +489,7 @@ export type ParamsObject = {
     /**
      * Cтрим собеседника приостановлен/возобновлен.
      */
-    onRemoteStreamSuspended?: (userId: ExternalParticipantId, suspended: boolean) => void;
-    /**
-     * Стрим с экрана собеседника приостановлен/возобновлен.
-     */
-    onRemoteScreenStreamSuspended?: (userId: ExternalParticipantId, suspended: boolean) => void;
+    onRemoteStreamSuspended?: (userId: ExternalParticipantId, mediaType: MediaType, suspended: boolean) => void;
     /**
      * Получен стрим с экрана собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
@@ -636,7 +664,7 @@ export type ParamsObject = {
     /**
      * Начата трансляция/запись звонка
      */
-    onRecordStarted?: (initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string, roomId?: number | null) => void;
+    onRecordStarted?: (initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string, externalAccessKey?: string, roomId?: number | null) => void;
     /**
      * Закончена трансляция/запись звонка
      */
@@ -760,7 +788,19 @@ export type ParamsObject = {
      */
     onAsrSet?: (data: IAsrData | null, roomId: number | null) => void;
     /**
-     * Одобрено повышение пользователя в зеле ожидания/зале в режиме Audience
+     * Админ начал/остановил совместное использование стороннего web-приложения
+     * @param userId id участника-админа
+     * @param sharedUrl url страницы
+     */
+    onRemoteSharedUrl?: (userId: ExternalParticipantId, sharedUrl: string | undefined, roomId: IRoomId) => void;
+    /**
+     * Изменился id участника (деанонимизация)
+     * @param prevId
+     * @param newId
+     */
+    onParticipantIdChanged?: (prevId: ExternalParticipantId, newId: ExternalParticipantId) => void;
+    /**
+     * Одобрено повышение пользователя в зале ожидания/зале в режиме Audience
      *
      * @param adminParticipantId админ, одобривший повышение
      */
@@ -771,6 +811,10 @@ export type ParamsObject = {
      * @param demoted участник разжалован
      */
     onPromoted?: (demoted: boolean) => void;
+    /**
+     * Собеседник подключился к сигналлингу
+     */
+    onPeerRegistered?: () => void;
     /**
      * Поддержка переключения качества видео в зависимости от сети
      * Только для режима p2p
@@ -792,6 +836,8 @@ export default abstract class Params {
     static get protocolVersion(): 5 | 6;
     static get platform(): string;
     static set platform(value: string);
+    static get clientStatsPlatform(): string;
+    static set clientStatsPlatform(value: string);
     static get clientType(): string;
     static set clientType(value: string);
     static get externalUserType(): string;
@@ -856,6 +902,8 @@ export default abstract class Params {
     static get networkStatisticsInterval(): number;
     static get perfStatReportEnabled(): boolean;
     static get callStatReportEnabled(): boolean;
+    static get useCallStatReportNewAPI(): boolean;
+    static get networkStatReportEnabled(): boolean;
     static get enableLogPerfStatReport(): boolean;
     static get includeRemoteRtpsInCallStat(): boolean;
     static get producerNotificationDataChannel(): boolean;
@@ -875,8 +923,10 @@ export default abstract class Params {
     static get movieShare(): boolean;
     static get videoTracksCount(): number;
     static get breakVideoPayloadTypes(): boolean;
+    static get useCallsToContacts(): boolean;
     static get useParticipantListChunk(): boolean;
     static get useRooms(): boolean;
+    static get useChatRooms(): boolean;
     static get participantListChunkInitIndex(): number;
     static get participantListChunkInitCount(): number | null;
     static get serverAudioRed(): boolean;

package/static/Utils.d.ts

@@ -8,18 +8,20 @@ export declare const DEVICE_IDX_PARAMETER = "d";
 /** @hidden */
 declare namespace Utils {
     function patchLocalSDP(sdp: string, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, h264spsPpsIdrInKeyframe: boolean, isAudioNack?: boolean, preferRed?: boolean): string;
-    function patchRemoteSDP(sdp: string, oldDataChannelDescription: boolean, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, brokenVP9: boolean): string;
+    function patchRemoteSDP(sdp: string, oldDataChannelDescription: boolean, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, brokenVP9Encoder: boolean): string;
     function getPeerIdString(peerId: SignalingMessage.PeerId): string;
     function comparePeerId(peerId1: SignalingMessage.PeerId, peerId2: SignalingMessage.PeerId): boolean;
     function getPeerConnectionHostInfo(pc: RTCPeerConnection): Promise<{
         local: any;
         remote: any;
     }>;
-    function composeUserId(id: CompositeUserId | OkUserId, type: UserType): CompositeUserId;
+    function composeUserId(id: CompositeUserId | OkUserId, type?: UserType): CompositeUserId;
     function composeParticipantId(id: CompositeUserId | OkUserId, type: UserType, deviceIdx?: number): ParticipantId;
     function compose(compositeId: CompositeUserId, deviceIdx?: number): ParticipantId;
     function composeId(participant: SignalingMessage.Participant): ParticipantId;
+    function composeDecorativeId(participant: SignalingMessage.Participant): ParticipantId | undefined;
     function composeMessageId(message: SignalingMessage): ParticipantId;
+    function extractOkId(id: OkUserId | CompositeUserId | ParticipantId): OkUserId;
     function decomposeId(compositeId: CompositeUserId | OkUserId): {
         id: OkUserId;
         type: UserType;

package/static/WebRTCUtils.d.ts

@@ -15,6 +15,10 @@ export declare enum FacingMode {
      */
     ENVIRONMENT = "environment"
 }
+/**
+ * Известные браузеры
+ */
+export type BrowserName = 'IE' | 'Edge' | 'Chrome' | 'Firefox' | 'Yandex' | 'Opera' | 'Sferum';
 declare namespace WebRTCUtils {
     /**
      * Инициализирует устройства. До вызова этого метода бесполезно опрашивать другие публичные методы
@@ -144,7 +148,7 @@ declare namespace WebRTCUtils {
     /**
      * Имя браузера
      */
-    function browserName(): string;
+    function browserName(): BrowserName | string;
     /**
      * Версия браузера
      */

package/types/AudienceMode.d.ts

@@ -3,6 +3,7 @@ import { ExternalId } from './ExternalId';
  * Ответ на запрос `getHandQueue`
  */
 export type AudienceModeHandsResponse = {
+    timestamps: number[];
     participants: ExternalId[];
     totalCount: number;
 };

package/types/Conversation.d.ts

@@ -11,6 +11,7 @@ import MediaModifiers from './MediaModifiers';
 import MediaSettings from './MediaSettings';
 import MuteStates from './MuteStates';
 import { OkUserId, Participant, ParticipantId } from './Participant';
+import { IRoomId, RoomUrlSharingInfo } from './Room';
 import { RecordInfo } from './SignalingMessage';
 export interface IProcessMuteStateParams {
     mediaOptions?: MediaOption[];
@@ -20,7 +21,7 @@ export interface IProcessMuteStateParams {
     admin?: Participant | null;
     stateUpdated?: boolean;
     requestedMedia?: MediaOption[];
-    roomId?: number | null;
+    roomId?: IRoomId;
 }
 /**
  * Данные текущего звонка
@@ -50,9 +51,9 @@ export type ConversationData = {
     concurrent: boolean;
     needRate: boolean;
     /** @hidden */
-    recordsInfoByRoom: Map<number | null, RecordInfo | null>;
+    recordsInfoByRoom: Map<IRoomId, RecordInfo | null>;
     /** @hidden */
-    asrInfoByRoom: Map<number | null, AsrInfo | null>;
+    asrInfoByRoom: Map<IRoomId, AsrInfo | null>;
     chatId: string | null;
     /** @hidden */
     asrInfo: AsrInfo | null;
@@ -65,15 +66,16 @@ export type ConversationData = {
      */
     joinLink?: string;
     /** @hidden */
-    pinnedParticipantIdByRoom: Map<number | null, ParticipantId | null>;
+    pinnedParticipantIdByRoom: Map<IRoomId, ParticipantId | null>;
     mediaModifiers: MediaModifiers;
     options: ConversationOption[];
-    muteStates: Map<number | null, MuteStates>;
+    muteStates: Map<IRoomId, MuteStates>;
     unmuteOptions: MediaOption[];
     networkRating: number;
     waitingHall: boolean;
     observer: boolean;
-    roomId: number | null;
+    roomId: IRoomId;
     audienceMode: boolean;
     restricted: boolean;
+    urlSharingInfoByRoom: Map<IRoomId, RoomUrlSharingInfo>;
 };

package/types/EnableVideoSuspend.d.ts

@@ -0,0 +1,3 @@
+export type EnableVideoSuspend = {
+    enabled: boolean;
+};

package/types/ExternalId.d.ts

@@ -17,6 +17,7 @@ export type ExternalUserId = string;
 export declare namespace ExternalIdUtils {
     function fromIds(ids: ExternalUserId[] | ExternalId[]): ExternalId[];
     function fromId(id: ExternalUserId, type?: ExternalIdType, deviceIdx?: number): ExternalParticipantId;
+    function fromSignalingParticipant(participant: SignalingMessage.Participant, useDecorative?: boolean): ExternalParticipantId | undefined;
     function fromSignaling(signalingId: SignalingMessage.ExternalId, deviceIdx?: number): ExternalParticipantId;
     function toString(externalId: ExternalId): ExternalIdString;
     function fromIdToString(id: ExternalUserId, type?: ExternalIdType, deviceIdx?: number): ExternalIdString;

package/types/MediaSettings.d.ts

@@ -26,15 +26,6 @@ export type MediaSettings = {
      * Включена ли трансляция вимоджи
      */
     isAnimojiEnabled: boolean;
-    /**
-     * @hidden
-     */
-    videoStreams: VideoStreamInfo[];
-};
-export type VideoStreamInfo = {
-    id: string;
-    source: string;
-    externalMovieId?: string;
 };
 export default MediaSettings;
 export declare function compareMediaSettings(ms1: MediaSettings, ms2: MediaSettings): boolean;

package/types/MuteStates.d.ts

@@ -13,9 +13,21 @@ export default MuteStates;
  * Состояние устройств пользователя установленное админом звонка
  */
 export interface IMuteParticipantParams {
+    /**
+     * Внешний ID пользователя (если не указано, сработает на всех)
+     */
     externalId?: ExternalParticipantId | null;
+    /**
+     * Состояние устройств пользователя
+     */
     muteStates: MuteStates;
+    /**
+     * Попросить пользователя включить устройство
+     */
     requestedMedia?: MediaOption[];
+    /**
+     * ID сессионного зала, либо ничего если в основном зале
+     */
     roomId?: number | null;
 }
 export interface IMuteParticipantInternalParams {

package/types/NetworkStatReport.d.ts

@@ -0,0 +1,4 @@
+export interface NetworkStatReport {
+    timestamp: number;
+    sendBitrate: number;
+}

package/types/Participant.d.ts

@@ -15,6 +15,7 @@ export type CompositeUserId = string;
 /**
  * Уникально идентифицирует участника звонка
  * (одному пользователю могут соответствовать несколько участников, в случае если пользователь зашёл в звонок с нескольких устройств)
+ * Включает композитный id и постфикс с номером устройства, если он не равен 0
  */
 export type ParticipantId = string;
 export type OkUserId = number;
@@ -44,7 +45,13 @@ export interface ParticipantStateMapped {
     };
 }
 export interface Participant {
+    /**
+     * string representation
+     */
     id: ParticipantId;
+    /**
+     * If user has 'decorative external id' it will be set as externalId
+     */
     externalId: ExternalParticipantId;
     mediaSettings: MediaSettings;
     state: ParticipantState;

package/types/ParticipantStreamDescription.d.ts

@@ -7,7 +7,8 @@ export declare enum MediaType {
     SCREEN = "SCREEN",
     STREAM = "STREAM",
     MOVIE = "MOVIE",
-    ANIMOJI = "ANIMOJI"
+    ANIMOJI = "ANIMOJI",
+    SHARED_URL = "SHARED_URL"
 }
 export declare function serializeParticipantStreamDescription(description: ParticipantStreamDescription): StreamDescriptionString;
 export declare function parseParticipantStreamDescription(descriptionString: StreamDescriptionString): ParticipantStreamDescription;

package/types/Room.d.ts

@@ -1,6 +1,6 @@
 import { ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk } from './ExternalId';
 import MuteStates from './MuteStates';
-import { ParticipantListMarkers } from './Participant';
+import { ParticipantId, ParticipantListMarkers } from './Participant';
 /**
  * Комната
  */
@@ -92,3 +92,7 @@ export interface RoomParticipantUpdate {
  * ID комнаты
  */
 export type IRoomId = number | null;
+export interface RoomUrlSharingInfo {
+    sharedUrl: string;
+    initiatorId: ParticipantId;
+}

package/types/SignalingCommand.d.ts

@@ -1,12 +1,12 @@
 import SignalingCommandType from '../enums/SignalingCommandType';
-import SignalingMessage from './SignalingMessage';
-type SignalingCommand = {
+import { SignalingResponse, SignalingSuccessResponse } from './SignalingMessage';
+interface SignalingCommand<T extends SignalingResponse = SignalingSuccessResponse> {
     sequence: number;
     name: SignalingCommandType;
     params: object;
     responseTimer: number;
     needResponse: boolean;
-    resolve: (message: SignalingMessage) => void;
+    resolve: (message: T) => void;
     reject: (error: Error, force?: boolean) => void;
-};
+}
 export default SignalingCommand;

package/types/SignalingMessage.d.ts

@@ -30,6 +30,7 @@ export type RecordInfo = {
     recordType: 'STREAM' | 'RECORD';
     recordExternalMovieId?: string;
     recordExternalOwnerId?: string;
+    recordExternalAccessKey?: string;
 };
 export interface SignalingResponse extends SignalingMessage {
     response?: SignalingCommandType;
@@ -42,6 +43,15 @@ export interface SignalingSuccessResponse extends SignalingResponse {
     response: SignalingCommandType;
     sequence: number;
 }
+export interface GetRoomsSignalingResponse extends SignalingSuccessResponse {
+    rooms: {
+        rooms: SignalingMessage.Room[];
+        roomId?: number;
+    };
+}
+export interface GetParticipantsSignalingResponse extends SignalingSuccessResponse {
+    participants: SignalingMessage.Participant[];
+}
 declare namespace SignalingMessage {
     export interface ExternalId {
         type: 'UNKNOWN' | 'VK' | 'ANONYM';
@@ -59,11 +69,13 @@ declare namespace SignalingMessage {
         rtpTimestamp: number | null;
         sequenceNumber: number;
         fastScreenShare: boolean;
-        suspend: boolean;
+        suspend?: boolean;
     };
     export interface Participant {
         id: OkUserId;
         idType?: UserType;
+        decorativeUserId?: CompositeUserId;
+        decorativeExternalUserId?: ExternalId;
         deviceIdx?: number;
         externalId?: ExternalId;
         state: ParticipantState;
@@ -91,7 +103,19 @@ declare namespace SignalingMessage {
         countAfter: number;
         markerFound: boolean;
     }
-    interface Conversation {
+    export interface WaitingParticipantId {
+        addedTs: number;
+        id: CompositeUserId;
+    }
+    export interface WaitingParticipant {
+        id: WaitingParticipantId;
+        externalId?: ExternalId;
+    }
+    export interface RoomUrlSharingInfo {
+        sharedUrl: string;
+        initiatorId: CompositeUserId;
+    }
+    export interface Conversation {
         id: string;
         state: string;
         topology: TransportTopology;
@@ -107,21 +131,24 @@ declare namespace SignalingMessage {
         options: ConversationOption[];
         muteStates?: MuteStates;
         asrInfo?: AsrInfo;
+        urlSharingInfo?: RoomUrlSharingInfo;
     }
-    export interface Room extends SignalingMessage {
+    export interface Room {
+        active?: boolean;
+        addParticipantIds?: CompositeUserId[];
+        asrInfo?: AsrInfo;
+        countdownSec?: number;
         id?: number;
+        muteStates?: MuteStates;
         name?: string;
         participantCount?: number;
         participantIds?: CompositeUserId[];
-        addParticipantIds?: CompositeUserId[];
-        removeParticipantIds?: CompositeUserId[];
         participants?: ParticipantListChunk;
-        active?: boolean;
-        countdownSec?: number;
-        timeoutMs?: number;
-        muteStates?: MuteStates;
-        recordInfo?: RecordInfo;
         pinnedParticipantId?: CompositeUserId;
+        recordInfo?: RecordInfo;
+        removeParticipantIds?: CompositeUserId[];
+        timeoutMs?: number;
+        urlSharingInfo?: RoomUrlSharingInfo;
     }
     interface Notification extends SignalingMessage {
         type?: string;
@@ -344,9 +371,14 @@ declare namespace SignalingMessage {
     export interface SharedMovieStoppedInfo extends Notification, ISharedMovieStoppedInfo {
         roomId?: IRoomId;
     }
+    export interface UrlSharingInfo extends Notification {
+        initiatorId: CompositeUserId;
+        sharedUrl?: string;
+        roomId?: IRoomId;
+    }
     export interface RoomsUpdated extends Notification {
         updates: Partial<Record<RoomsEventType, {
-            rooms?: Room;
+            rooms?: Room[];
             roomIds?: number[];
             deactivated?: boolean;
         }>>;
@@ -368,7 +400,10 @@ declare namespace SignalingMessage {
         removedParticipantMarkers?: ParticipantListMarkers[];
     }
     export interface GetRooms extends Notification {
-        rooms: Room[];
+        rooms: {
+            rooms: Room[];
+            roomId?: number;
+        };
     }
     export interface FeaturesPerRoleChanged extends Notification {
         featuresPerRole?: IFeaturesPerRole | null;
@@ -386,6 +421,11 @@ declare namespace SignalingMessage {
     export interface ParticipantSourcesUpdateNotification extends Notification {
         participantUpdateInfos: ParticipantUpdateInfo[];
     }
+    export interface DecorativeParticipantIdChanged extends Notification {
+        participantId: CompositeUserId;
+        decorativeParticipantId?: CompositeUserId;
+        decorativeExternalParticipantId?: ExternalId;
+    }
     export {};
 }
 export default SignalingMessage;

package/types/Statistics.d.ts

@@ -1,5 +1,7 @@
 import { TransportTopology } from '../classes/transport/Transport';
 export type StatTransport = {
+    timestamp: number;
+    availableOutgoingBitrate: number;
     totalRoundTripTime: number;
     currentRoundTripTime: number;
     bytesSent: number;
@@ -28,6 +30,8 @@ export type StatRtp = {
     kind: string;
     bytesReceived: number;
     bytesSent: number;
+    headerBytesReceived: number;
+    headerBytesSent: number;
     jitter: number;
     packetsLost: number;
     packetsReceived: number;

package/types/Streams.d.ts

@@ -6,6 +6,7 @@ export interface IStartStreamData {
     groupId: string | null;
     roomId: number | null;
     streamMovie: boolean;
+    externalAccessKey: string | null;
 }
 export interface IStopStreamData {
     roomId: number | null;

package/types/Vmoji.d.ts

@@ -0,0 +1,5 @@
+import type { AnimojiError } from '@vkontakte/calls-vmoji';
+import { ExternalParticipantId } from './ExternalId';
+export interface VmojiError extends Omit<AnimojiError, 'participantId'> {
+    externalId: ExternalParticipantId;
+}

package/types/WaitingHall.d.ts

@@ -1,18 +1,9 @@
 import { ExternalId } from './ExternalId';
-import { CompositeUserId } from './Participant';
 import SignalingMessage from './SignalingMessage';
 import { IFeedback } from './Feedback';
-export type WaitingParticipantId = {
-    addedTs: number;
-    id: CompositeUserId;
-};
-export type WaitingParticipant = {
-    id: WaitingParticipantId;
-    externalId?: SignalingMessage.ExternalId;
-};
 export type ChatRoom = {
     totalCount: number;
-    firstParticipants?: WaitingParticipant[];
+    firstParticipants?: SignalingMessage.WaitingParticipant[];
     handCount?: number;
     feedback?: IFeedback[];
 };
@@ -24,5 +15,5 @@ export type WaitingHallResponse = {
     pageMarker: string | null;
     totalCount: number;
 };
-export declare function waitingParticipantIdToString(id: WaitingParticipantId): string | null;
-export declare function waitingParticipantIdFromString(id: string): WaitingParticipantId | null;
+export declare function waitingParticipantIdToString(id: SignalingMessage.WaitingParticipantId): string | null;
+export declare function waitingParticipantIdFromString(id: string): SignalingMessage.WaitingParticipantId | null;