@vkontakte/calls-sdk 2.6.2-dev.067dc66.0 → 2.6.2-dev.083196f.0

package/static/External.d.ts

@@ -6,12 +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';
 /**
@@ -72,10 +77,31 @@ declare namespace External {
      * Если сервер закончил стримить собеседника, вместо стрима будет передан null
      *
      * @param userId
-     * @param streamName
-     * @param stream
+     * @param data
+     */
+    function onRemoteLive(userId: ExternalParticipantId, data: IOnRemoteMovieData): void;
+    /**
+     * Получен собственный стрим лайв.
+     * Если сервер закончил стримить собеседника, вместо стрима будет передан null
+     *
+     * @param userId
+     * @param data
      */
-    function onRemoteLive(userId: ExternalParticipantId, streamName: string, stream: MediaStream | null): void;
+    function onLocalLive(userId: ExternalParticipantId, data: IOnRemoteMovieData): void;
+    /**
+     * Получено обновление стрима или лайва от собеседника.
+     *
+     * @param userId
+     * @param data
+     */
+    function onRemoteLiveUpdate(userId: ExternalParticipantId, data: ISharedMovieState): void;
+    /**
+     * Получено обновление собственного стрима или лайва.
+     *
+     * @param userId
+     * @param data
+     */
+    function onLocalLiveUpdate(userId: ExternalParticipantId, data: ISharedMovieState): void;
     /**
      * Получен стрим с экрана собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
@@ -91,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
@@ -106,6 +133,41 @@ declare namespace External {
      * @param markers
      */
     function onRemoteMediaSettings(userId: ExternalParticipantId, mediaSettings: MediaSettings, markers?: ExternalParticipantListMarkers): void;
+    /**
+     * Изменились данные собственного стрима
+     *
+     * @param userId
+     * @param mediaSettings
+     */
+    function onLocalMediaSettings(userId: ExternalParticipantId, mediaSettings: MediaSettings): void;
+    /**
+     * Полученны данные по стримам (лайв/мувик) от собеседника
+     *
+     * @param userId
+     * @param sharedMovieInfo
+     */
+    function onRemoteSharedMovieInfo(userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo): void;
+    /**
+     * Полученны данные по остановленным стримам (лайв/мувик) от собеседника
+     *
+     * @param userId
+     * @param sharedMovieStoppedInfo
+     */
+    function onRemoteSharedMovieStoppedInfo(userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo): void;
+    /**
+     * Полученны данные по собственным стримам (лайв/мувик)
+     *
+     * @param userId
+     * @param sharedMovieInfo
+     */
+    function onLocalSharedMovieInfo(userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo): void;
+    /**
+     * Полученны данные по собственным остановленным стримам (лайв/мувик)
+     *
+     * @param userId
+     * @param sharedMovieStoppedInfo
+     */
+    function onLocalSharedMovieStoppedInfo(userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo): void;
     /**
      * Добавили участника
      *
@@ -355,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,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, 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 ключ приложения
@@ -235,6 +241,10 @@ export declare type ParamsObject = {
      * Включить постраничный вывод участников. Работает только если включено videoTracksCount (слоты)
      */
     useParticipantListChunk: boolean;
+    /**
+     * Включить комнаты
+     */
+    useRooms: boolean;
     /**
      * Индекс участника для первого chunk'а который придет при установки соединения с сервером
      */
@@ -252,6 +262,11 @@ export declare type ParamsObject = {
      * Включать RED-extension (redundancy) для p2p звонков
      */
     p2pAudioRed: boolean;
+    /**
+     * Добавлять флаг spsPpsIdrInKeyframe для h264 кодека. В результате ключевые фреймы без sps и pps
+     * не используются как ключевые. Решает проблему с артефактами на видео в случае потерь пакетов.
+     */
+    h264spsPpsIdrInKeyframe: boolean;
     /**
      * Получать список участников звонка третьим аргументом в `onConversation`
      * @hidden
@@ -275,6 +290,11 @@ export declare type ParamsObject = {
      * @hidden
      */
     preserveAudioTracks: boolean;
+    /**
+     * Использовать congestion control для шаринга
+     * @hidden
+     */
+    screenShareCongestionControl: boolean;
     /**
      * Получен локальный стрим с камеры/микрофона
      */
@@ -305,11 +325,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?: Room[]) => void;
     /**
      * Начальный список участников для постраничного звонка
      */
@@ -318,6 +351,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;
     /**
      * Добавили участника
      */
@@ -483,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;
@@ -499,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;
@@ -573,12 +661,16 @@ 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;
     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;
 }

package/static/Utils.d.ts

@@ -6,7 +6,7 @@ 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 patchSDP(sdp: string, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, h264spsPpsIdrInKeyframe: boolean, isAudioNack?: boolean, preferRed?: boolean): 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

@@ -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/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;

package/types/MovieShare.d.ts

@@ -0,0 +1,58 @@
+import LiveStatus from '../enums/LiveStatus';
+import { OkUserId, CompositeUserId } from './Participant';
+import { MediaType } from './ParticipantStreamDescription';
+export interface IMoviePreview {
+    url: string;
+    width: number;
+    height: number;
+}
+export interface IAddMovieParams {
+    movieId: string;
+    gain?: number;
+    metadata?: {
+        title?: string;
+        thumbnails?: IMoviePreview[];
+    };
+}
+export declare type ISharedMovieStateResponse = [
+    number,
+    number,
+    boolean,
+    number,
+    boolean,
+    number
+];
+export interface ISharedMovieState {
+    participantId: CompositeUserId;
+    gain?: number;
+    pause?: boolean;
+    offset?: number;
+    mute?: boolean;
+    liveStatus?: LiveStatus;
+}
+export interface IUpdateMovieData {
+    movieId: string;
+    gain?: number;
+    pause?: boolean;
+    offset?: number;
+    mute?: boolean;
+}
+export interface ISharedMovieInfo {
+    movieId: OkUserId;
+    initiatorId: CompositeUserId;
+    title: string;
+    source: MediaType;
+    externalMovieId: string;
+    duration: number;
+    thumbnails: IMoviePreview[];
+}
+export interface ISharedMovieStoppedInfo {
+    movieId: OkUserId;
+    initiatorId: CompositeUserId;
+    source: MediaType;
+}
+export interface IOnRemoteMovieData {
+    streamName: string;
+    stream: MediaStream | null;
+    mediaType: MediaType;
+}

package/types/Participant.d.ts

@@ -4,6 +4,7 @@ import UserRole from '../enums/UserRole';
 import { ParticipantStatus } from '../static/External';
 import MediaSettings from '../types/MediaSettings';
 import { ExternalId, ExternalParticipantId, ExternalParticipantListMarkers } from './ExternalId';
+import { ISharedMovieInfo } from './MovieShare';
 import MuteStates from './MuteStates';
 import ParticipantLayout from './ParticipantLayout';
 /**
@@ -55,6 +56,7 @@ export interface Participant {
     unmuteOptions: MediaOption[];
     observedIds: CompositeUserId[];
     markers?: ExternalParticipantListMarkers;
+    movieShareInfos?: ISharedMovieInfo[];
 }
 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;
 }

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