@vkontakte/calls-sdk 2.6.2-dev.4163bb9.0 → 2.6.2-dev.459e12e.0

package/CallsSDK.d.ts

@@ -9,6 +9,7 @@ import { ConversationData } from './classes/Conversation';
 import HangupReason, { HangupReasonData } from './classes/HangupReason';
 import { MediaTrackKind } from './classes/MediaSource';
 import { StatResult } from './classes/transport/Statistics';
+import { TransportTopology } from './classes/transport/Transport';
 import Api from './default/Api';
 import Signaling from './default/Signaling';
 import CallDirection from './enums/CallDirection';
@@ -44,8 +45,16 @@ import ParticipantLayout, { Layout, StopStream } from './types/ParticipantLayout
 import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
 import ParticipantPriority from './types/ParticipantPriority';
 import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
+import { Room, RoomsUpdate, RoomParticipantUpdate } from './types/Room';
+import RoomsEventType from './enums/RoomsEventType';
 import SignalingMessage from './types/SignalingMessage';
 import { WaitingHallResponse } from './types/WaitingHall';
+import { IFeedbackExternal } from './types/Feedback';
+import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData } from './types/MovieShare';
+import ConversationFeature from './enums/ConversationFeature';
+import { IFeaturesPerRole } from './types/ConversationFeature';
+import { ArrayDequeue } from './utils/ArrayDequeue';
+import { AsrInfo } from './types/Asr';
 /**
  * Информация о текущем браузере
  */
@@ -184,9 +193,10 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
  * @param payload Дополнительные данные для передачи на сервер
  * @param joiningAllowed Создать токен комнаты для подключения по ссылке
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
+ * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
  */
-export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean): Promise<ConversationData>;
-export declare function callInternal(ids: OkUserId[], type: CallType, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: 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, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
 /**
  * Обработать пуш о входящем звонке
  *
@@ -239,8 +249,10 @@ export declare function joinCallInternal(conversationId: string, mediaOptions: M
  * @param joinLink Токен комнаты
  * @param mediaOptions Нужно ли включать камеру и микрофон
  * @param anonymToken Токен анонимной авторизации
+ * @param observedIds
+ * @param payload
  */
-export declare function joinCallByLink(joinLink: string, mediaOptions?: MediaOption[], anonymToken?: string, observedIds?: ExternalUserId[]): Promise<ConversationData>;
+export declare function joinCallByLink(joinLink: string, mediaOptions?: MediaOption[], anonymToken?: string, observedIds?: ExternalUserId[], payload?: string): Promise<ConversationData>;
 /**
  * Завершить текущий разговор
  */
@@ -274,6 +286,13 @@ export declare function changeDevice(kind: MediaDeviceKind, deviceId: string): P
  * @param state Включить или выключить
  */
 export declare function captureScreen(state: boolean): Promise<void>;
+/**
+ * Включить/выключить захват экрана
+ *
+ * @param screenState Включить или выключить захват экрана.
+ * @param audioShareState Включить или выключить захват звука. Может быть использован только вместе с захватом экрана.
+ */
+export declare function captureScreenAndAudio(screenState: boolean, audioShareState: boolean): Promise<void>;
 /**
  * Позволяет установить кастомный стрим для видео
  * например для стрима из canvas, с наложением изображений
@@ -341,9 +360,12 @@ export declare function grantRolesInternal(uid: OkUserId, roles: UserRole[], rev
  * @param externalId Внешний ID пользователя (если не указано, сработает на всех)
  * @param muteStates Состояние устройств пользователя
  * @param requestedMedia Попросить пользователя включить устройство
+ * @param roomId ID сессионного зала, либо ничего если в основном зале
  */
-export declare function muteParticipant(externalId: string | ExternalParticipantId | null, muteStates: MuteStates, requestedMedia?: MediaOption[]): Promise<void>;
-export declare function muteParticipantInternal(uid: OkUserId | null, muteStates: MuteStates, requestedMedia?: MediaOption[], deviceIdx?: number): Promise<void>;
+export declare function muteParticipant(externalId: string | ExternalParticipantId | null, muteStates: MuteStates, requestedMedia?: MediaOption[], roomId?: number | null): Promise<void>;
+export declare function muteParticipantInternal(uid: OkUserId | null, muteStates: MuteStates, requestedMedia?: MediaOption[], deviceIdx?: number, roomId?: number | null): Promise<void>;
+export declare function applyMuteStates(muteStates: MuteStates, mediaOptions: MediaOption[], roomId?: number | null): void;
+export declare function changeRecordInfoForRoom(roomId?: number | null): Promise<void>;
 /**
  * Закрепить/открепить выбранного собеседника у всех (только если есть соответствующая роль)
  *
@@ -393,9 +415,12 @@ export declare function customDataInternal(data: JSONObject, uid?: OkUserId | nu
  *
  * @param payload Дополнительные данные для передачи на сервер
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
+ * @param startConversationParameters Дополнительные параметры для создания звонка (например onlyAdminCanShareMovie)
  * @returns Токен комнаты
  */
-export declare function startConversation(payload?: string, requireAuthToJoin?: boolean): Promise<string>;
+export declare function startConversation(payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie }?: {
+    onlyAdminCanShareMovie?: boolean;
+}): Promise<string>;
 /**
  * Создать токен комнаты для подключения по ссылке к существующему звонку
  *
@@ -424,8 +449,8 @@ export declare function setVolume(volume: number): void;
  * @param enabled
  */
 export declare function forceRelayPolicy(enabled: boolean): void;
