@vkontakte/calls-sdk 2.6.2 → 2.6.3-beta.0

package/CallsSDK.d.ts

@@ -39,8 +39,8 @@ import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId,
 import IceServer from './types/IceServer';
 import MediaModifiers from './types/MediaModifiers';
 import { IVideoDimentions, MediaSettings } from './types/MediaSettings';
-import MuteStates from './types/MuteStates';
-import { IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantStateMapped } from './types/Participant';
+import MuteStates, { IMuteParticipantInternalParams, IMuteParticipantParams } from './types/MuteStates';
+import { IGetParticipantsParameters, OkUserId, ParticipantStateMapped } from './types/Participant';
 import ParticipantLayout, { Layout, StopStream } from './types/ParticipantLayout';
 import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
 import ParticipantPriority from './types/ParticipantPriority';
@@ -51,10 +51,10 @@ import SignalingMessage from './types/SignalingMessage';
 import { WaitingHallResponse } from './types/WaitingHall';
 import { IFeedbackExternal } from './types/Feedback';
 import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData } from './types/MovieShare';
+import { IStartStreamData, IStopStreamData } from './types/Streams';
 import ConversationFeature from './enums/ConversationFeature';
 import { IFeaturesPerRole } from './types/ConversationFeature';
 import { ArrayDequeue } from './utils/ArrayDequeue';
-import { AsrInfo } from './types/Asr';
 /**
  * Информация о текущем браузере
  */
@@ -249,6 +249,8 @@ export declare function joinCallInternal(conversationId: string, mediaOptions: M
  * @param joinLink Токен комнаты
  * @param mediaOptions Нужно ли включать камеру и микрофон
  * @param anonymToken Токен анонимной авторизации
+ * @param observedIds
+ * @param payload
  */
 export declare function joinCallByLink(joinLink: string, mediaOptions?: MediaOption[], anonymToken?: string, observedIds?: ExternalUserId[], payload?: string): Promise<ConversationData>;
 /**
@@ -358,9 +360,10 @@ export declare function grantRolesInternal(uid: OkUserId, roles: UserRole[], rev
  * @param externalId Внешний ID пользователя (если не указано, сработает на всех)
  * @param muteStates Состояние устройств пользователя
  * @param requestedMedia Попросить пользователя включить устройство
+ * @param roomId ID сессионного зала, либо ничего если в основном зале
  */
-export declare function muteParticipant(externalId: string | ExternalParticipantId | null, muteStates: MuteStates, requestedMedia?: MediaOption[]): Promise<void>;
-export declare function muteParticipantInternal(uid: OkUserId | null, muteStates: MuteStates, requestedMedia?: MediaOption[], deviceIdx?: number): 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>;
 /**
  * Закрепить/открепить выбранного собеседника у всех (только если есть соответствующая роль)
  *
@@ -444,8 +447,8 @@ export declare function setVolume(volume: number): void;
  * @param enabled
  */
 export declare function forceRelayPolicy(enabled: boolean): void;
-export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null): Promise<SignalingMessage>;
-export declare function stopStream(): Promise<SignalingMessage>;
+export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null): Promise<SignalingMessage>;
+export declare function stopStream(roomId?: number | null): Promise<SignalingMessage>;
 /**
  * Устанавливает роль участника в запись звонка
  * Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
@@ -456,8 +459,9 @@ export declare function stopStream(): Promise<SignalingMessage>;
  *
  * @param externalId Внешний ID пользователя
  * @param role Роль, если null, то роль удалится
+ * @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
  */
