@vkontakte/calls-sdk 2.8.2-dev.7d16b73.0 → 2.8.2-dev.85d7f78.0

package/CallsSDK.d.ts

@@ -1,21 +1,20 @@
 /**
  * CallsSDK
  */
-import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
 import type * as Vmoji from '@vkontakte/calls-vmoji';
+import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
 import BaseApi from './abstract/BaseApi';
 import BaseLogger from './abstract/BaseLogger';
 import BaseSignaling, { AddParticipantParams } from './abstract/BaseSignaling';
 import HangupReason, { HangupReasonData } from './classes/HangupReason';
 import { MediaTrackKind } from './classes/MediaSource';
-import { AudienceModeHandsResponse } from './types/AudienceMode';
+import { StatResult } from './types/Statistics';
 import { TransportTopology } from './classes/transport/Transport';
 import Api from './default/Api';
 import Signaling from './default/Signaling';
 import CallDirection from './enums/CallDirection';
 import CallType from './enums/CallType';
 import ChatRoomEventType from './enums/ChatRoomEventType';
-import ConversationFeature from './enums/ConversationFeature';
 import ConversationOption from './enums/ConversationOption';
 import FatalError from './enums/FatalError';
 import HangupType from './enums/HangupType';
@@ -23,7 +22,6 @@ import MediaOption from './enums/MediaOption';
 import MuteState from './enums/MuteState';
 import ParticipantState from './enums/ParticipantState';
 import RecordRole from './enums/RecordRole';
-import RoomsEventType from './enums/RoomsEventType';
 import SignalingCommandType from './enums/SignalingCommandType';
 import SignalingConnectionType from './enums/SignalingConnectionType';
 import SignalingNotification from './enums/SignalingNotification';
@@ -35,32 +33,31 @@ import { JSONArray, JSONObject, JSONType } from './static/Json';
 import { ParamsObject } from './static/Params';
 import Utils from './static/Utils';
 import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
-import { IAsrData, IAsrStartParams, IAsrStopParams } from './types/Asr';
-import { ConversationData } from './types/Conversation';
-import { IFeaturesPerRole } from './types/ConversationFeature';
+import { IAsrStartParams, IAsrStopParams, IAsrData } from './types/Asr';
 import ConversationParams from './types/ConversationParams';
 import ConversationResponse from './types/ConversationResponse';
 import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers, ExternalUserId } from './types/ExternalId';
-import { IFeedbackExternal } from './types/Feedback';
 import IceServer from './types/IceServer';
 import MediaModifiers from './types/MediaModifiers';
 import { IVideoDimentions, MediaSettings } from './types/MediaSettings';
-import { IAddMovieParams, IMovieMetaData, IMoviePreview, IOnRemoteMovieData, ISharedMovieInfo, ISharedMovieState, ISharedMovieStateResponse, ISharedMovieStoppedInfo, IUpdateMovieData } from './types/MovieShare';
 import MuteStates, { IMuteParticipantInternalParams, IMuteParticipantParams } from './types/MuteStates';
-import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantStateMapped } from './types/Participant';
+import { IGetParticipantsParameters, OkUserId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantStateMapped } from './types/Participant';
 import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
 import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
 import ParticipantPriority from './types/ParticipantPriority';
 import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
-import { IRoomId, Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from './types/Room';
+import { Room, RoomsUpdate, RoomParticipantUpdate, Rooms } from './types/Room';
+import RoomsEventType from './enums/RoomsEventType';
 import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
 import SignalingMessage from './types/SignalingMessage';
-import { StatResult } from './types/Statistics';
-import { IStartStreamData, IStopStreamData, IPublishStreamData } from './types/Streams';
 import { WaitingHallResponse } from './types/WaitingHall';
+import { IFeedbackExternal } from './types/Feedback';
+import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData, IMovieMetaData } from './types/MovieShare';
+import { IStartStreamData, IStopStreamData } from './types/Streams';
+import ConversationFeature from './enums/ConversationFeature';
+import { IFeaturesPerRole } from './types/ConversationFeature';
 import { ArrayDequeue } from './utils/ArrayDequeue';
