@vkontakte/calls-sdk 2.8.5-dev.ba039a1.0 → 2.8.5-dev.bafa170e.0

package/CallsSDK.d.ts

@@ -2,10 +2,10 @@
  * CallsSDK
  */
 import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
+import type { EffectVoiceChange } from '@vkontakte/calls-audio-effects';
 import type * as Vmoji from '@vkontakte/calls-vmoji';
-import BaseApi from './abstract/BaseApi';
 import BaseLogger from './abstract/BaseLogger';
-import BaseSignaling, { AddParticipantParams } from './abstract/BaseSignaling';
+import { AddParticipantParams } from './abstract/BaseSignaling';
 import HangupReason, { HangupReasonData } from './classes/HangupReason';
 import { MediaTrackKind } from './classes/MediaSource';
 import { AudienceModeHandsResponse } from './types/AudienceMode';
@@ -48,7 +48,7 @@ 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 { IApiEnv } from './types/Params';
-import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantStateMapped } from './types/Participant';
+import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantsStateList, ParticipantStateMapped } from './types/Participant';
 import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
 import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
 import ParticipantPriority from './types/ParticipantPriority';
@@ -63,6 +63,7 @@ import { ArrayDequeue } from './utils/ArrayDequeue';
 import { ApiExternal } from './default/ApiExternal';
 import AuthData from './static/AuthData';
 import { VmojiError } from './types/Vmoji';
+import { VolumeDetector } from './classes/VolumeDetector';
 /**
  * Информация о текущем браузере
  */
@@ -193,22 +194,26 @@ export declare const utils: {
      */
     participantMarkerCompare: typeof Utils.participantMarkerCompare;
 };
-export declare function setApi(api: BaseApi): void;
-export declare function setSignalingFactory(signalingFactory: () => BaseSignaling): void;
 export declare function setLogger(logger: BaseLogger): void;
 /**
- * Устанавливает библиотеку эффектов
+ * Устанавливает библиотеку видео эффектов
  *
  * @param effects Экземпляр класса `VideoEffects` из `@vkontakte/calls-video-effects`
  */
 export declare function setVideoEffects(effects: VideoEffects): void;
+/**
+ * Устанавливает библиотеку аудио эффектов
+ *
+ * @param effects Экземпляр класса `EffectVoiceChange` из `@vkontakte/calls-audio-effects`
+ */
+export declare function setAudioEffects(effects: EffectVoiceChange): void;
 /**
  * Устанавливает библиотеку вимоджи
  *
  * @param vmoji Экземпляр класса `Vmoji` из `@vkontakte/calls-vmoji`
- * @param sdk Экземпляр модуля `@vkontakte/calls-vmoji`, нужен для проброски дебаг сообщений
+ * @param sdk Экземпляр модуля `@vkontakte/calls-sdk`, нужен для проброски дебаг сообщений
  */
-export declare function setVmoji(vmoji: typeof Vmoji, sdk?: Parameters<typeof Vmoji.setSDK>[0] | null, renderingOptions?: Vmoji.RenderingOptions | null): void;
+export declare function setVmoji(vmoji: typeof Vmoji, sdk?: Parameters<typeof Vmoji.setSDK>[0] | null, renderingOptions?: Partial<Vmoji.RenderingOptions>, protocolVersion?: Vmoji.AnimojiVersion): void;
 /**
  * Инициализирует библиотеку
  *
@@ -368,8 +373,13 @@ export declare function changePriorities(priorities: ParticipantPriority[]): Pro
  * Изменяет состояния пользователя в звонке (например, "поднять руку" или "отошёл")
  *
  * @param state Список состояний в виде ключ-значение. Максимальная длина ключей и значений - 5 символов. Пустые значения будут пропущены
+ * @param externalId Внешний ID пользователя
+ */
+export declare function changeParticipantState(state: Record<string, string>, externalId?: ExternalId): Promise<void>;
+/**
+ * Принудительно опустить руки участников в текущем сессионном зале админа
  */
