@vkontakte/calls-sdk 2.8.13-dev.939924e7.0 → 2.8.13-dev.992d27aa.0

package/CallsSDK.d.ts

@@ -5,7 +5,7 @@ import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
 import type { EffectVoiceChange, VadControllerOptions, VadLib } from '@vkontakte/calls-audio-effects';
 import type * as Vmoji from '@vkontakte/calls-vmoji';
 import BaseLogger from './abstract/BaseLogger';
-import type { AddParticipantParams } from './types/AddParticipantParams';
+import { AddParticipantParams } from './abstract/BaseSignaling';
 import HangupReason, { HangupReasonData, CustomError } from './classes/HangupReason';
 import { MediaTrackKind } from './classes/MediaSource';
 import { AudienceModeHandsResponse } from './types/AudienceMode';

package/abstract/BaseSignaling.d.ts

@@ -0,0 +1,143 @@
+import EventEmitter from '../classes/EventEmitter';
+import { ParticipantIdRegistry } from '../classes/ParticipantIdRegistry';
+import { TCapabilities } from '../types/Capabilities';
+import { StreamDescriptionString } from '../types/ParticipantStreamDescription';
+import { PerfStatReport } from '../types/PerfStatReporter';
+import { NetworkStatReport } from '../types/NetworkStatReport';
+import TransportTopology from '../enums/TransportTopology';
+import ConversationFeature from '../enums/ConversationFeature';
+import ConversationOption from '../enums/ConversationOption';
+import MediaOption from '../enums/MediaOption';
+import SignalingConnectionType from '../enums/SignalingConnectionType';
+import UserRole from '../enums/UserRole';
+import { JSONObject } from '../static/Json';
+import { IAsrStartParams, IAsrStopParams } from '../types/Asr';
+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, ParticipantStateData } from '../types/Participant';
+import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
+import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
+import SignalingMessage, { GetParticipantsSignalingResponse, GetRoomsSignalingResponse } from '../types/SignalingMessage';
+import { ChangeSimulcast } from '../types/ChangeSimulcast';
+import { IPublishStreamData, IStartStreamData, IStopStreamData } from '../types/Streams';
+import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
+/**
+ * Параметры добавления пользователя в звонок
+ */
+export interface AddParticipantParams {
+    /**
+     * @deprecated
+     */
+    showChatHistory?: boolean;
+    ttChat?: boolean;
+    /**
+     * Удалить юзера из бан-листа. Доступно только админу звонка
+     */
+    unban?: boolean;
+    /**
+     * JSON.stringify(\{show_chat_history: boolean\})
+     */
+    payload?: string;
+}
+export declare class SignalingDisposedError extends Error {
+    constructor(command?: string);
+}
+export declare class ProducerConnectionClosedError extends Error {
+    constructor(command?: string);
+}
+/**
+ * Should trigger SignalingEvent.NOTIFICATION on notification message and SignalingEvent.FAILED on error
+ * https://wiki.odkl.ru/display/projects/Signaling+API#SignalingAPI-Notifications
+ * @hidden
+ */
+export default abstract class BaseSignaling extends EventEmitter {
+    protected _abortSignal?: AbortSignal;
+    /**
+     * Устанавливает сигнал прерывания для запуска звонка, если не успели отменить до установки соединения с другим участником, то он больше ни как не будет использоваться
+     * @param signal - Сигнал прерывания или undefined для очистки
+     */
+    setAbortSignal(signal: AbortSignal | undefined): void;
+    abstract connect(connectionType: SignalingConnectionType, conversation?: ConversationResponse): Promise<SignalingMessage.Connection>;
+    abstract dispose(cause?: Error): void;
+    abstract hangup(reason: string): Promise<SignalingMessage | void>;
+    abstract acceptCall(mediaSettings: MediaSettings): Promise<SignalingMessage>;
+    abstract sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit, extraPayload?: Record<string, any>): Promise<SignalingMessage>;
+    abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidateInit): Promise<SignalingMessage>;
+    abstract changeMediaSettings(mediaSettings: MediaSettings): Promise<SignalingMessage>;
+    abstract changeParticipantState(state: ParticipantStateData, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
+    abstract hold(hold: boolean, capabilities?: TCapabilities): Promise<SignalingMessage>;
+    abstract putHandsDown(): Promise<SignalingMessage>;
+    abstract addParticipant(externalIds: CompositeUserId[], params?: AddParticipantParams): Promise<SignalingMessage>;
+    abstract addParticipantLegacy(participantIds: CompositeUserId[], params?: AddParticipantParams): Promise<SignalingMessage>;
+    abstract removeParticipant(participantId: CompositeUserId, ban?: boolean): Promise<SignalingMessage>;
+    abstract allocateConsumer(description: RTCSessionDescription | null, capabilities: TCapabilities): Promise<SignalingMessage>;
+    abstract acceptProducer(description: RTCSessionDescriptionInit, ssrcs: string[], sessionId: string): Promise<SignalingMessage>;
+    /**
+     * @deprecated Use updateDisplayLayout instead
+     */
+    abstract changePriorities(priorities: {
+        [key: string]: number;
+    }): Promise<SignalingMessage | void>;
+    abstract updateDisplayLayout(layouts: {
+        [streamDesc: StreamDescriptionString]: ParticipantLayout | StopStream | RequestKeyFrame;
+    }): Promise<SignalingMessage | void>;
+    abstract addMovie(data: IAddMovieParams): Promise<SignalingMessage>;
+    abstract updateMovie(data: IUpdateMovieData): Promise<SignalingMessage>;
+    abstract removeMovie(data: any): Promise<SignalingMessage>;
+    abstract startUrlSharing(sharedUrl: string): Promise<SignalingMessage>;
+    abstract stopUrlSharing(): 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<GetRoomsSignalingResponse>;
+    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 getRecordStatus(): Promise<SignalingMessage>;
+    abstract switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
+    abstract reportPerfStat(report: PerfStatReport): Promise<SignalingMessage>;
+    abstract reportSharingStat(report: SharingStatReport): Promise<SignalingMessage>;
+    abstract reportNetworkStat(report: NetworkStatReport): 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: ParticipantId, 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>;
+    abstract updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
+    abstract enableVideoSuspend(enabled: boolean): Promise<SignalingMessage>;
+    abstract enableVideoSuspendSuggest(enabled: boolean): Promise<SignalingMessage>;
+    abstract changeSimulcast(changeSimulcast: ChangeSimulcast): 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 requestPromotion(unrequest: 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 resetProducerConnection(cause?: Error): 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>;
+    get ready(): boolean;
+    setParticipantIdRegistry(participantIdRegistry: ParticipantIdRegistry): void;
+    requestRealloc(): void;
+    setEndpoint(endpoint: string): void;
+    setWebTransportEndpoint(endpoint: string | null): void;
+    readyToSend(isReady?: boolean): void;
+    requestTestMode(consumerCommand: string, producerCommand: string | null): Promise<SignalingMessage | void>;
+    getNextCommandSequenceNumber(): number;
+}