-import { ApiExternal } from './default/ApiExternal';
-import AuthData from './static/AuthData';
+import { ConversationData } from './types/Conversation';
 /**
  * Информация о текущем браузере
  */
@@ -227,7 +224,7 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
  * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
  */
-export declare function callTo(externalId?: ExternalId | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
+export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
 export declare function callInternal(ids: OkUserId[], type: CallType | undefined, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
 /**
  * Обработать пуш о входящем звонке
@@ -285,7 +282,7 @@ export declare function hangup(): Promise<void>;
  * @param externalId Внешний ID пользователя
  * @param params Параметры
  */
-export declare function addParticipant(externalId: ExternalId, params?: AddParticipantParams): Promise<void>;
+export declare function addParticipant(externalId: string | ExternalId, params?: AddParticipantParams): Promise<void>;
 export declare function addParticipantInternal(uid: OkUserId, params?: AddParticipantParams): Promise<void>;
 /**
  * Удалить собеседника из звонка
@@ -293,7 +290,7 @@ export declare function addParticipantInternal(uid: OkUserId, params?: AddPartic
  * @param externalId Внешний ID пользователя
  * @param ban Забанить пользователя
  */
-export declare function removeParticipant(externalId: ExternalId, ban?: boolean): Promise<void>;
+export declare function removeParticipant(externalId: string | ExternalId, ban?: boolean): Promise<void>;
 export declare function removeParticipantInternal(uid: OkUserId, ban?: boolean): Promise<void>;
 /**
  * Изменить камеру на фронтальную или заднюю (для мобильных устройств)
@@ -382,8 +379,8 @@ export declare function updateDisplayLayout(layout: ParticipantLayout[]): Promis
  * @param roles Список ролей
  * @param revoke Забрать роли
  */
-export declare function grantRoles(externalId: ExternalId, roles: UserRole[], revoke?: boolean): Promise<void>;
-export declare function grantRolesInternal(uid: OkUserId, deviceIdx: number, roles: UserRole[], revoke?: boolean): Promise<void>;
+export declare function grantRoles(externalId: string | ExternalId, roles: UserRole[], revoke?: boolean): Promise<void>;
+export declare function grantRolesInternal(uid: OkUserId, roles: UserRole[], revoke?: boolean): Promise<void>;
 /**
  * Выключить или выключить микрофон и/или камеру собеседнику (только если есть соответствующая роль)
  *
@@ -399,9 +396,8 @@ export declare function muteParticipantInternal({ uid, muteStates, requestedMedi
  *
  * @param externalId Внешний ID пользователя
  * @param unpin Открепить
- * @param roomId Идентификатор комнаты
  */
-export declare function pinParticipant(externalId: ExternalId, unpin?: boolean, roomId?: number | null): Promise<void>;
+export declare function pinParticipant(externalId: string | ExternalParticipantId, unpin?: boolean, roomId?: number | null): Promise<void>;
 export declare function pinParticipantInternal(uid: OkUserId, unpin?: boolean, deviceIdx?: number, roomId?: number | null): Promise<void>;
 /**
  * Устанавливает настройки пользовательского медиа
@@ -423,7 +419,7 @@ export declare function changeConversationOptions(changes: {
  * @param message Сообщение
  * @param externalId Внешний ID пользователя (если не указано, отправит всем)
  */
-export declare function chatMessage(message: string, externalId?: ExternalId | null): Promise<void>;
+export declare function chatMessage(message: string, externalId?: string | ExternalId | null): Promise<void>;
 export declare function chatMessageInternal(message: string, uid?: OkUserId | null): Promise<void>;
 /**
  * Получить историю сообщений чата
@@ -437,7 +433,7 @@ export declare function chatHistory(count?: number): Promise<void>;
  * @param data Данные
  * @param externalId Внешний ID пользователя (если не указано, отправит всем)
  */
-export declare function customData(data: JSONObject, externalId?: ExternalId | null): Promise<void>;
+export declare function customData(data: JSONObject, externalId?: string | ExternalParticipantId | null): Promise<void>;
 export declare function customDataInternal(data: JSONObject, uid?: OkUserId | null, deviceIdx?: number): Promise<void>;
 /**
  * Создать токен комнаты для подключения по ссылке
@@ -505,21 +501,19 @@ export declare function startStream(isRecord?: boolean, name?: string | null, mo
  * @param roomId
  */
 export declare function stopStream(roomId?: number | null): Promise<undefined>;
-/**
- * Опубликовать трансляцию звонка
- * @param roomId
- */
-export declare function publishStream(roomId?: number | null): Promise<undefined>;
 /**
  * Устанавливает роль участника в запись звонка
  * Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
  * видны только те участники, у кого есть роль.
- * @param king участник показывается крупно в записи звонка (только один участник имеет такую роль)
- * @param pawns участник показывается в записи звонка
- * @param hideParticipantCount скрыть/показать количество невидимых участников
- * @param roomId комната
+ *  KING - участник показывается крупно в записи звонка (только один участник имеет такую роль)
+ *  PAWN - участник показывается в записи звонка
+ *  null - роль удаляется
+ *
+ * @param externalId Внешний ID пользователя
+ * @param role Роль, если null, то роль удалится
+ * @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
  */
-export declare function recordSetConf(king?: ExternalId, pawns?: ExternalId[], hideParticipantCount?: boolean, roomId?: number | null): Promise<void>;
+export declare function recordSetRole(externalId: string | ExternalParticipantId, role: RecordRole | null, roomId?: number | null): Promise<void>;
 /**
  * Получить информацию о трансляции звонка
  */
@@ -563,9 +557,9 @@ export declare function activateRooms(roomIds: number[], deactivate: boolean): P
 /**
  * Cменить сессионный зал
  * @param toRoomId
- * @param externalId
+ * @param participantId
  */
-export declare function switchRoom(toRoomId?: number | null, externalId?: ExternalId | null): Promise<void>;
+export declare function switchRoom(toRoomId?: number | null, participantId?: string | ExternalParticipantId | null): Promise<void>;
 /**
  * Удалить сессионные залы
  * @param roomIds
@@ -608,12 +602,12 @@ export declare function setAudioStream(stream: MediaStream): Promise<void>;
  *
  * @param {(string|ArrayBuffer)} svg - svg в незашифрованном (string)
  * или зашифрованном (ArrayBuffer) виде
- * @param {(ExternalId|null)} externalId - externalId внешнего участника звонка,
+ * @param {(ExternalParticipantId|null)} externalId - externalId внешнего участника звонка,
  * не требуется для текущего участника (текущего пользователя клиента)
  * @param {(string|null)} customKey - кастомный ключ расшифровки svg,
  * нужен только в случае присвоения участнику чужого аватара
  */
-export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalId | null, customKey?: string | null): Promise<void>;
+export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalParticipantId | null, customKey?: string | null): Promise<void>;
 /**
  * Получить состояние зала ожидания
  *
@@ -622,10 +616,6 @@ export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: Exte
  * @param backward Получить результат в обратном порядке
  */
 export declare function getWaitingHall(pageMarker?: string | null, count?: number, backward?: boolean): Promise<WaitingHallResponse>;
