@vkontakte/calls-sdk 2.8.11-dev.3d9bb708.0 → 2.8.11-dev.41bc9113.0

package/static/External.d.ts

@@ -35,7 +35,8 @@ export declare enum ParticipantStatus {
     RECONNECT = "RECONNECT",
     ERROR = "ERROR",
     HANGUP = "HANGUP",
-    PERMISSIONS = "PERMISSIONS"
+    PERMISSIONS = "PERMISSIONS",
+    ONHOLD = "ONHOLD"
 }
 /**
  * Функции обратного вызова для передачи в параметрах инициализации
@@ -55,28 +56,32 @@ declare namespace External {
      *
      * @param stream
      * @param mediaSettings
+     * @param conversationId
      */
-    function onScreenStream(stream: MediaStream | null, mediaSettings: MediaSettings): void;
+    function onScreenStream(stream: MediaStream | null, mediaSettings: MediaSettings, conversationId?: string): void;
     /**
      * Локальный стрим вимоджи добавлен/удалён
      *
      * @param stream
      * @param mediaSettings
+     * @param conversationId
      */
-    function onVmojiStream(stream: MediaStream | null, mediaSettings: MediaSettings): void;
+    function onVmojiStream(stream: MediaStream | null, mediaSettings: MediaSettings, conversationId?: string): void;
     /**
      * Получена ошибка Vmoji
      *
      * @param error
+     * @param conversationId
      */
-    function onVmojiError(error: VmojiError): void;
+    function onVmojiError(error: VmojiError, conversationId?: string): void;
     /**
      * Локальный стрим изменился
      *
      * @param mediaSettings
      * @param kind
+     * @param conversationId
      */
-    function onLocalStreamUpdate(mediaSettings: MediaSettings, kind: MediaTrackKind): void;
+    function onLocalStreamUpdate(mediaSettings: MediaSettings, kind: MediaTrackKind, conversationId?: string): void;
     /**
      * Изменился статус локального соединения
      *
@@ -99,30 +104,34 @@ declare namespace External {
      *
      * @param userId
      * @param data
+     * @param conversationId
      */
-    function onRemoteLive(userId: ExternalParticipantId, data: IOnRemoteMovieData): void;
+    function onRemoteLive(userId: ExternalParticipantId, data: IOnRemoteMovieData, conversationId?: string): void;
     /**
      * Получен собственный стрим лайв.
      * Если сервер закончил стримить собеседника, вместо стрима будет передан null
      *
      * @param userId
      * @param data
+     * @param conversationId
      */
-    function onLocalLive(userId: ExternalParticipantId, data: IOnRemoteMovieData): void;
+    function onLocalLive(userId: ExternalParticipantId, data: IOnRemoteMovieData, conversationId?: string): void;
     /**
      * Получено обновление стрима или лайва от собеседника.
      *
      * @param userId
      * @param data
+     * @param conversationId
      */
-    function onRemoteLiveUpdate(userId: ExternalParticipantId, data: ISharedMovieState): void;
+    function onRemoteLiveUpdate(userId: ExternalParticipantId, data: ISharedMovieState, conversationId?: string): void;
     /**
      * Получено обновление собственного стрима или лайва.
      *
      * @param userId
      * @param data
+     * @param conversationId
      */
-    function onLocalLiveUpdate(userId: ExternalParticipantId, data: ISharedMovieState): void;
+    function onLocalLiveUpdate(userId: ExternalParticipantId, data: ISharedMovieState, conversationId?: string): void;
     /**
      * Получен стрим с экрана собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
@@ -138,16 +147,18 @@ declare namespace External {
      *
      * @param userId
      * @param stream
+     * @param conversationId
      */
-    function onRemoteVmojiStream(userId: ExternalParticipantId, stream: MediaStream | null): void;
+    function onRemoteVmojiStream(userId: ExternalParticipantId, stream: MediaStream | null, conversationId?: string): void;
     /**
      * Cтрим собеседника приостановлен/возобновлен.
      *
      * @param userId
      * @param mediaType тип отключённого/включённого потока
      * @param suspended true - стрим был приостановлен, false - стрим был запущен
+     * @param conversationId
      */
-    function onRemoteStreamSuspended(userId: ExternalParticipantId, mediaType: MediaType, suspended: boolean): void;
+    function onRemoteStreamSuspended(userId: ExternalParticipantId, mediaType: MediaType, suspended: boolean, conversationId?: string): void;
     /**
      * Начат звонок
      *
@@ -162,63 +173,71 @@ declare namespace External {
     /**
      * Постраничные данные про участников при начале звонка
      * @param chunk
+     * @param conversationId
      */