-export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null): Promise<SignalingMessage>;
-export declare function stopStream(): Promise<SignalingMessage>;
+export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null): Promise<SignalingMessage>;
+export declare function stopStream(roomId?: number | null): Promise<SignalingMessage>;
 /**
  * Устанавливает роль участника в запись звонка
  * Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
@@ -436,8 +461,9 @@ export declare function stopStream(): Promise<SignalingMessage>;
  *
  * @param externalId Внешний ID пользователя
  * @param role Роль, если null, то роль удалится
+ * @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
  */
-export declare function recordSetRole(externalId: string | ExternalParticipantId, role: RecordRole | null): Promise<void>;
+export declare function recordSetRole(externalId: string | ExternalParticipantId, role: RecordRole | null, roomId?: number | null): Promise<void>;
 export declare function getStreamInfo(): Promise<{
     movieId: any;
     preview: any;
@@ -445,25 +471,52 @@ export declare function getStreamInfo(): Promise<{
 /**
  * Добавляет видео/лайв в звонок
  *
- * @param movieId
+ * @param params
  */
-export declare function addMovie(movieId: string): Promise<{
+export declare function addMovie(params: IAddMovieParams): Promise<{
     movieId: string;
     streamType: string;
 }>;
 /**
  * Изменить видео/лайв в звонке
  *
- * @param movieId
- * @param gain
+ * @param params
  */
-export declare function updateMovie(movieId: string, gain?: number, offset?: string, pause?: boolean): Promise<void>;
+export declare function updateMovie(params: IUpdateMovieData): Promise<void>;
 /**
  * Удалить видео/лайв из звонка
  *
  * @param movieId
  */
 export declare function removeMovie(movieId: string): Promise<void>;
+/**
+ * Обновить комнаты
+ * @param rooms id в случае обновления комнаты
+ * @param assignRandomly рандомно назначить участников комнаты из свободных в соответствии с participantCount
+ */
+export declare function updateRooms(rooms: {
+    id?: number;
+    name?: string;
+    participantCount?: number;
+    active?: boolean;
+}[], assignRandomly: boolean): Promise<void>;
+/**
+ * Активировать комнаты
+ * @param roomIds
+ * @param deactivate
+ */
+export declare function activateRooms(roomIds: number[], deactivate: boolean): Promise<void>;
+/**
+ * Cменить комнату
+ * @param toRoomId
+ * @param participantId
+ */
+export declare function switchRoom(toRoomId?: number | null, participantId?: string | ExternalParticipantId | null): Promise<void>;
+/**
+ * Удалить комнаты
+ * @param roomIds
+ */
+export declare function removeRooms(roomIds: number[]): Promise<void>;
 /**
  * Устанавливает интервал обновления статистики и вызова `onStatistics`
  *
@@ -513,15 +566,25 @@ export declare function getWaitingHall(pageMarker?: string | null, count?: numbe
 export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
 export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<import("./types/ExternalId").ExternalParticipantListChunk>;
 export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
+export declare function feedback(key: string): Promise<SignalingMessage>;
+export declare function enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<void>;
 /**
  * Удаляет записи истории звонков
  *
  * @param recordIds Идентификаторы записей истории
  */
 export declare function removeHistoryRecords(recordIds: number[]): Promise<void>;
+/**
+ * Начинает текстовую расшифровку звонка
+ */
+export declare function startAsr(): Promise<void>;
+/**
+ * Заканчивает текстовую расшифровку звонка
+ */
+export declare function stopAsr(): Promise<void>;
 /**
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, };
-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, Utils, };
+export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, AsrInfo, };
+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, Utils, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, };

package/abstract/BaseApi.d.ts

@@ -19,8 +19,12 @@ export default abstract class BaseApi {
     abstract init(): void;
     abstract authorize(): Promise<void>;
     abstract userId(participantId: CompositeUserId): Promise<ExternalId>;
-    abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean): Promise<ConversationResponse>;
-    abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean): Promise<ConversationResponse>;
+    abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
+        onlyAdminCanShareMovie?: boolean;
+    }): Promise<ConversationResponse>;
+    abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, createConversationParameters?: {
+        onlyAdminCanShareMovie?: boolean;
+    }): Promise<ConversationResponse>;
     abstract joinConversation(conversationId: string, isVideo?: boolean, chatId?: string): Promise<ConversationResponse>;
     createJoinLink(conversationId: string): Promise<{
         join_link: string;
@@ -29,7 +33,7 @@ export default abstract class BaseApi {
         success: boolean;
     }>;
     getAnonymTokenByLink(joinLink: string, username?: string): Promise<string>;
-    abstract joinConversationByLink(joinLink: string, isVideo?: boolean, observedIds?: ExternalUserId[]): Promise<ConversationResponse>;
+    abstract joinConversationByLink(joinLink: string, isVideo?: boolean, observedIds?: ExternalUserId[], payload?: string): Promise<ConversationResponse>;
     abstract getConversationParams(conversationId?: string): Promise<ConversationParams>;
     abstract getUserId(): OkUserId | null;
     abstract setUserId(userId: OkUserId): void;

package/abstract/BaseSignaling.d.ts

@@ -2,6 +2,7 @@ import EventEmitter from '../classes/EventEmitter';
 import { ParticipantIdRegistry } from '../classes/ParticipantIdRegistry';
 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,12 +12,14 @@ import { JSONObject } from '../static/Json';
 import ConversationResponse from '../types/ConversationResponse';
 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 { WaitingParticipantId } from '../types/WaitingHall';
+import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 /**
  * Параметры добавления пользователя в звонок
  */
@@ -56,20 +59,26 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract updateDisplayLayout(layouts: {
         [streamDesc: string]: ParticipantLayout | StopStream | RequestKeyFrame;
     }): Promise<SignalingMessage | void>;
-    abstract addMovie(data: any): Promise<SignalingMessage>;
-    abstract updateMovie(data: any): Promise<SignalingMessage>;
+    abstract addMovie(data: IAddMovieParams): Promise<SignalingMessage>;
+    abstract updateMovie(data: IUpdateMovieData): Promise<SignalingMessage>;
     abstract removeMovie(data: any): Promise<SignalingMessage>;
+    abstract updateRooms(rooms: Record<any, any>[], assignRandomly: boolean): Promise<SignalingMessage>;
+    abstract activateRooms(roomIds: number[], deactivate: boolean): Promise<SignalingMessage>;
+    abstract switchRoom(toRoomId: number | null, participantId?: ParticipantId): Promise<SignalingMessage>;
+    abstract removeRooms(roomIds: number[]): Promise<SignalingMessage>;
     abstract startStream(data: any): Promise<SignalingMessage>;
-    abstract stopStream(): Promise<SignalingMessage>;
-    abstract recordSetRole(participantId: ParticipantId, role: RecordRole | null): Promise<SignalingMessage>;
+    abstract stopStream(data: any): 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>;
+    abstract reportSharingStat(report: SharingStatReport): Promise<SignalingMessage>;
     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: CompositeUserId, roles: UserRole[], revoke: boolean): Promise<SignalingMessage>;
-    abstract muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[]): 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): Promise<SignalingMessage>;
     abstract updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
     abstract changeOptions(changes: {
@@ -77,11 +86,14 @@ export default abstract class BaseSignaling extends EventEmitter {
     }): Promise<SignalingMessage>;
     abstract getWaitingHall(fromId: WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
     abstract promoteParticipant(participantId: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
+    abstract feedback(key: string): Promise<SignalingMessage>;
     abstract setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
     abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
     abstract useCommandDataChannel(status: boolean): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
+    abstract startAsr(): Promise<SignalingMessage>;
+    abstract stopAsr(): Promise<SignalingMessage>;
     get ready(): boolean;
     setParticipantIdRegistry(participantIdRegistry: ParticipantIdRegistry): void;
     requestRealloc(): void;