@vkontakte/calls-sdk 2.6.3-dev.d1d73c0.0 → 2.6.3-dev.dea4ecd.0

package/CallsSDK.d.ts

@@ -1,6 +1,7 @@
 /**
  * CallsSDK
  */
+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';
@@ -33,25 +34,25 @@ import { JSONArray, JSONObject, JSONType } from './static/Json';
 import { ParamsObject } from './static/Params';
 import Utils from './static/Utils';
 import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
-import { IAsrStartParams } from './types/Asr';
 import ConversationParams from './types/ConversationParams';
 import ConversationResponse from './types/ConversationResponse';
-import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId, ExternalParticipantListMarkers, ExternalUserId } from './types/ExternalId';
+import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers, ExternalUserId } from './types/ExternalId';
 import IceServer from './types/IceServer';
 import MediaModifiers from './types/MediaModifiers';
 import { IVideoDimentions, MediaSettings } from './types/MediaSettings';
 import MuteStates, { IMuteParticipantInternalParams, IMuteParticipantParams } from './types/MuteStates';
-import { IGetParticipantsParameters, OkUserId, ParticipantStateMapped } from './types/Participant';
-import ParticipantLayout, { Layout, StopStream } from './types/ParticipantLayout';
+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 { Room, RoomsUpdate, RoomParticipantUpdate } 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 { WaitingHallResponse } from './types/WaitingHall';
 import { IFeedbackExternal } from './types/Feedback';
-import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData } from './types/MovieShare';
+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';
@@ -72,6 +73,10 @@ export declare const browser: {
      * Возвращает все подключенные устройства вывода звука
      */
     getOutput: typeof WebRTCUtils.getOutput;
+    /**
+     * Возвращает тип используемой камеры (передняя или задняя)
+     */
+    getVideoFacingMode: typeof WebRTCUtils.getVideoFacingMode;
     /**
      * Есть ли у пользователя камера
      */
@@ -182,6 +187,13 @@ export declare function setLogger(logger: BaseLogger): void;
  * @param effects Экземпляр класса `VideoEffects` из `@vkontakte/calls-video-effects`
  */
 export declare function setVideoEffects(effects: VideoEffects): void;
+/**
+ * Устанавливает библиотеку вимоджи
+ *
+ * @param vmoji Экземпляр класса `Vmoji` из `@vkontakte/calls-vmoji`
+ * @param sdk Экземпляр модуля `@vkontakte/calls-vmoji`, нужен для проброски дебаг сообщений
+ */
+export declare function setVmoji(vmoji: typeof Vmoji, sdk?: Parameters<typeof Vmoji.setSDK>[0] | null): void;
 /**
  * Инициализирует библиотеку
  *
@@ -220,7 +232,7 @@ export declare function getTokenForAnonym(userId: string, appKey?: string): Prom
 export declare function apiCall(method: string, data?: any): Promise<any>;
 /**
  * Посылает тестовую команду request-test-mode на сервер, дабы ограничить сеть
- * Команда вида: {command:"data-set-link-params", params:{"bandwidth-kbps":"700"} }
+ * Команда вида: \{command:"data-set-link-params", params:\{"bandwidth-kbps":"700"\}\}
  * @param consumerCommand - команда для текущего приемника
  * @param producerCommand - команда для текущего отсылателя
  * @hidden
@@ -280,6 +292,13 @@ export declare function addParticipantInternal(uid: OkUserId, params?: AddPartic
  */
 export declare function removeParticipant(externalId: string | ExternalId, ban?: boolean): Promise<void>;
 export declare function removeParticipantInternal(uid: OkUserId, ban?: boolean): Promise<void>;
+/**
+ * Изменить камеру на фронтальную или заднюю (для мобильных устройств)
+ *
+ * @param kind
+ * @param facingMode
+ */
+export declare function changeDevice(kind: 'videoinput', facingMode: FacingMode): Promise<void>;
 /**
  * Изменить камеру, микрофон или динамик
  *
@@ -290,16 +309,17 @@ export declare function changeDevice(kind: MediaDeviceKind, deviceId: string): P
 /**
  * Включить/выключить захват экрана
  *
- * @param state Включить или выключить
+ * @param stateOrSettings
+ *      state Включить или выключить захват экрана
+ *      settings Параметры захваты экрана
  */
-export declare function captureScreen(state: boolean): Promise<void>;
+export declare function captureScreen(stateOrSettings: boolean | ScreenCaptureSettings): Promise<void>;
 /**
- * Включить/выключить захват экрана
+ * Включить/выключить передачу точек вимоджи
  *
- * @param screenState Включить или выключить захват экрана.
- * @param audioShareState Включить или выключить захват звука. Может быть использован только вместе с захватом экрана.
+ * @param state Включить или выключить
  */
-export declare function captureScreenAndAudio(screenState: boolean, audioShareState?: boolean): Promise<void>;
+export declare function captureVmoji(state: boolean): void;
 /**
  * Позволяет установить кастомный стрим для видео
  * например для стрима из canvas, с наложением изображений
@@ -499,12 +519,7 @@ export declare function removeMovie(movieId: number): 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>;
+export declare function updateRooms(rooms: Partial<Room>[], assignRandomly?: boolean): Promise<void>;
 /**
  * Активировать сессионные залы
  * @param roomIds
@@ -554,6 +569,17 @@ export declare function changeVideoEffect(effect: IEffect | null): Promise<void>
  * @hidden
  */
 export declare function setAudioStream(stream: MediaStream): Promise<void>;
+/**
+ * Позволяет установить svg аватар для участника звонка
+ *
+ * @param {(string|ArrayBuffer)} svg - svg в незашифрованном (string)
+ * или зашифрованном (ArrayBuffer) виде
+ * @param {(ExternalParticipantId|null)} externalId - externalId внешнего участника звонка,
+ * не требуется для текущего участника (текущего пользователя клиента)
+ * @param {(string|null)} customKey - кастомный ключ расшифровки svg,
+ * нужен только в случае присвоения участнику чужого аватара
+ */
+export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalParticipantId | null, customKey?: string | null): Promise<void>;
 /**
  * Получить состояние зала ожидания
  *
@@ -569,7 +595,7 @@ export declare function getWaitingHall(pageMarker?: string | null, count?: numbe
  * @param demote Запретить вход
  */
 export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