-    function onConversationParticipantListChunk(chunk: ExternalParticipantListChunk): void;
+    function onConversationParticipantListChunk(chunk: ExternalParticipantListChunk, conversationId?: string): void;
     /**
      * Изменились данные стрима собеседника
      *
      * @param userId
      * @param mediaSettings
      * @param markers
+     * @param conversationId
      */
-    function onRemoteMediaSettings(userId: ExternalParticipantId, mediaSettings: MediaSettings, markers: ExternalParticipantListMarkers | null): void;
+    function onRemoteMediaSettings(userId: ExternalParticipantId, mediaSettings: MediaSettings, markers: ExternalParticipantListMarkers | null, conversationId?: string): void;
     /**
      * Изменились данные собственного стрима
      *
      * @param userId
      * @param mediaSettings
+     * @param conversationId
      */
-    function onLocalMediaSettings(userId: ExternalParticipantId, mediaSettings: MediaSettings): void;
+    function onLocalMediaSettings(userId: ExternalParticipantId, mediaSettings: MediaSettings, conversationId?: string): void;
     /**
      * Полученны данные по стримам (лайв/мувик) от собеседника
      *
      * @param userId
      * @param sharedMovieInfo
      * @param roomId
+     * @param conversationId
      */
-    function onRemoteSharedMovieInfo(userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo, roomId?: IRoomId): void;
+    function onRemoteSharedMovieInfo(userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo, roomId?: IRoomId, conversationId?: string): void;
     /**
      * Полученны данные по остановленным стримам (лайв/мувик) от собеседника
      *
      * @param userId
      * @param sharedMovieStoppedInfo
      * @param roomId
+     * @param conversationId
      */
-    function onRemoteSharedMovieStoppedInfo(userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo, roomId?: IRoomId): void;
+    function onRemoteSharedMovieStoppedInfo(userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo, roomId?: IRoomId, conversationId?: string): void;
     /**
      * Полученны данные по собственным стримам (лайв/мувик)
      *
      * @param userId
      * @param sharedMovieInfo
      * @param roomId
+     * @param conversationId
      */
-    function onLocalSharedMovieInfo(userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo, roomId?: IRoomId): void;
+    function onLocalSharedMovieInfo(userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo, roomId?: IRoomId, conversationId?: string): void;
     /**
      * Полученны данные по собственным остановленным стримам (лайв/мувик)
      *
      * @param userId
      * @param sharedMovieStoppedInfo
      * @param roomId
+     * @param conversationId
      */
-    function onLocalSharedMovieStoppedInfo(userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo, roomId?: IRoomId): void;
+    function onLocalSharedMovieStoppedInfo(userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo, roomId?: IRoomId, conversationId?: string): void;
     /**
      * Получены данные о совместном использовании  стороннего web-приложения
      *
      * @param userId
      * @param sharedUrl
      * @param roomId
+     * @param conversationId
      */
-    function onRemoteSharedUrl(userId: ExternalParticipantId, sharedUrl: string | undefined, roomId: IRoomId): void;
+    function onRemoteSharedUrl(userId: ExternalParticipantId, sharedUrl: string | undefined, roomId: IRoomId, conversationId?: string): void;
     /**
      * Добавили участника
      *
@@ -235,22 +254,24 @@ declare namespace External {
      * @param conversationId ID звонка
      */
     function onParticipantJoined(userId: ExternalId, markers: ExternalParticipantListMarkers | null, conversationId?: string): void;
-    function onLocalParticipantState(participantState: ParticipantStateMapped, global?: boolean): void;
+    function onLocalParticipantState(participantState: ParticipantStateMapped, global?: boolean, conversationId?: string): void;
     /**
      * Изменились данные состояний собеседника
      *
      * @param userId
      * @param participantState
      * @param markers
+     * @param conversationId
      */
-    function onRemoteParticipantState(userId: ExternalParticipantId, participantState: ParticipantStateMapped, markers: ExternalParticipantListMarkers | null): void;
+    function onRemoteParticipantState(userId: ExternalParticipantId, participantState: ParticipantStateMapped, markers: ExternalParticipantListMarkers | null, conversationId?: string): void;
     /**
      * Изменились данные состояний нескольких собеседников
      *
      * @param stateList
      * @param roomId
+     * @param conversationId
      */
