@vkontakte/calls-sdk 2.8.4-dev.f8b43cb.0 → 2.8.4

package/CallsSDK.d.ts

@@ -34,7 +34,7 @@ import { ParticipantStatus } from './static/External';
 import { JSONArray, JSONObject, JSONType } from './static/Json';
 import { ParamsObject } from './static/Params';
 import Utils from './static/Utils';
-import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
+import WebRTCUtils, { BrowserName, FacingMode } from './static/WebRTCUtils';
 import { IAsrData, IAsrStartParams, IAsrStopParams } from './types/Asr';
 import { ConversationData } from './types/Conversation';
 import { IFeaturesPerRole } from './types/ConversationFeature';
@@ -55,13 +55,14 @@ import ParticipantPriority from './types/ParticipantPriority';
 import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
 import { IRoomId, Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from './types/Room';
 import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
-import SignalingMessage from './types/SignalingMessage';
+import SignalingMessage, { GetRoomsSignalingResponse, GetParticipantsSignalingResponse } from './types/SignalingMessage';
 import { StatResult } from './types/Statistics';
 import { IStartStreamData, IStopStreamData, IPublishStreamData } from './types/Streams';
 import { WaitingHallResponse } from './types/WaitingHall';
 import { ArrayDequeue } from './utils/ArrayDequeue';
 import { ApiExternal } from './default/ApiExternal';
 import AuthData from './static/AuthData';
+import { VmojiError } from './types/Vmoji';
 /**
  * Информация о текущем браузере
  */
@@ -387,11 +388,6 @@ export declare function grantRoles(externalId: ExternalId, roles: UserRole[], re
 export declare function grantRolesInternal(uid: OkUserId, deviceIdx: number, roles: UserRole[], revoke?: boolean): Promise<void>;
 /**
  * Выключить или выключить микрофон и/или камеру собеседнику (только если есть соответствующая роль)
- *
- * @param externalId Внешний ID пользователя (если не указано, сработает на всех)
- * @param muteStates Состояние устройств пользователя
- * @param requestedMedia Попросить пользователя включить устройство
- * @param roomId ID сессионного зала, либо ничего если в основном зале
  */
 export declare function muteParticipant({ externalId, muteStates, requestedMedia, roomId, }: IMuteParticipantParams): Promise<void>;
 export declare function muteParticipantInternal({ uid, muteStates, requestedMedia, deviceIdx, roomId, }: IMuteParticipantInternalParams): Promise<void>;
@@ -410,6 +406,13 @@ export declare function pinParticipantInternal(uid: OkUserId, unpin?: boolean, d
  * @param mediaModifiers
  */
 export declare function setMediaModifiers(mediaModifiers: MediaModifiers): Promise<void>;
+/**
+ * Автоматическое отключения принимаемых видео-потоков
+ * в условиях плохого соединения
+ *
+ * @param enabled true - включить, false - отключить
+ */
+export declare function enableVideoSuspend(enabled: boolean): Promise<void>;
 /**
  * Включить/выключить опции звонка
  *
@@ -501,7 +504,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): 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, externalAccessKey?: string | null): Promise<undefined>;
 /**
  * Завершить трансляцию звонка
  * @param roomId
@@ -674,9 +677,10 @@ export declare function stopAsr(params?: IAsrStopParams): Promise<void>;
 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;
 /**
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, AudienceModeHandsResponse, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, 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, };
+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, };

package/abstract/BaseApi.d.ts

@@ -4,12 +4,13 @@ import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
 import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
 import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
+export type ClientStats = {
+    vcid: ConversationData['id'] | null;
+    [k: string]: string | number | null;
+};
 export type LogItem = {
     count?: number;
-    custom: {
-        vcid: ConversationData['id'] | null;
-        [k: string]: string | number | null;
-    };
+    custom: ClientStats;
     data?: string[];
     groups?: string[];
     network?: string;
@@ -43,13 +44,23 @@ export default abstract class BaseApi {
     abstract getConversationParams(conversationId?: string): Promise<ConversationParams>;
     abstract getUserId(): OkUserId | null;
     abstract setUserId(userId: OkUserId): void;
+    /**
+     * method: log.externalLog
+     */
     log(items: LogItem[]): void;
-    prepareUserIds(ids: OkUserId[]): Promise<void>;
+    /**
+     * method: vchat.clientStats
+     */
+    logClientStats(items: ClientStats[]): void;
     abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
     abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
     abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
     getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
-    cacheExternalId(participantId: CompositeUserId, externalId: ExternalParticipantId): void;
+    cacheExternalId(compositeId: OkUserId | CompositeUserId | ParticipantId, externalId: ExternalParticipantId): void;
+    mapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId, okId: OkUserId | CompositeUserId): void;
+    unmapDecorativeId(decorativeId: OkUserId | CompositeUserId | ParticipantId): void;
+    getDecorativeIdByInitialId(okId: OkUserId | CompositeUserId | ParticipantId): OkUserId | undefined;
+    replaceByInitialIdIdIfExists(id: OkUserId | CompositeUserId | ParticipantId): OkUserId;
     hangupConversation(conversationId: string): void;
     sendUserFeedbackStats(conversationId: string, userResponse: number, reason?: string, groupCallUsersCount?: number): void;
     removeHistoryRecords(recordIds: number[]): Promise<void>;

package/abstract/BaseSignaling.d.ts

@@ -19,9 +19,8 @@ import MuteStates from '../types/MuteStates';
 import { CompositeUserId, ParticipantId } from '../types/Participant';
 import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
 import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
-import SignalingMessage from '../types/SignalingMessage';
+import SignalingMessage, { GetParticipantsSignalingResponse, GetRoomsSignalingResponse } from '../types/SignalingMessage';
 import { IPublishStreamData, IRecordConfData, IStartStreamData, IStopStreamData } from '../types/Streams';
-import { WaitingParticipantId } from '../types/WaitingHall';
 import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 /**
  * Параметры добавления пользователя в звонок
@@ -73,7 +72,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     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>;
+    abstract getRooms(withParticipants: boolean): Promise<GetRoomsSignalingResponse>;
     abstract removeRooms(roomIds: number[]): Promise<SignalingMessage>;
     abstract startStream(data: IStartStreamData): Promise<SignalingMessage>;
     abstract stopStream(data: IStopStreamData): Promise<SignalingMessage>;
@@ -92,10 +91,11 @@ export default abstract class BaseSignaling extends EventEmitter {
     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 changeOptions(changes: {
         [key in ConversationOption]?: boolean;
     }): Promise<SignalingMessage>;
-    abstract getWaitingHall(fromId: WaitingParticipantId | null, count?: number, backward?: 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>;
@@ -105,7 +105,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
     abstract useCommandDataChannel(status: boolean): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
-    abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
+    abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<GetParticipantsSignalingResponse>;
     abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
     abstract stopAsr(params?: IAsrStopParams): Promise<SignalingMessage>;
     abstract requestAsr(request: boolean): Promise<SignalingMessage>;