-export declare function recordSetRole(externalId: string | ExternalParticipantId, role: RecordRole | null): Promise<void>;
+export declare function recordSetRole(externalId: string | ExternalParticipantId, role: RecordRole | null, roomId?: number | null): Promise<void>;
 export declare function getStreamInfo(): Promise<{
     movieId: any;
     preview: any;
@@ -465,10 +469,10 @@ export declare function getStreamInfo(): Promise<{
 /**
  * Добавляет видео/лайв в звонок
  *
- * @param movieId
+ * @param params
  */
 export declare function addMovie(params: IAddMovieParams): Promise<{
-    movieId: string;
+    movieId: number;
     streamType: string;
 }>;
 /**
@@ -480,13 +484,13 @@ export declare function updateMovie(params: IUpdateMovieData): Promise<void>;
 /**
  * Удалить видео/лайв из звонка
  *
- * @param movieId
+ * @param movieId Id Ролика
  */
-export declare function removeMovie(movieId: string): Promise<void>;
+export declare function removeMovie(movieId: number): Promise<void>;
 /**
- * Обновить комнаты
- * @param rooms id в случае обновления комнаты
- * @param assignRandomly рандомно назначить участников комнаты из свободных в соответствии с participantCount
+ * Обновить сессионные залы
+ * @param rooms id в случае обновления сессионного зала
+ * @param assignRandomly рандомно назначить участников залов из свободных в соответствии с participantCount
  */
 export declare function updateRooms(rooms: {
     id?: number;
@@ -495,19 +499,19 @@ export declare function updateRooms(rooms: {
     active?: boolean;
 }[], assignRandomly: boolean): Promise<void>;
 /**
- * Активировать комнаты
+ * Активировать сессионные залы
  * @param roomIds
  * @param deactivate
  */
 export declare function activateRooms(roomIds: number[], deactivate: boolean): Promise<void>;
 /**
- * Cменить комнату
+ * Cменить сессионный зал
  * @param toRoomId
  * @param participantId
  */
-export declare function switchRoom(toRoomId?: number, participantId?: ParticipantId): Promise<void>;
+export declare function switchRoom(toRoomId?: number | null, participantId?: string | ExternalParticipantId | null): Promise<void>;
 /**
- * Удалить комнаты
+ * Удалить сессионные залы
  * @param roomIds
  */
 export declare function removeRooms(roomIds: number[]): Promise<void>;
@@ -576,9 +580,13 @@ export declare function startAsr(): Promise<void>;
  * Заканчивает текстовую расшифровку звонка
  */
 export declare function stopAsr(): Promise<void>;
+/**
+ * Запрашивает/отключает реал-тайм расшифровку звонка
+ */
+export declare function requestAsr(request: boolean): Promise<void>;
 /**
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, AsrInfo, };
+export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, 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, Utils, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, };

package/abstract/BaseSignaling.d.ts

@@ -18,6 +18,7 @@ import { CompositeUserId, ParticipantId } from '../types/Participant';
 import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
 import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
 import SignalingMessage from '../types/SignalingMessage';
+import { IStartStreamData, IStopStreamData } from '../types/Streams';
 import { WaitingParticipantId } from '../types/WaitingHall';
 import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 /**
@@ -64,11 +65,12 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract removeMovie(data: any): Promise<SignalingMessage>;
     abstract updateRooms(rooms: Record<any, any>[], assignRandomly: boolean): Promise<SignalingMessage>;
     abstract activateRooms(roomIds: number[], deactivate: boolean): Promise<SignalingMessage>;
-    abstract switchRoom(toRoomId?: number, participantId?: ParticipantId): Promise<SignalingMessage>;
+    abstract switchRoom(toRoomId: number | null, participantId?: ParticipantId): Promise<SignalingMessage>;
+    abstract getRooms(withParticipants: boolean): Promise<SignalingMessage>;
     abstract removeRooms(roomIds: number[]): Promise<SignalingMessage>;
-    abstract startStream(data: any): Promise<SignalingMessage>;
-    abstract stopStream(): Promise<SignalingMessage>;
-    abstract recordSetRole(participantId: ParticipantId, role: RecordRole | null): Promise<SignalingMessage>;
+    abstract startStream(data: IStartStreamData): Promise<SignalingMessage>;
+    abstract stopStream(data: IStopStreamData): Promise<SignalingMessage>;
+    abstract recordSetRole(participantId: ParticipantId, role: RecordRole | null, roomId: number | null): Promise<SignalingMessage>;
     abstract getRecordStatus(): Promise<SignalingMessage>;
     abstract switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
     abstract reportPerfStat(report: PerfStatReport): Promise<SignalingMessage>;
@@ -77,7 +79,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     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 muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[]): 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): Promise<SignalingMessage>;
     abstract updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
@@ -90,10 +92,12 @@ export default abstract class BaseSignaling extends EventEmitter {
     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(): Promise<SignalingMessage>;
     abstract stopAsr(): Promise<SignalingMessage>;
+    abstract requestAsr(request: boolean): Promise<SignalingMessage>;
     get ready(): boolean;
     setParticipantIdRegistry(participantIdRegistry: ParticipantIdRegistry): void;
     requestRealloc(): void;