-/**
- * Получить список слушателей, запросивших повышение в комнате в режиме Audience
- */
-export declare function getAudienceModeHands(): Promise<AudienceModeHandsResponse>;
 /**
  * Разрешить/запретить пользователю войти из зала ожидания/стать спикером комнаты
  * в режиме Audience
@@ -673,5 +663,5 @@ export declare function requestAsr(request: boolean): Promise<void>;
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, ParticipantListMarker, RequestKeyFrame, Rooms, IGetParticipantsParameters, ScreenCaptureSettings, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IMovieMetaData, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IRoomId, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, IPublishStreamData, };
-export { Api, AuthData, BaseApi, BaseLogger, BaseSignaling, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, ApiExternal, };
+export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, ParticipantListMarker, RequestKeyFrame, Rooms, IGetParticipantsParameters, ScreenCaptureSettings, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IMovieMetaData, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, };
+export { Api, BaseApi, BaseLogger, BaseSignaling, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, };

package/abstract/BaseApi.d.ts

@@ -3,7 +3,7 @@ import { ConversationData } from '../types/Conversation';
 import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
 import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
-import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
+import { CompositeUserId, OkUserId } from '../types/Participant';
 export type LogItem = {
     count?: number;
     custom: {
@@ -22,7 +22,7 @@ export type LogItem = {
 export default abstract class BaseApi {
     abstract init(): void;
     abstract authorize(): Promise<void>;
-    abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
+    abstract userId(participantId: CompositeUserId): Promise<ExternalId>;
     abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
         onlyAdminCanShareMovie?: boolean;
         audienceMode?: boolean;
@@ -44,11 +44,10 @@ export default abstract class BaseApi {
     abstract setUserId(userId: OkUserId): void;
     log(items: LogItem[]): void;
     prepareUserIds(ids: OkUserId[]): Promise<void>;
-    abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
-    abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
+    abstract getOkIdsByExternalIds(externalIds: (string | ExternalId)[]): Promise<OkUserId[]>;
     abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
-    getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
-    cacheExternalId(participantId: CompositeUserId, externalId: ExternalParticipantId): void;
+    getCachedOkIdByExternalId(externalId: ExternalId): CompositeUserId | null;
+    cacheExternalId(participantId: CompositeUserId, externalId: ExternalId): void;
     hangupConversation(conversationId: string): void;
     removeHistoryRecords(recordIds: number[]): Promise<void>;
     cleanup(): void;

package/abstract/BaseSignaling.d.ts

@@ -6,6 +6,7 @@ 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';
 import SignalingConnectionType from '../enums/SignalingConnectionType';
 import UserRole from '../enums/UserRole';
 import { JSONObject } from '../static/Json';
@@ -19,7 +20,7 @@ import { CompositeUserId, ParticipantId } from '../types/Participant';
 import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
 import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
 import SignalingMessage from '../types/SignalingMessage';
-import { IPublishStreamData, IRecordConfData, IStartStreamData, IStopStreamData } from '../types/Streams';
+import { IStartStreamData, IStopStreamData } from '../types/Streams';
 import { WaitingParticipantId } from '../types/WaitingHall';
 import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 /**
@@ -74,8 +75,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract removeRooms(roomIds: number[]): Promise<SignalingMessage>;
     abstract startStream(data: IStartStreamData): Promise<SignalingMessage>;
     abstract stopStream(data: IStopStreamData): Promise<SignalingMessage>;
-    abstract publishStream(data: IPublishStreamData): Promise<SignalingMessage>;
-    abstract recordSetConf(conf: IRecordConfData): Promise<SignalingMessage>;
+    abstract recordSetRole(participantId: ParticipantId, role: RecordRole | null, roomId: number | null): Promise<SignalingMessage>;
     abstract getRecordStatus(): Promise<SignalingMessage>;
     abstract switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
     abstract reportPerfStat(report: PerfStatReport): Promise<SignalingMessage>;
@@ -83,7 +83,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract chatMessage(message: string, participantId: CompositeUserId | null): Promise<SignalingMessage>;
     abstract chatHistory(count: number): Promise<SignalingMessage>;
     abstract customData(data: JSONObject, participantId: ParticipantId | null): Promise<SignalingMessage>;
-    abstract grantRoles(participantId: ParticipantId, roles: UserRole[], revoke: boolean): Promise<SignalingMessage>;
+    abstract grantRoles(participantId: CompositeUserId, roles: UserRole[], revoke: boolean): Promise<SignalingMessage>;
     abstract muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[], roomId: number | null): Promise<SignalingMessage>;
     abstract enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<SignalingMessage>;
     abstract pinParticipant(participantId: ParticipantId, unpin: boolean, roomId: number | null): Promise<SignalingMessage>;
@@ -96,10 +96,10 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract requestPromotion(demote: boolean): Promise<SignalingMessage>;
     abstract acceptPromotion(reject: boolean): Promise<SignalingMessage>;
     abstract feedback(key: string): Promise<SignalingMessage>;
-    abstract getHandQueue(): Promise<SignalingMessage>;
     abstract setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
     abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
     abstract useCommandDataChannel(status: boolean): void;
+    abstract setAsrDataChannel(dataChannel: RTCDataChannel): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
     abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;