-    function onRemoteParticipantsState(stateList: ParticipantsStateList, roomId?: IRoomId): void;
+    function onRemoteParticipantsState(stateList: ParticipantsStateList, roomId?: IRoomId, conversationId?: string): void;
     /**
      * Изменился статус соединения собеседников
      *
@@ -309,23 +330,26 @@ declare namespace External {
      * @param stateUpdated Если `true`, значит глобальное/персональное состояние изменилось и поля `muteStates`/`unmuteOptions` содержат обновления, если `false`, значит, эти поля не имеют значения
      * @param requestedMedia Какие устройства попросили включить участника
      * @param roomId ID сессионного зала или ничего в случае основного зала
+     * @param conversationId
      */
-    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;
+    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, conversationId?: string): void;
     /**
      * Изменились роли собеседника в звонке
      *
      * @param userId Внешний ID пользователя
      * @param roles Список ролей
      * @param isInitial Коллбек вызван при инициализации (переподключение в звонок, заранее назначенный админ)
+     * @param conversationId
      */
-    function onRolesChanged(userId: ExternalId, roles: UserRole[], isInitial?: boolean): void;
+    function onRolesChanged(userId: ExternalId, roles: UserRole[], isInitial?: boolean, conversationId?: string): void;
     /**
      * Изменились свои роли в звонке
      *
      * @param roles Список ролей
      * @param isInitial Коллбек вызван при инициализации (переподключение в звонок, заранее назначенный админ)
+     * @param conversationId
      */
-    function onLocalRolesChanged(roles: UserRole[], isInitial?: boolean): void;
+    function onLocalRolesChanged(roles: UserRole[], isInitial?: boolean, conversationId?: string): void;
     /**
      * Закрепляет/открепляет собеседника для всех
      *
@@ -333,21 +357,24 @@ declare namespace External {
      * @param unpin Открепить или закрепить
      * @param markers
      * @param roomId ID сессионного зала или ничего в случае основного зала
+     * @param conversationId
      */
-    function onPinnedParticipant(userId: ExternalParticipantId, unpin: boolean, markers: ExternalParticipantListMarkers | null, roomId?: number | null): void;
+    function onPinnedParticipant(userId: ExternalParticipantId, unpin: boolean, markers: ExternalParticipantListMarkers | null, roomId?: number | null, conversationId?: string): void;
     /**
      * Закрепляет/открепляет текущего пользователя у других собеседников
      *
      * @param unpin Открепить или закрепить
      * @param roomId ID сессионного зала или ничего в случае основного зала
+     * @param conversationId
      */
-    function onLocalPin(unpin: boolean, roomId?: number | null): void;
+    function onLocalPin(unpin: boolean, roomId?: number | null, conversationId?: string): void;
     /**
      * Изменились опции звонка
      *
      * @param options Список опций звонка
+     * @param conversationId
      */
-    function onOptionsChanged(options: ConversationOption[]): void;
+    function onOptionsChanged(options: ConversationOption[], conversationId?: string): void;
     /**
      * Входящий звонок был принят мной
      *
@@ -355,13 +382,11 @@ declare namespace External {
      */
     function onCallAccepted(conversationId?: string): void;
     /**
-     * Входящий звонок получен во время активного звонка
+     * Установление определенного звонка как активного
      *
      * @param conversationId ID звонка
-     * @param externalId
-     * @param mediaSettings
      */
-    function onIncomingCall(conversationId: string, externalId: ExternalParticipantId | undefined, mediaSettings: MediaSettings | undefined): void;
+    function onCallActive(conversationId: string): void;
     /**
      * Исходящий звонок был принят кем-то
      *
@@ -370,7 +395,7 @@ declare namespace External {
      * @param conversationId ID звонка
      */
     function onAcceptedCall(userId: ExternalId, capabilities: ParticipantCapabilities, conversationId?: string): void;
-    function onRateNeeded(): void;
+    function onRateNeeded(conversationId?: string): void;
     /**
      * Изменился говорящий в звонке
      *
@@ -382,11 +407,12 @@ declare namespace External {
      * Громкость собеседников
      *
      * @param volumes
+     * @param conversationId
      */
     function onVolumesDetected(volumes: {
         uid: ExternalParticipantId;
         volume: number;
-    }[]): void;
+    }[], conversationId?: string): void;
     /**
      * Громкость своего микрофона
      *
@@ -394,7 +420,7 @@ declare namespace External {
      * @param isMicEnabled
      */
     function onLocalVolume(volume: number, isMicEnabled: boolean): void;
-    function onJoinStatus(available: boolean, chatId: string): void;
+    function onJoinStatus(available: boolean, chatId: string, conversationId?: string): void;
     /**
      * Звонок был завершен
      *
@@ -421,16 +447,18 @@ declare namespace External {
      * @param message Сообщение
      * @param from ID отправителя
      * @param direct Личное сообщение или общее
+     * @param conversationId
      */
