@vkontakte/calls-sdk 2.8.2-dev.968ce3b.0 → 2.8.2-dev.9920ff6.0

package/CallsSDK.d.ts

@@ -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';
@@ -379,8 +379,8 @@ export declare function updateDisplayLayout(layout: ParticipantLayout[]): Promis
  * @param roles Список ролей
  * @param revoke Забрать роли
  */
-export declare function grantRoles(externalId: string | ExternalId, roles: UserRole[], revoke?: boolean): Promise<void>;
-export declare function grantRolesInternal(uid: OkUserId, roles: UserRole[], revoke?: boolean): Promise<void>;
+export declare function grantRoles(externalId: ExternalId, roles: UserRole[], revoke?: boolean): Promise<void>;
+export declare function grantRolesInternal(uid: OkUserId, deviceIdx: number, roles: UserRole[], revoke?: boolean): Promise<void>;
 /**
  * Выключить или выключить микрофон и/или камеру собеседнику (только если есть соответствующая роль)
  *
@@ -396,8 +396,9 @@ export declare function muteParticipantInternal({ uid, muteStates, requestedMedi
  *
  * @param externalId Внешний ID пользователя
  * @param unpin Открепить
+ * @param roomId Идентификатор комнаты
  */
-export declare function pinParticipant(externalId: string | ExternalParticipantId, unpin?: boolean, roomId?: number | null): Promise<void>;
+export declare function pinParticipant(externalId: ExternalId, unpin?: boolean, roomId?: number | null): Promise<void>;
 export declare function pinParticipantInternal(uid: OkUserId, unpin?: boolean, deviceIdx?: number, roomId?: number | null): Promise<void>;
 /**
  * Устанавливает настройки пользовательского медиа
@@ -433,7 +434,7 @@ export declare function chatHistory(count?: number): Promise<void>;
  * @param data Данные
  * @param externalId Внешний ID пользователя (если не указано, отправит всем)
  */
-export declare function customData(data: JSONObject, externalId?: string | ExternalParticipantId | null): Promise<void>;
+export declare function customData(data: JSONObject, externalId?: ExternalId | null): Promise<void>;
 export declare function customDataInternal(data: JSONObject, uid?: OkUserId | null, deviceIdx?: number): Promise<void>;
 /**
  * Создать токен комнаты для подключения по ссылке
@@ -446,6 +447,18 @@ export declare function customDataInternal(data: JSONObject, uid?: OkUserId | nu
 export declare function startConversation(payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie }?: {
     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>;
 /**
  * Создать токен комнаты для подключения по ссылке к существующему звонку
  *
@@ -501,7 +514,7 @@ export declare function stopStream(roomId?: number | null): Promise<undefined>;
  * @param role Роль, если null, то роль удалится
  * @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
  */
-export declare function recordSetRole(externalId: string | ExternalParticipantId, role: RecordRole | null, roomId?: number | null): Promise<void>;
+export declare function recordSetRole(externalId: ExternalId, role: RecordRole | null, roomId?: number | null): Promise<void>;
 /**
  * Получить информацию о трансляции звонка
  */
@@ -545,9 +558,9 @@ export declare function activateRooms(roomIds: number[], deactivate: boolean): P
 /**
  * Cменить сессионный зал
  * @param toRoomId
- * @param participantId
+ * @param externalId
  */
-export declare function switchRoom(toRoomId?: number | null, participantId?: string | ExternalParticipantId | null): Promise<void>;
+export declare function switchRoom(toRoomId?: number | null, externalId?: ExternalId | null): Promise<void>;
 /**
  * Удалить сессионные залы
  * @param roomIds
@@ -590,12 +603,12 @@ export declare function setAudioStream(stream: MediaStream): Promise<void>;
  *
  * @param {(string|ArrayBuffer)} svg - svg в незашифрованном (string)
  * или зашифрованном (ArrayBuffer) виде
- * @param {(ExternalParticipantId|null)} externalId - externalId внешнего участника звонка,
+ * @param {(ExternalId|null)} externalId - externalId внешнего участника звонка,
  * не требуется для текущего участника (текущего пользователя клиента)
  * @param {(string|null)} customKey - кастомный ключ расшифровки svg,
  * нужен только в случае присвоения участнику чужого аватара
  */
-export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalParticipantId | null, customKey?: string | null): Promise<void>;
+export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalId | null, customKey?: string | null): Promise<void>;
 /**
  * Получить состояние зала ожидания
  *
@@ -605,12 +618,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>;
@@ -637,5 +664,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, 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, 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,8 +2,8 @@ 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 { CompositeUserId, OkUserId } from '../types/Participant';
+import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
+import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
 export type LogItem = {
     count?: number;
     custom: {
@@ -22,10 +22,11 @@ export type LogItem = {
 export default abstract class BaseApi {
     abstract init(): void;
     abstract authorize(): Promise<void>;
-    abstract userId(participantId: CompositeUserId): Promise<ExternalId>;
+    abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
     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,9 +45,9 @@ 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[]>;
-    getCachedOkIdByExternalId(externalId: ExternalId): CompositeUserId | null;
-    cacheExternalId(participantId: CompositeUserId, externalId: ExternalId): void;
+    abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
+    getCachedOkIdByExternalId(externalId: ExternalParticipantId): CompositeUserId | null;
+    cacheExternalId(participantId: CompositeUserId, externalId: ExternalParticipantId): void;
     hangupConversation(conversationId: string): void;
     removeHistoryRecords(recordIds: number[]): Promise<void>;
     cleanup(): void;

package/abstract/BaseSignaling.d.ts

@@ -83,7 +83,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     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: CompositeUserId, roles: UserRole[], revoke: boolean): 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>;
@@ -93,11 +93,12 @@ 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;
     abstract useCommandDataChannel(status: boolean): void;
-    abstract setAsrDataChannel(dataChannel: RTCDataChannel): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
     abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;