@vkontakte/calls-sdk 2.8.6-dev.41ce7d89.0 → 2.8.6-dev.4240fc69.0

package/CallsSDK.d.ts

@@ -47,8 +47,8 @@ import MediaModifiers from './types/MediaModifiers';
 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, ParticipantsStateList, ParticipantStateMapped } from './types/Participant';
+import { IAPIBaseUrl, IApiEnv } from './types/Params';
+import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantsStateList, ParticipantStateMapped, ParticipantStateData, ParticipantStateDataKey, ParticipantStateDataValue } from './types/Participant';
 import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
 import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
 import ParticipantPriority from './types/ParticipantPriority';
@@ -64,6 +64,7 @@ import { ApiExternal } from './default/ApiExternal';
 import AuthData from './static/AuthData';
 import { VmojiError } from './types/Vmoji';
 import { VolumeDetector } from './classes/VolumeDetector';
+import { FastStartHandler, FastStartParams } from './types/FastStart';
 /**
  * Информация о текущем браузере
  */
@@ -233,9 +234,10 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
  * @param joiningAllowed Создать токен комнаты для подключения по ссылке
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
  * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
+ * @param onFastStart Функция для обработки быстрого старта
  */
-export declare function callTo(externalId?: ExternalId | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
-export declare function callInternal(ids: OkUserId[], type: CallType | undefined, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
+export declare function callTo(externalId?: ExternalId | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean, onFastStart?: FastStartHandler): Promise<ConversationData>;
+export declare function callInternal(ids: OkUserId[], type: CallType | undefined, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean, externalIds?: ExternalId[], onFastStart?: FastStartHandler): Promise<ConversationData>;
 /**
  * Обработать пуш о входящем звонке
  *
@@ -245,15 +247,17 @@ export declare function callInternal(ids: OkUserId[], type: CallType | undefined
  * `acceptCall` и `declineCall` будут работать только после вызова `processPush`
  *
  * @param conversationId ID звонка
+ * @param conversationParams conversationParams в base64
  */
-export declare function processPush(conversationId: string): Promise<void>;
-export declare function processPushInternal(conversationId: string, type?: UserType, peerId?: number): Promise<void>;
+export declare function processPush(conversationId: string, conversationParams?: string): Promise<void>;
+export declare function processPushInternal(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number): Promise<void>;
 /**
  * Авторизоваться для совершения звонков
  *
  * @param authToken Токен авторизации
+ * @param apiBaseUrl Базовый адрес для API. Если не передан, то не меняет установленный
  */
-export declare function authorize(authToken?: string): Promise<void>;
+export declare function authorize(authToken?: string, apiBaseUrl?: IAPIBaseUrl): Promise<void>;
 /**
  * Принять входящий звонок
  *
@@ -293,6 +297,11 @@ export declare function hangup(): Promise<void>;
  * @param params Параметры
  */
 export declare function addParticipant(externalIds: ExternalId | ExternalId[], params?: AddParticipantParams): Promise<void>;
+/**
+ * @deprecated - используйте addParticipant
+ * @param uids
+ * @param params
+ */
 export declare function addParticipantInternal(uids: OkUserId[], params?: AddParticipantParams): Promise<void>;
 /**
  * Удалить собеседника из звонка
@@ -301,6 +310,11 @@ export declare function addParticipantInternal(uids: OkUserId[], params?: AddPar
  * @param ban Забанить пользователя
  */
 export declare function removeParticipant(externalId: ExternalId, ban?: boolean): Promise<void>;
+/**
+ * @deprecated - используйте removeParticipant
+ * @param uid
+ * @param ban
+ */
 export declare function removeParticipantInternal(uid: OkUserId, ban?: boolean): Promise<void>;
 /**
  * Изменить камеру на фронтальную или заднюю (для мобильных устройств)
@@ -375,7 +389,7 @@ 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: ParticipantStateData, externalId?: ExternalId): Promise<void>;
 /**
  * Принудительно опустить руки участников в текущем сессионном зале админа
  */
@@ -399,8 +413,8 @@ export declare function grantRolesInternal(uid: OkUserId, deviceIdx: number, rol
 /**
  * Выключить или выключить микрофон и/или камеру собеседнику (только если есть соответствующая роль)
  */
-export declare function muteParticipant({ externalId, muteStates, requestedMedia, roomId, }: IMuteParticipantParams): Promise<void>;
-export declare function muteParticipantInternal({ uid, muteStates, requestedMedia, deviceIdx, roomId, }: IMuteParticipantInternalParams): Promise<void>;
+export declare function muteParticipant({ externalId, muteStates, requestedMedia, roomId }: IMuteParticipantParams): Promise<void>;
+export declare function muteParticipantInternal({ uid, muteStates, requestedMedia, deviceIdx, roomId }: IMuteParticipantInternalParams): Promise<void>;
 /**
  * Закрепить/открепить выбранного собеседника у всех (только если есть соответствующая роль)
  *
@@ -480,7 +494,7 @@ export declare function startConversation(payload?: string, requireAuthToJoin?:
  * @param speakerIds Список внешних ID пользователей, которые будут выступать в роли спикеров
  * @returns Токен комнаты
  */
-export declare function startAudienceConversation(payload: string | undefined, requireAuthToJoin: boolean | undefined, { onlyAdminCanShareMovie, audioOnly, }: {
+export declare function startAudienceConversation(payload: string | undefined, requireAuthToJoin: boolean | undefined, { onlyAdminCanShareMovie, audioOnly }: {
     onlyAdminCanShareMovie?: boolean | undefined;
     audioOnly?: boolean | undefined;
 } | undefined, speakerIds: ExternalUserId[]): Promise<string>;
@@ -525,8 +539,9 @@ export declare function startStream(isRecord?: boolean, name?: string | null, mo
 /**
  * Завершить трансляцию звонка
  * @param roomId
+ * @param remove не сохранять запись звонка
  */
-export declare function stopStream(roomId?: number | null): Promise<undefined>;
+export declare function stopStream(roomId?: number | null, remove?: boolean): Promise<undefined>;
 /**
  * Опубликовать трансляцию звонка
  * @param roomId
@@ -720,9 +735,11 @@ export declare function requestAsr(request: boolean): Promise<void>;
 export declare function startUrlSharing(sharedUrl: string): Promise<void>;
 export declare function stopUrlSharing(): Promise<void>;
 export declare function sendTestCommand(name: string, params?: any): void;
+export declare function startAnalyzingAudio(expectAudio: boolean): void;
+export declare function stopAnalyzingAudio(): void;
 /**
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, 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, };
+export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAPIBaseUrl, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, ParticipantStateData, ParticipantStateDataKey, 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, FastStartHandler, FastStartParams, };
+export { Api, AuthData, BaseLogger, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStateDataValue, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, ApiExternal, VolumeDetector, };

package/abstract/BaseApi.d.ts

@@ -30,6 +30,7 @@ export type LogItem = {
 export default abstract class BaseApi {
     abstract authorize(): Promise<void>;
     abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
+    abstract deviceId(): string;
     abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
         onlyAdminCanShareMovie?: boolean;
         audienceMode?: boolean;
@@ -37,7 +38,7 @@ export default abstract class BaseApi {
     }, speakerIds?: OkUserId[]): Promise<ConversationResponse>;
     abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, createConversationParameters?: {
         onlyAdminCanShareMovie?: boolean;
-    }): Promise<ConversationResponse>;
+    }, externalIds?: ExternalId[]): Promise<ConversationResponse>;
     abstract joinConversation(conversationId: string, isVideo?: boolean, chatId?: string): Promise<ConversationResponse>;
     createJoinLink(conversationId: string): Promise<{
         join_link: string;

package/abstract/BaseSignaling.d.ts

@@ -16,10 +16,11 @@ 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 { 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, IRecordConfData, IStartStreamData, IStopStreamData } from '../types/Streams';
 import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 /**
@@ -53,9 +54,10 @@ export default abstract class BaseSignaling extends EventEmitter {
     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: Record<string, string>, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
+    abstract changeParticipantState(state: ParticipantStateData, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
     abstract putHandsDown(): Promise<SignalingMessage>;
-    abstract addParticipant(participantIds: CompositeUserId[], params?: AddParticipantParams): 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: {
         [key: string]: number | boolean | string;
@@ -99,6 +101,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     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>;
@@ -121,6 +124,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     setParticipantIdRegistry(participantIdRegistry: ParticipantIdRegistry): void;
     requestRealloc(): void;
     setEndpoint(endpoint: string): void;
+    setWebTransportEndpoint(endpoint: string | null): void;
     setConversationId(conversationId: string): void;
     readyToSend(isReady?: boolean): void;
     cleanup(): void;