-    function onChatMessage(message: string, from: ExternalParticipantId, direct?: boolean): void;
+    function onChatMessage(message: string, from: ExternalParticipantId, direct?: boolean, conversationId?: string): void;
     /**
      * Получены данные от собеседника
      *
      * @param data Данные
      * @param from ID отправителя
      * @param direct Личное сообщение или общее
+     * @param conversationId
      */
-    function onCustomData(data: JSONObject, from: ExternalParticipantId, direct?: boolean): void;
+    function onCustomData(data: JSONObject, from: ExternalParticipantId, direct?: boolean, conversationId?: string): void;
     /**
      * Начата запись звонка
      *
@@ -441,28 +469,33 @@ declare namespace External {
      * @param externalMovieId Внешний ID ролика
      * @param externalOwnerId Внешний ID пользователя/группы от которого ведётся трансляция
      * @param roomId ID зала в котором стартанула запись
+     * @param conversationId
      */
-    function onRecordStarted(initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string, roomId?: number | null): void;
+    function onRecordStarted(initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string, roomId?: number | null, conversationId?: string): void;
     /**
      * Закончена запись звонка
      * @param roomId ID зала в котором остановлена запись
+     * @param stopBy
+     * @param conversationId
      */
-    function onRecordStopped(roomId: number | null | undefined, stopBy: ExternalParticipantId | null): void;
+    function onRecordStopped(roomId: number | null | undefined, stopBy: ExternalParticipantId | null, conversationId?: string): void;
     /**
      * Состояние своей сети
      *
      * @param rating Оценка качества соединения от 0 до 1
+     * @param conversationId
      */
-    function onLocalNetworkStatusChanged(rating: number): void;
+    function onLocalNetworkStatusChanged(rating: number, conversationId?: string): void;
     /**
      * Состояние сети участников
      *
      * @param status Оценки качества соединения участников от 0 до 1
+     * @param conversationId
      */
     function onNetworkStatusChanged(status: {
         uid: ExternalParticipantId;
         rating: number;
-    }[]): void;
+    }[], conversationId?: string): void;
     /**
      * Получено отладочное сообщение. Работает только при выключенном режиме отладки
      *
@@ -470,6 +503,9 @@ declare namespace External {
      * @param args
      */
     function onDebugMessage(type: DebugMessageType, ...args: any[]): void;
+    function onDebugMessageWithContext(type: DebugMessageType, context: {
+        conversationId: string | null;
+    }, ...args: any[]): void;
     /**
      * Статистика звонка
      *
@@ -489,103 +525,118 @@ declare namespace External {
      * @param firstParticipants Первые несколько ожидающих в зале
      * @param addedParticipantIds Некоторое количество участников, добавленных в зал
      * @param removedParticipantIds Некоторое количество участников, убранных из зала
+     * @param conversationId
      */
-    function onChatRoomUpdated(eventType: ChatRoomEventType, totalCount: number, firstParticipants: ExternalId[], addedParticipantIds: ExternalId[], removedParticipantIds: ExternalId[]): void;
+    function onChatRoomUpdated(eventType: ChatRoomEventType, totalCount: number, firstParticipants: ExternalId[], addedParticipantIds: ExternalId[], removedParticipantIds: ExternalId[], conversationId?: string): void;
     /**
      * Участник повышен/разжалован в зале ожидания/зале в режиме Audience
      *
      * @param demoted участник разжалован
+     * @param conversationId
      */
-    function onPromoted(demoted: boolean): void;
+    function onPromoted(demoted: boolean, conversationId?: string): void;
     /**
      * Получен микшированный аудио стрим.
      *
      * @param stream стрим от WebRTC
+     * @param conversationId
      */
-    function onRemoteMixedAudioStream(stream: MediaStream): void;
+    function onRemoteMixedAudioStream(stream: MediaStream, conversationId?: string): void;
     /**
      * Получена новая ссылка на звонок
      * @param joinLink токен присоединения к звонку
+     * @param conversationId
      */
-    function onJoinLinkChanged(joinLink: string | null): void;
+    function onJoinLinkChanged(joinLink: string | null, conversationId?: string): void;
     /**
      * Получено обновление по сессионным залам
      * @param updates
+     * @param conversationId
      */
-    function onRoomsUpdated(updates: Partial<Record<RoomsEventType, RoomsUpdate>>): void;
+    function onRoomsUpdated(updates: Partial<Record<RoomsEventType, RoomsUpdate>>, conversationId?: string): void;
     /**
      * Получено обновление по сессионному залу
      * @param eventTypes
      * @param roomId
      * @param room
      * @param deactivate
+     * @param conversationId
      */
