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

package/default/Signaling.d.ts

@@ -1,7 +1,9 @@
 import BaseSignaling, { AddParticipantParams } from '../abstract/BaseSignaling';
 import { ParticipantIdRegistry } from '../classes/ParticipantIdRegistry';
+import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 import { PerfStatReport } from '../classes/transport/PerfStatReporter';
 import { TransportTopology } from '../classes/transport/Transport';
+import ConversationFeature from '../enums/ConversationFeature';
 import ConversationOption from '../enums/ConversationOption';
 import MediaOption from '../enums/MediaOption';
 import RecordRole from '../enums/RecordRole';
@@ -11,11 +13,13 @@ import UserRole from '../enums/UserRole';
 import { JSONObject } from '../static/Json';
 import MediaModifiers from '../types/MediaModifiers';
 import MediaSettings from '../types/MediaSettings';
+import { IAddMovieParams, IUpdateMovieData } from '../types/MovieShare';
 import MuteStates from '../types/MuteStates';
 import { CompositeUserId, ParticipantId } from '../types/Participant';
 import ParticipantLayout, { RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
 import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
 import SignalingMessage from '../types/SignalingMessage';
+import { IStartStreamData, IStopStreamData } from '../types/Streams';
 import { WaitingParticipantId } from '../types/WaitingHall';
 export default class Signaling extends BaseSignaling {
     private socket;
@@ -23,6 +27,7 @@ export default class Signaling extends BaseSignaling {
     private lastStamp;
     private websocketCommandsQueue;
     private datachannelCommandsQueue;
+    private asrCommandsQueue;
     private incomingCache;
     private responseHandlers;
     private reconnectCount;
@@ -40,8 +45,10 @@ export default class Signaling extends BaseSignaling {
     private participantIdRegistry;
     private producerNotificationDataChannel;
     private producerCommandDataChannel;
+    private asrDataChannel;
     private producerCommandDataChannelEnabled;
     private producerCommandSerializationService;
+    private asrCommandSerializer;
     private static readonly RECONNECT_DELAY;
     private static readonly RECONNECT_MAX_DELAY;
     private static readonly RECONNECT_MAX_COUNT;
@@ -96,21 +103,28 @@ export default class Signaling extends BaseSignaling {
     updateDisplayLayout(layouts: {
         [streamDesc: string]: ParticipantLayout | StopStream | RequestKeyFrame;
     }): Promise<SignalingMessage>;
-    addMovie(data: any): Promise<SignalingMessage>;
-    updateMovie(data: any): Promise<SignalingMessage>;
+    addMovie(data: IAddMovieParams): Promise<SignalingMessage>;
+    updateMovie(data: IUpdateMovieData): Promise<SignalingMessage>;
     removeMovie(data: any): Promise<SignalingMessage>;
-    startStream(data: any): Promise<SignalingMessage>;
-    stopStream(): Promise<SignalingMessage>;
-    recordSetRole(participantId: ParticipantId, role: RecordRole | null): Promise<SignalingMessage>;
+    updateRooms(rooms: SignalingMessage.Room[], assignRandomly: boolean): Promise<SignalingMessage>;
+    activateRooms(roomIds: number[], deactivate: boolean): Promise<SignalingMessage>;
+    switchRoom(toRoomId: number | null, participantId?: ParticipantId): Promise<SignalingMessage>;
+    getRooms(withParticipants: boolean): Promise<SignalingMessage>;
+    removeRooms(roomIds: number[]): Promise<SignalingMessage>;
+    startStream(data: IStartStreamData): Promise<SignalingMessage>;
+    stopStream(data?: IStopStreamData): Promise<SignalingMessage>;
+    recordSetRole(participantId: ParticipantId, role: RecordRole | null, roomId?: number | null): Promise<SignalingMessage>;
     getRecordStatus(): Promise<SignalingMessage>;
     switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
     requestRealloc(): Promise<SignalingMessage>;
     reportPerfStat(report: PerfStatReport): Promise<SignalingMessage>;
+    reportSharingStat(report: SharingStatReport): Promise<SignalingMessage>;
     chatMessage(message: string, participantId?: CompositeUserId | null): Promise<SignalingMessage>;
     chatHistory(count: number): Promise<SignalingMessage>;
     customData(data: JSONObject, participantId: ParticipantId | null): Promise<SignalingMessage>;
     grantRoles(participantId: CompositeUserId, roles: UserRole[], revoke: boolean): Promise<SignalingMessage>;
-    muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[]): Promise<SignalingMessage>;
+    muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[], roomId?: number | null): Promise<SignalingMessage>;
+    enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<SignalingMessage>;
     pinParticipant(participantId: ParticipantId, unpin: boolean): Promise<SignalingMessage>;
     updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
     changeOptions(changes: {
@@ -118,6 +132,7 @@ export default class Signaling extends BaseSignaling {
     }): Promise<SignalingMessage>;
     getWaitingHall(fromId?: WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
     promoteParticipant(participantId: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
+    feedback(key: string): Promise<SignalingMessage>;
     /**
      * Close a connection with a signaling server
      */
@@ -131,6 +146,10 @@ 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>;
+    requestAsr(request: boolean): Promise<SignalingMessage>;
+    setAsrDataChannel(dataChannel: RTCDataChannel): void;
     protected _connect(connectionType: SignalingConnectionType): void;
     protected _disconnect(): void;
     private _onOpen;
@@ -143,6 +162,7 @@ export default class Signaling extends BaseSignaling {
     protected _closeSocket(error?: Error | null): void;
     protected _reconnect(): void;
     private _handleCommandResponse;
+    private _serializeAsrCommand;
     private _handleCommandsQueue;
     private _serializeBinary;
     private _serializeJson;

package/enums/ConversationFeature.d.ts

@@ -1,5 +1,6 @@
 declare const enum ConversationFeature {
     ADD_PARTICIPANT = "ADD_PARTICIPANT",
-    RECORD = "RECORD"
+    RECORD = "RECORD",
+    MOVIE_SHARE = "MOVIE_SHARE"
 }
 export default ConversationFeature;

package/enums/ConversationOption.d.ts

@@ -4,7 +4,9 @@
 declare enum ConversationOption {
     REQUIRE_AUTH_TO_JOIN = "REQUIRE_AUTH_TO_JOIN",
     AUDIENCE_MODE = "AUDIENCE_MODE",
-    WAITING_HALL = "WAITING_HALL"
+    WAITING_HALL = "WAITING_HALL",
+    ASR = "ASR",
+    FEEDBACK = "FEEDBACK"
 }
 export default ConversationOption;
 export declare function compareOptions(oldOptions: ConversationOption[], newOptions: ConversationOption[]): boolean;

package/enums/DataChannelLabel.d.ts

@@ -2,6 +2,7 @@ declare const enum DataChannelLabel {
     producerNotification = "producerNotification",
     producerCommand = "producerCommand",
     consumerScreenShare = "consumerScreenShare",
-    producerScreenShare = "producerScreenShare"
+    producerScreenShare = "producerScreenShare",
+    asr = "asr"
 }
 export default DataChannelLabel;

package/enums/HangupType.d.ts

@@ -16,6 +16,7 @@ declare enum HangupType {
     CALLER_IS_BLOCKED = "CALLER_IS_BLOCKED",
     NOT_FRIENDS = "NOT_FRIENDS",
     CALLEE_IS_OFFLINE = "CALLEE_IS_OFFLINE",
+    CALLER_IS_REJECTED = "CALLER_IS_REJECTED",
     UNKNOWN_ERROR = "UNKNOWN_ERROR",
     UNSUPPORTED = "UNSUPPORTED",
     OLD_VERSION = "OLD_VERSION",
@@ -23,6 +24,7 @@ declare enum HangupType {
     EXTERNAL_API_ERROR = "EXTERNAL_API_ERROR",
     SOCKET_CLOSED = "SOCKET_CLOSED",
     ENDED = "ENDED",
-    KILLED_WITHOUT_DELETE = "KILLED_WITHOUT_DELETE"
+    KILLED_WITHOUT_DELETE = "KILLED_WITHOUT_DELETE",
+    ANOTHER_DEVICE = "ANOTHER_DEVICE"
 }
 export default HangupType;

package/enums/LiveStatus.d.ts

@@ -0,0 +1,12 @@
+declare enum LiveStatus {
+    NOT_DEFINED = -1,
+    WAITING = 0,
+    ONLINE = 1,
+    ENDED = 2,
+    UPCOMING = 3,
+    PROCESSING = 4,
+    ERROR = 5,
+    DELETED = 6,
+    BLOCKED = 7
+}
+export default LiveStatus;

package/enums/MediaOption.d.ts

@@ -4,6 +4,8 @@
 declare enum MediaOption {
     AUDIO = "AUDIO",
     VIDEO = "VIDEO",
-    SCREEN_SHARING = "SCREEN_SHARING"
+    SCREEN_SHARING = "SCREEN_SHARING",
+    MOVIE_SHARING = "MOVIE_SHARING",
+    AUDIO_SHARING = "AUDIO_SHARING"
 }
 export default MediaOption;

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

@@ -12,6 +12,7 @@ declare enum SignalingCommandType {
     CHANGE_STREAM_PRIORITIES = "change-streams-priorities",
     UPDATE_DISPLAY_LAYOUT = "update-display-layout",
     REPORT_PERF_STAT = "report-perf-stat",
+    REPORT_SHARING_STAT = "report-sharing-stat",
     RECORD_START = "record-start",
     RECORD_STOP = "record-stop",
     RECORD_SET_ROLE = "record-set-role",
@@ -24,6 +25,7 @@ declare enum SignalingCommandType {
     CUSTOM_DATA = "custom-data",
     GRANT_ROLES = "grant-roles",
     MUTE_PARTICIPANT = "mute-participant",
+    ENABLE_FEATURE_FOR_ROLES = "enable-feature-for-roles",
     PIN_PARTICIPANT = "pin-participant",
     UPDATE_MEDIA_MODIFIERS = "update-media-modifiers",
     CHANGE_OPTIONS = "change-options",
@@ -34,6 +36,15 @@ declare enum SignalingCommandType {
     REQUEST_TEST_MODE = "request-test-mode",
     ADD_MOVIE = "add-movie",
     UPDATE_MOVIE = "update-movie",
-    REMOVE_MOVIE = "remove-movie"
+    REMOVE_MOVIE = "remove-movie",
+    GET_ROOMS = "get-rooms",
+    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",
+    REQUEST_ASR = "request-asr"
 }
 export default SignalingCommandType;

package/enums/SignalingNotification.d.ts

@@ -35,6 +35,17 @@ declare enum SignalingNotification {
     PROMOTE_PARTICIPANT = "promote-participant",
     CHAT_ROOM_UPDATED = "chat-room-updated",
     PROMOTION_APPROVED = "promotion-approved",
-    JOIN_LINK_CHANGED = "join-link-changed"
+    JOIN_LINK_CHANGED = "join-link-changed",
+    FEEDBACK = "feedback",
+    MOVIE_UPDATE_NOTIFICATION = "movie-update-notification",
+    MOVIE_SHARE_INFO = "movie-share-info",
+    MOVIE_SHARE_STARTED = "movie-share-started",
+    MOVIE_SHARE_STOPPED = "movie-share-stopped",
+    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-dev.f69c395.0",
+  "version": "2.6.3-beta.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

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;
     /**
      * Добавили участника
      *
@@ -153,8 +215,9 @@ declare namespace External {
      * Ошибка получения трека с камеры или микрофона
      *
      * @param error
+     * @param original
      */
-    function onPermissionsError(error: FatalError): void;
+    function onPermissionsError(error: FatalError, original: Error): void;
     /**
      * Пользователь отключился от звонка
      *
@@ -188,9 +251,10 @@ declare namespace External {
      * @param userId Пользователь, для которого изменились разрешения или `null` для текущего пользователя
      * @param adminId Пользователь, который изменил разрешения
      * @param stateUpdated Если `true`, значит глобальное/персональное состояние изменилось и поля `muteStates`/`unmuteOptions` содержат обновления, если `false`, значит, эти поля не имеют значения
-     * @param requestedMedia Какие устройства попросили влючить участника
+     * @param requestedMedia Какие устройства попросили включить участника
+     * @param roomId ID сессионного зала или ничего в случае основного зала
      */
-    function onMuteStates(muteStates: MuteStates, unmuteOptions: MediaOption[], mediaOptions: MediaOption[], muteAll?: boolean, unmute?: boolean, userId?: ExternalParticipantId | null, adminId?: ExternalParticipantId | null, stateUpdated?: boolean, requestedMedia?: MediaOption[]): void;
+    function 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;
     /**
      * Изменились роли собеседника в звонке
      *
@@ -297,12 +361,14 @@ declare namespace External {
      * @param type Тип записи
      * @param externalMovieId Внешний ID ролика
      * @param externalOwnerId Внешний ID пользователя/группы от которого ведётся трансляция
+     * @param roomId ID зала в котором стартанула запись
      */
-    function onRecordStarted(initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string): void;
+    function onRecordStarted(initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string, roomId?: number | null): void;
     /**
      * Закончена запись звонка
+     * @param roomId ID зала в котором остановлена запись
      */
-    function onRecordStopped(): void;
+    function onRecordStopped(roomId?: number | null): void;
     /**
      * Состояние своей сети
      *
@@ -355,5 +421,54 @@ declare namespace External {
      * @param joinLink токен присоединения к звонку
      */
     function onJoinLinkChanged(joinLink: string): void;
+    /**
+     * Получено обновление по сессионным залам
+     * @param updates
+     */
+    function onRoomsUpdated(updates: Partial<Record<RoomsEventType, RoomsUpdate>>): void;
+    /**
+     * Получено обновление по сессионному залу
+     * @param eventTypes
+     * @param roomId
+     * @param room
+     * @param deactivate
+     */
+    function onRoomUpdated(eventTypes: RoomsEventType[], roomId: number, room: Room | null, deactivate: boolean | null): void;
+    /**
+     * Получено обновление по участникам сессионного зала
+     * @param update
+     */
+    function onRoomParticipantsUpdated(update: RoomParticipantUpdate): void;
+    /**
+     * Произошел переход в другой активный зал (или основной)
+     * @param roomId
+     */
+    function onRoomSwitched(roomId: number | null): void;
+    /**
+     * Установить id сессионного зала на старте звонка
+     * @param roomId
+     */
+    function onRoomStart(roomId: number | null): void;
+    /**
+     * Получена новая реакция
+     */
+    function onFeedback(feedback: IFeedbackExternal[], roomId?: number | null): void;
+    /**
+     * Изменилось состояние пермиссий фич в звонке
+     *
+     * @param featuresPerRole Информация о доступных фичах по ролям
+     */
+    function onFeaturesPerRoleChanged(featuresPerRole: IFeaturesPerRole): void;
+    /**
+     * Начата текстовая расшифровка звонка
+     * @param initiatorId Id пользователя, запустившего расшифровку звонка
+     * @param movieId Id расшифровки
+     */
+    function onAsrStarted(initiatorId: ExternalParticipantId, movieId: number): void;
+    /**
+     * Закончена текстовая расшифровка звонка
+     */
+    function onAsrStopped(): void;
+    function onAsrTranscription(id: ExternalParticipantId, text: string, timestamp: number, duration: number): void;
 }
 export default External;