-export declare function changeParticipantState(state: Record<string, string>): Promise<void>;
+export declare function putHandsDown(): Promise<void>;
 /**
  * Изменяет лейаут.
  * Также сообщает серверу каких участников звонка стримить на этот клиент
@@ -413,6 +423,13 @@ export declare function setMediaModifiers(mediaModifiers: MediaModifiers): Promi
  * @param enabled true - включить, false - отключить
  */
 export declare function enableVideoSuspend(enabled: boolean): Promise<void>;
+/**
+ * Режим, при котором будет предложено включить автоматическое
+ * отключение приёма видео в условиях плохого соединения
+ *
+ * @param enabled true - включить, false - отключить
+ */
+export declare function enableVideoSuspendSuggest(enabled: boolean): Promise<void>;
 /**
  * Включить/выключить опции звонка
  *
@@ -504,7 +521,7 @@ export declare function forceRelayPolicy(enabled: boolean): void;
  * @param groupId
  * @param roomId
  */
-export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null, externalAccessKey?: string | null): Promise<undefined>;
+export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null): Promise<undefined>;
 /**
  * Завершить трансляцию звонка
  * @param roomId
@@ -595,12 +612,23 @@ export declare function debug(enabled: boolean): void;
  * @param args
  */
 export declare function debugMessage(type: DebugMessageType, ...args: any[]): void;
+/**
+ * Отправляет клиенские логи по conversationId на сервер OK
+ * @example можно посмотреть в examples/anonym/index.html
+ */
+export declare function uploadDebugLogs(): Promise<void>;
 /**
  * Эффект локального видео
  *
  * @param effect
  */
 export declare function changeVideoEffect(effect: IEffect | null): Promise<void>;
+/**
+ * Эффект локального аудио
+ *
+ * @param effect
+ */
+export declare function changeAudioEffect(effects: string[], isPreset?: boolean): Promise<void>;
 /**
  * Позволяет установить кастомный стрим для аудио
  *
@@ -619,6 +647,12 @@ export declare function setAudioStream(stream: MediaStream): Promise<void>;
  * нужен только в случае присвоения участнику чужого аватара
  */
 export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalId | null, customKey?: string | null): Promise<void>;
+/**
+ * Позволяет установить цвет фона собственного vmoji
+ *
+ * @param {(RGBTuple|string)} fill - цвет в виде rgb-кортежа или hex-кода
+ */
+export declare function setVmojiFill(fill: Vmoji.RGBTuple | string): void;
 /**
  * Получить состояние зала ожидания
  *
@@ -638,7 +672,7 @@ export declare function getAudienceModeHands(): Promise<AudienceModeHandsRespons
  * @param externalId Внешний ID пользователя
  * @param demote Запретить вход/отобрать права спикера
  */
-export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
+export declare function promoteParticipant(externalId?: ExternalId, demote?: boolean): Promise<void>;
 /**
  * Запросить/отозвать запрос на получение права стать спикером в комнате в
  * режиме Audience
@@ -656,6 +690,14 @@ export declare function getParticipantListChunk(participantListChunkParameters:
 export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
 export declare function feedback(key: string): Promise<SignalingMessage>;
 export declare function userFeedbackStats(userResponse: number, reason?: string, groupCallUsersCount?: number): void;
+/**
+ * Логирует клиентское событие статистики
+ *
+ * @param eventType Тип события
+ * @param eventData Дополнительные данные события
+ * @param immediatelty Отправить ли событие немедленно
+ */
+export declare function logClientEvent(eventType: string, eventData?: Record<string, string | number | boolean>, immediately?: boolean): void;
 export declare function enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<void>;
 /**
  * Удаляет записи истории звонков
@@ -682,5 +724,5 @@ export declare function sendTestCommand(name: string, params?: any): void;
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, 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, VmojiError, };
-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, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, 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, VmojiError, };
+export { Api, AuthData, BaseLogger, 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, VolumeDetector, };

package/abstract/BaseApi.d.ts

@@ -8,6 +8,13 @@ export type ClientStats = {
     vcid: ConversationData['id'] | null;
     [k: string]: string | number | null;
 };
+export type ClientEvent = {
+    timestamp: number;
+    call_topology: 'D' | 'S';
+    event_type: string;
+    vcid: ConversationData['id'] | null;
+    [k: string]: string | number | boolean | null;
+};
 export type LogItem = {
     count?: number;
     custom: ClientStats;
@@ -21,7 +28,6 @@ export type LogItem = {
     uid: OkUserId | null;
 };
 export default abstract class BaseApi {
-    abstract init(): void;
     abstract authorize(): Promise<void>;
     abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
     abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
@@ -52,6 +58,11 @@ export default abstract class BaseApi {
      * method: vchat.clientStats
      */
     logClientStats(items: ClientStats[]): void;
