@vkontakte/calls-sdk 2.8.2-dev.6ab2bbe.0 → 2.8.2-dev.769c043.0

package/CallsSDK.d.ts

@@ -33,7 +33,7 @@ import { JSONArray, JSONObject, JSONType } from './static/Json';
 import { ParamsObject } from './static/Params';
 import Utils from './static/Utils';
 import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
-import { IAsrStartParams } from './types/Asr';
+import { IAsrStartParams, IAsrStopParams, IAsrData } from './types/Asr';
 import ConversationParams from './types/ConversationParams';
 import ConversationResponse from './types/ConversationResponse';
 import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers, ExternalUserId } from './types/ExternalId';
@@ -46,7 +46,7 @@ import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/
 import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
 import ParticipantPriority from './types/ParticipantPriority';
 import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
-import { Room, RoomsUpdate, RoomParticipantUpdate, Rooms } from './types/Room';
+import { Room, RoomsUpdate, RoomParticipantUpdate, Rooms, IRoomId } from './types/Room';
 import RoomsEventType from './enums/RoomsEventType';
 import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
 import SignalingMessage from './types/SignalingMessage';
@@ -225,7 +225,7 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
  * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
  */
 export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
-export declare function callInternal(ids: OkUserId[], type: CallType, 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>;
 /**
  * Обработать пуш о входящем звонке
  *
@@ -356,6 +356,7 @@ export declare function setLocalResolution(resolution: {
  * Отрицательный приоритет выключит видео.
  *
  * @param priorities Список приоритетов
+ * @deprecated Use updateDisplayLayout instead
  */
 export declare function changePriorities(priorities: ParticipantPriority[]): Promise<void>;
 /**
@@ -443,8 +444,20 @@ export declare function customDataInternal(data: JSONObject, uid?: OkUserId | nu
  * @returns Токен комнаты
  */
 export declare function startConversation(payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie }?: {
-    onlyAdminCanShareMovie?: boolean;
+    onlyAdminCanShareMovie?: boolean | undefined;
 }): Promise<string>;
+/**
+ * Создать токен комнаты в режиме Audience для подключения по ссылке
+ *
+ * @param payload Дополнительные данные для передачи на сервер
+ * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
+ * @param startConversationParameters  Дополнительные параметры для создания звонка (например onlyAdminCanShareMovie)
+ * @param speakerIds Список внешних ID пользователей, которые будут выступать в роли спикеров
+ * @returns Токен комнаты
+ */
+export declare function startAudienceConversation(payload: string | undefined, requireAuthToJoin: boolean | undefined, { onlyAdminCanShareMovie, }: {
+    onlyAdminCanShareMovie?: boolean | undefined;
+} | undefined, speakerIds: ExternalUserId[]): Promise<string>;
 /**
  * Создать токен комнаты для подключения по ссылке к существующему звонку
  *
@@ -482,12 +495,12 @@ 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<never>;
+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
  */
-export declare function stopStream(roomId?: number | null): Promise<never>;
+export declare function stopStream(roomId?: number | null): Promise<undefined>;
 /**
  * Устанавливает роль участника в запись звонка
  * Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
@@ -604,12 +617,26 @@ export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: Exte
  */
 export declare function getWaitingHall(pageMarker?: string | null, count?: number, backward?: boolean): Promise<WaitingHallResponse>;
 /**
- * Разрешить/запретить пользователю войти из зала ожидания
+ * Разрешить/запретить пользователю войти из зала ожидания/стать спикером комнаты
+ * в режиме Audience
  *
  * @param externalId Внешний ID пользователя
- * @param demote Запретить вход
+ * @param demote Запретить вход/отобрать права спикера
  */
 export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
+/**
+ * Запросить/отозвать запрос на получение права стать спикером в комнате в
+ * режиме Audience
+ *
+ * @param demote Отозвать запрос
+ */
+export declare function requestPromotion(demote?: boolean): Promise<void>;
+/**
+ * Согласиться/отказаться стать спикером в комнате в режиме Audience.
+ *
+ * @param reject Отказаться стать спикером
+ */
+export declare function acceptPromotion(reject?: boolean): Promise<void>;
 export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<ExternalParticipantListChunk>;
 export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
 export declare function feedback(key: string): Promise<SignalingMessage>;
@@ -627,7 +654,7 @@ export declare function startAsr(params: IAsrStartParams): Promise<void>;
 /**
  * Заканчивает текстовую расшифровку звонка
  */
-export declare function stopAsr(): Promise<void>;
+export declare function stopAsr(params?: IAsrStopParams): Promise<void>;
 /**
  * Запрашивает/отключает реал-тайм расшифровку звонка
  */
