@vkontakte/calls-sdk 2.8.5-dev.f13957b5.0 → 2.8.5-dev.f6156fa6.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';
@@ -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,20 +194,24 @@ 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?: Partial<Vmoji.RenderingOptions>, protocolVersion?: Vmoji.AnimojiVersion): void;
 /**
@@ -607,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>;
 /**
  * Позволяет установить кастомный стрим для аудио
  *
@@ -656,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
@@ -709,4 +725,4 @@ export declare function sendTestCommand(name: string, params?: any): void;
  */
 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, 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, 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 { 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

@@ -28,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?: {
@@ -63,6 +62,7 @@ export default abstract class BaseApi {
      * 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[]>;
@@ -75,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
@@ -96,7 +103,7 @@ export default abstract class BaseSignaling extends EventEmitter {
         [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>;