-    function onRoomUpdated(eventTypes: RoomsEventType[], roomId: number, room: Room | null, deactivate: boolean | null): void;
+    function onRoomUpdated(eventTypes: RoomsEventType[], roomId: number, room: Room | null, deactivate: boolean | null, conversationId?: string): void;
     /**
      * Получено обновление по участникам сессионного зала
      * @param update
+     * @param conversationId
      */
-    function onRoomParticipantsUpdated(update: RoomParticipantUpdate): void;
+    function onRoomParticipantsUpdated(update: RoomParticipantUpdate, conversationId?: string): void;
     /**
      * Произошел переход в другой активный зал (или основной)
      * @param roomId
+     * @param conversationId
      */
-    function onRoomSwitched(roomId: number | null): void;
+    function onRoomSwitched(roomId: number | null, conversationId?: string): void;
     /**
      * Установить id сессионного зала на старте звонка
      * @param roomId
+     * @param conversationId
      */
-    function onRoomStart(roomId: number | null): void;
+    function onRoomStart(roomId: number | null, conversationId?: string): void;
     /**
      * Получена новая реакция
      */
-    function onFeedback(feedback: IFeedbackExternal[], roomId?: number | null): void;
+    function onFeedback(feedback: IFeedbackExternal[], roomId?: number | null, conversationId?: string): void;
     /**
      * Изменилось состояние пермиссий фич в звонке
      *
      * @param featuresPerRole Информация о доступных фичах по ролям
+     * @param conversationId
      */
-    function onFeaturesPerRoleChanged(featuresPerRole: IFeaturesPerRole): void;
+    function onFeaturesPerRoleChanged(featuresPerRole: IFeaturesPerRole, conversationId?: string): void;
     /**
      * Изменился Vmoji-аватар пользователя
      * @param externalId Id пользователя
+     * @param conversationId
      */
-    function onParticipantVmojiUpdate(externalId: ExternalParticipantId): void;
+    function onParticipantVmojiUpdate(externalId: ExternalParticipantId, conversationId?: string): void;
     /**
      * Установка начальных параметров текстовой расшифровки звонка. (Используется при входе в звонок/ смене комнаты)
      * @param data Начальная информация по ASR
      * @param roomId Id Комнаты
+     * @param conversationId
      */
-    function onAsrSet(data: IAsrData | null, roomId: number | null): void;
+    function onAsrSet(data: IAsrData | null, roomId: number | null, conversationId?: string): void;
     /**
      * Начата текстовая расшифровка звонка
      * @param initiatorId Id пользователя, запустившего расшифровку звонка
      * @param movieId Id расшифровки
      * @param roomId Id Комнаты
+     * @param conversationId
      */
-    function onAsrStarted(initiatorId: ExternalParticipantId, movieId: number, roomId: number | null): void;
+    function onAsrStarted(initiatorId: ExternalParticipantId, movieId: number, roomId: number | null, conversationId?: string): void;
     /**
      * Закончена текстовая расшифровка звонка
      * @param roomId Id Комнаты
+     * @param conversationId
      */
-    function onAsrStopped(roomId: number | null): void;
-    function onAsrTranscription(id: ExternalParticipantId, text: string, timestamp: number, duration: number): void;
+    function onAsrStopped(roomId: number | null, conversationId?: string): void;
+    function onAsrTranscription(id: ExternalParticipantId, text: string, timestamp: number, duration: number, conversationId?: string): void;
     /**
      * Изменился id участника (деанонимизация)
      * @param prevId
      * @param newId
+     * @param conversationId
      */
-    function onParticipantIdChanged(prevId: ExternalParticipantId, newId: ExternalParticipantId): void;
-    function onVideoSuspendSuggest(bandwidth: number): void;
+    function onParticipantIdChanged(prevId: ExternalParticipantId, newId: ExternalParticipantId, conversationId?: string): void;
+    function onVideoSuspendSuggest(bandwidth: number, conversationId?: string): void;
     /**
      * Одобрено повышение пользователя в зеле ожидания/зале в режиме Audience
      *
      * @param adminParticipantId админ, одобривший повышение
      */
-    function onPromotionApproved(adminParticipantId: ExternalParticipantId): void;
+    function onPromotionApproved(adminParticipantId: ExternalParticipantId, conversationId?: string): void;
     /**
      * Собеседник подключился к сигналлингу
      */
-    function onPeerRegistered(): void;
+    function onPeerRegistered(conversationId?: string): void;
 }
 export default External;