@@ -636,5 +663,5 @@ export declare function requestAsr(request: boolean): Promise<void>;
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IAsrStartParams, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, 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, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, };
+export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, 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, };
 export { Api, 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, };

package/abstract/BaseApi.d.ts

@@ -2,13 +2,13 @@ import CallType from '../enums/CallType';
 import { ConversationData } from '../types/Conversation';
 import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
-import { ExternalId, ExternalUserId } from '../types/ExternalId';
+import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
 import { CompositeUserId, OkUserId } from '../types/Participant';
 export type LogItem = {
     count?: number;
     custom: {
         vcid: ConversationData['id'] | null;
-        [k: string]: string | number;
+        [k: string]: string | number | null;
     };
     data?: string[];
     groups?: string[];
@@ -25,7 +25,8 @@ export default abstract class BaseApi {
     abstract userId(participantId: CompositeUserId): Promise<ExternalId>;
     abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
         onlyAdminCanShareMovie?: boolean;
-    }): Promise<ConversationResponse>;
+        audienceMode?: boolean;
+    }, 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>;
@@ -44,7 +45,7 @@ export default abstract class BaseApi {
     log(items: LogItem[]): void;
     prepareUserIds(ids: OkUserId[]): Promise<void>;
     abstract getOkIdsByExternalIds(externalIds: (string | ExternalId)[]): Promise<OkUserId[]>;
-    abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalId[]>;
+    abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
     getCachedOkIdByExternalId(externalId: ExternalId): CompositeUserId | null;
     cacheExternalId(participantId: CompositeUserId, externalId: ExternalId): void;
     hangupConversation(conversationId: string): void;

package/abstract/BaseSignaling.d.ts

@@ -1,5 +1,6 @@
 import EventEmitter from '../classes/EventEmitter';
 import { ParticipantIdRegistry } from '../classes/ParticipantIdRegistry';
+import { StreamDescriptionString } from '../types/ParticipantStreamDescription';
 import { PerfStatReport } from '../types/PerfStatReporter';
 import { TransportTopology } from '../classes/transport/Transport';
 import ConversationFeature from '../enums/ConversationFeature';
@@ -9,7 +10,7 @@ import RecordRole from '../enums/RecordRole';
 import SignalingConnectionType from '../enums/SignalingConnectionType';
 import UserRole from '../enums/UserRole';
 import { JSONObject } from '../static/Json';
-import { IAsrStartParams } from '../types/Asr';
+import { IAsrStartParams, IAsrStopParams } from '../types/Asr';
 import ConversationResponse from '../types/ConversationResponse';
 import MediaModifiers from '../types/MediaModifiers';
 import MediaSettings from '../types/MediaSettings';
@@ -55,11 +56,14 @@ export default abstract class BaseSignaling extends EventEmitter {
         [key: string]: number | boolean | string;
     }): Promise<SignalingMessage>;
     abstract acceptProducer(description: RTCSessionDescriptionInit, ssrcs: string[]): Promise<SignalingMessage>;
+    /**
+     * @deprecated Use updateDisplayLayout instead
+     */
     abstract changePriorities(priorities: {
         [key: string]: number;
     }): Promise<SignalingMessage | void>;
     abstract updateDisplayLayout(layouts: {
-        [streamDesc: string]: ParticipantLayout | StopStream | RequestKeyFrame;
+        [streamDesc: StreamDescriptionString]: ParticipantLayout | StopStream | RequestKeyFrame;
     }): Promise<SignalingMessage | void>;
     abstract addMovie(data: IAddMovieParams): Promise<SignalingMessage>;
     abstract updateMovie(data: IUpdateMovieData): Promise<SignalingMessage>;
@@ -89,6 +93,8 @@ export default abstract class BaseSignaling extends EventEmitter {
     }): Promise<SignalingMessage>;
     abstract getWaitingHall(fromId: WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
     abstract promoteParticipant(participantId: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
+    abstract requestPromotion(demote: boolean): Promise<SignalingMessage>;
+    abstract acceptPromotion(reject: boolean): Promise<SignalingMessage>;
     abstract feedback(key: string): Promise<SignalingMessage>;
     abstract setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
     abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
@@ -97,15 +103,15 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
     abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
-    abstract stopAsr(): 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;
     setConversationId(conversationId: string): void;
-    readyToSend(): void;
+    readyToSend(isReady?: boolean): void;
     cleanup(): void;
-    requestTestMode(consumerCommand: string, producerCommand: string): void;
+    requestTestMode(consumerCommand: string, producerCommand: string | null): void;
     getNextCommandSequenceNumber(): number;
 }