-export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<import("./types/ExternalId").ExternalParticipantListChunk>;
+export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<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>;
@@ -582,7 +608,7 @@ export declare function removeHistoryRecords(recordIds: number[]): Promise<void>
 /**
  * Начинает текстовую расшифровку звонка
  */
-export declare function startAsr(params: IAsrStartParams): Promise<void>;
+export declare function startAsr(): Promise<void>;
 /**
  * Заканчивает текстовую расшифровку звонка
  */
@@ -595,5 +621,5 @@ export declare function requestAsr(request: boolean): 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, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, };
+export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, 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, Utils, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, };

package/abstract/BaseApi.d.ts

@@ -3,7 +3,7 @@ import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
 import { ExternalId, ExternalUserId } from '../types/ExternalId';
 import { CompositeUserId, OkUserId } from '../types/Participant';
-export declare type LogItem = {
+export type LogItem = {
     count?: number;
     custom: Record<string, string | number>;
     data?: string[];

package/abstract/BaseSignaling.d.ts

@@ -9,7 +9,6 @@ import RecordRole from '../enums/RecordRole';
 import SignalingConnectionType from '../enums/SignalingConnectionType';
 import UserRole from '../enums/UserRole';
 import { JSONObject } from '../static/Json';
-import { IAsrStartParams } from '../types/Asr';
 import ConversationResponse from '../types/ConversationResponse';
 import MediaModifiers from '../types/MediaModifiers';
 import MediaSettings from '../types/MediaSettings';
@@ -64,7 +63,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     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 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 getRooms(withParticipants: boolean): Promise<SignalingMessage>;
@@ -96,7 +95,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract setAsrDataChannel(dataChannel: RTCDataChannel): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
-    abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
+    abstract startAsr(): Promise<SignalingMessage>;
     abstract stopAsr(): Promise<SignalingMessage>;
     abstract requestAsr(request: boolean): Promise<SignalingMessage>;
     get ready(): boolean;