+    /**
+     * method: vchat.clientEvents
+     */
+    logClientEvents(items: ClientEvent[]): void;
+    abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
     abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
     abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
     abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
@@ -64,5 +75,6 @@ export default abstract class BaseApi {
     hangupConversation(conversationId: string): void;
     sendUserFeedbackStats(conversationId: string, userResponse: number, reason?: string, groupCallUsersCount?: number): void;
     removeHistoryRecords(recordIds: number[]): Promise<void>;
+    getServerTime(): Promise<number>;
     cleanup(): void;
 }

package/abstract/BaseSignaling.d.ts

@@ -26,12 +26,19 @@ import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
  * Параметры добавления пользователя в звонок
  */
 export interface AddParticipantParams {
+    /**
+     * @deprecated
+     */
     showChatHistory?: boolean;
     ttChat?: boolean;
     /**
      * Удалить юзера из бан-листа. Доступно только админу звонка
      */
     unban?: boolean;
+    /**
+     * JSON.stringify({show_chat_history: boolean})
+     */
+    payload?: string;
 }
 /**
  * Should trigger SignalingEvent.NOTIFICATION on notification message and SignalingEvent.FAILED on error
@@ -43,12 +50,11 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract close(): void;
     abstract hangup(reason: string): Promise<SignalingMessage | void>;
     abstract acceptCall(mediaSettings: MediaSettings): Promise<SignalingMessage>;
-    abstract sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit): Promise<SignalingMessage>;
+    abstract sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit, extraPayload?: Record<string, any>): Promise<SignalingMessage>;
     abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidate): Promise<SignalingMessage>;
     abstract changeMediaSettings(mediaSettings: MediaSettings): Promise<SignalingMessage>;
-    abstract changeParticipantState(state: {
-        [key: string]: string;
-    }): Promise<SignalingMessage>;
+    abstract changeParticipantState(state: Record<string, string>, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
+    abstract putHandsDown(): Promise<SignalingMessage>;
     abstract addParticipant(participantId: CompositeUserId, params?: AddParticipantParams): Promise<SignalingMessage>;
     abstract removeParticipant(participantId: CompositeUserId, ban?: boolean): Promise<SignalingMessage>;
     abstract allocateConsumer(description: RTCSessionDescription | null, capabilities: {
@@ -92,11 +98,12 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract pinParticipant(participantId: ParticipantId, unpin: boolean, roomId: number | null): Promise<SignalingMessage>;
     abstract updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
     abstract enableVideoSuspend(enabled: boolean): Promise<SignalingMessage>;
+    abstract enableVideoSuspendSuggest(enabled: boolean): Promise<SignalingMessage>;
     abstract changeOptions(changes: {
         [key in ConversationOption]?: boolean;
     }): Promise<SignalingMessage>;
     abstract getWaitingHall(fromId: SignalingMessage.WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
-    abstract promoteParticipant(participantId: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
+    abstract promoteParticipant(participantId?: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
     abstract requestPromotion(unrequest: boolean): Promise<SignalingMessage>;
     abstract acceptPromotion(reject: boolean): Promise<SignalingMessage>;
     abstract feedback(key: string): Promise<SignalingMessage>;
@@ -106,6 +113,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract useCommandDataChannel(status: boolean): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<GetParticipantsSignalingResponse>;
+    abstract getPeerId(): number | null;
     abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
     abstract stopAsr(params?: IAsrStopParams): Promise<SignalingMessage>;
     abstract requestAsr(request: boolean): Promise<SignalingMessage>;