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

package/types/MovieShare.d.ts

@@ -1,18 +1,52 @@
 import LiveStatus from '../enums/LiveStatus';
-import { OkUserId, CompositeUserId } from './Participant';
+import { CompositeUserId } from './Participant';
 import { MediaType } from './ParticipantStreamDescription';
+/**
+ * Preview изображения ролика
+ */
 export interface IMoviePreview {
+    /**
+     * Ссылка на изображение
+     */
     url: string;
+    /**
+     * Ширина изображения
+     */
     width: number;
+    /**
+     * Высота изображения
+     */
     height: number;
 }
+/**
+ * MetaData ролика
+ */
+export interface IMovieMetaData {
+    /**
+     * Название ролика
+     */
+    title?: string;
+    /**
+     * Список Preview
+     */
+    thumbnails?: IMoviePreview[];
+}
+/**
+ * Параметры для добавления ролика в Совместный Просмотр
+ */
 export interface IAddMovieParams {
-    movieId: string;
+    /**
+     * ID  Ролика
+     */
+    movieId: number;
+    /**
+     * Начальная громкость
+     */
     gain?: number;
-    metadata?: {
-        title?: string;
-        thumbnails?: IMoviePreview[];
-    };
+    /**
+     * MetaData ролика
+     */
+    metadata?: IMovieMetaData;
 }
 export declare type ISharedMovieStateResponse = [
     number,
@@ -23,38 +57,133 @@ export declare type ISharedMovieStateResponse = [
     number,
     number
 ];
+/**
+ * Состояние проигрываемого ролика
+ */
 export interface ISharedMovieState {
+    /**
+     * ID Инициатора совместного просмотра
+     * @hidden
+     */
     participantId: CompositeUserId;
+    /**
+     * Громкость
+     */
     gain?: number;
+    /**
+     * Находится ли в состоянии паузы
+     */
     pause?: boolean;
+    /**
+     * Время прошедшее с начала ролика (сек)
+     */
     offset?: number;
+    /**
+     * Находится ли в стостоянии временного мьюта звука
+     */
     mute?: boolean;
+    /**
+     * Состояние лайва
+     * @hidden
+     */
     liveStatus?: LiveStatus;
+    /**
+     * Время до начала трансляции
+     * @hidden
+     */
     startTimeMs: number;
 }
+/**
+ * Параментры для обновления состояния ролика
+ */
 export interface IUpdateMovieData {
-    movieId: string;
+    /**
+     * Id ролика
+     */
+    movieId: number;
+    /**
+     * Громкость
+     */
     gain?: number;
+    /**
+     * Поставить на паузу / снять с паузы
+     */
     pause?: boolean;
+    /**
+     * Перемотать на n секунд
+     */
     offset?: number;
+    /**
+     * Временно отключить звук / включить звук в предыдущее состояние
+     */
     mute?: boolean;
 }
+/**
+ * Информация по добавленному ролику в Совместный просмотр
+ */
 export interface ISharedMovieInfo {
-    movieId: OkUserId;
+    /**
+     * Id ролика
+     */
+    movieId: number;
+    /**
+     * Id инициатора совсместного просмотра
+     * @hidden
+     */
     initiatorId: CompositeUserId;
+    /**
+     * Название ролика
+     */
     title: string;
+    /**
+     * Тип ролика (на данный момент STREAM или MOVIE)
+     */
     source: MediaType;
+    /**
+     * Внешний Id ролика
+     */
     externalMovieId: string;
+    /**
+     * Продолжительность ролика в секундах
+     */
     duration: number;
+    /**
+     * Массив Preview
+     */
     thumbnails: IMoviePreview[];
 }
+/**
+ * Информация по удоленному из Совместного Просмотра ролику
+ */
 export interface ISharedMovieStoppedInfo {
-    movieId: OkUserId;
+    /**
+     * Id ролика
+     */
+    movieId: number;
+    /**
+     * Id инициатора совсместного просмотра
+     * @hidden
+     */
     initiatorId: CompositeUserId;
+    /**
+     * Тип ролика (на данный момент STREAM или MOVIE)
+     */
     source: MediaType;
 }
+/**
+ * Информация по пришедшему стриму ролика в Совместном просмотре
+ */
 export interface IOnRemoteMovieData {
+    /**
+     * Id стрима
+     */
     streamName: string;
+    /**
+     * Стрим
+     */
     stream: MediaStream | null;
+    /**
+     * Тип ролика (на данный момент STREAM или MOVIE)
+     */
     mediaType: MediaType;
 }

package/types/MuteStates.d.ts

@@ -1,5 +1,7 @@
 import MediaOption from '../enums/MediaOption';
 import MuteState from '../enums/MuteState';
+import { ExternalParticipantId } from './ExternalId';
+import { OkUserId } from './Participant';
 /**
  * Состояние устройств пользователя установленное админом звонка
  */
@@ -7,3 +9,16 @@ declare type MuteStates = {
     [key in MediaOption]?: MuteState;
 };
 export default MuteStates;
+export interface IMuteParticipantParams {
+    externalId?: string | ExternalParticipantId | null;
+    muteStates: MuteStates;
+    requestedMedia?: MediaOption[];
+    roomId?: number | null;
+}
+export interface IMuteParticipantInternalParams {
+    uid: OkUserId | null;
+    muteStates: MuteStates;
+    requestedMedia: MediaOption[];
+    deviceIdx: number;
+    roomId: number | null;
+}

package/types/Participant.d.ts

@@ -57,6 +57,7 @@ export interface Participant {
     observedIds: CompositeUserId[];
     markers?: ExternalParticipantListMarkers;
     movieShareInfos?: ISharedMovieInfo[];
+    isInRoom?: boolean;
 }
 export interface IGetParticipantsParameters {
     externalIds: ExternalId[];

package/types/ParticipantListChunk.d.ts

@@ -11,5 +11,5 @@ export interface ParticipantListChunkParameters {
     /** If true then resulting chunk will start from Participant with specified marker, if such Participant (still) exists */
     includeMarker?: boolean;
     /** optional, id of the room to get chunk for, main call if unspecified */
-    roomId?: number;
+    roomId?: number | null;
 }

package/types/Room.d.ts

@@ -1,5 +1,6 @@
-import { ExternalParticipantId, ExternalParticipantListChunk } from './ExternalId';
-import { Participant, ParticipantListMarkers } from './Participant';
+import { ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk } from './ExternalId';
+import MuteStates from './MuteStates';
+import { ParticipantListMarkers } from './Participant';
 export interface Room {
     id: number;
     /**
@@ -32,13 +33,28 @@ export interface Room {
      * if this room is active (read/write, optional)
      */
     active?: boolean;
+    /**
+     * global (room-wide) mute state, if any
+     */
+    muteStates?: MuteStates;
+}
+/**
+ * Initial rooms state
+ */
+export interface Rooms {
+    rooms: Room[];
+    /**
+     * current room id of participant. if undefined then the participant is in the main call
+     */
+    roomId?: number;
 }
 export interface RoomsUpdate {
     rooms?: Room[];
     roomIds?: number[];
+    deactivated?: boolean;
 }
 export interface RoomParticipantUpdate {
-    roomId: number;
+    roomId: number | null;
     /**
      * total number of participants in the room
      */
@@ -51,10 +67,11 @@ export interface RoomParticipantUpdate {
     /**
      * optional, data for added participants
      */
-    addedParticipants?: Participant[];
+    addedParticipants?: ExternalParticipant[];
     /**
      * optional, depending on the context may contain either markers
      * for all (sorted) lists available or be empty (if client fails to support chunked participants)
      */
-    removedParticipantMarkers?: ParticipantListMarkers;
+    removedParticipantMarkers?: ParticipantListMarkers[];
+    removedParticipantIds?: ExternalParticipantId[];
 }

package/types/SignalingMessage.d.ts

@@ -10,7 +10,6 @@ import UserRole from '../enums/UserRole';
 import UserType from '../enums/UserType';
 import { IFeaturesPerRole } from './ConversationFeature';
 import { IFeedback } from './Feedback';
-import { AsrInfo } from './Asr';
 import MediaModifiers from './MediaModifiers';
 import MediaSettings from './MediaSettings';
 import { ISharedMovieInfo, ISharedMovieState, ISharedMovieStoppedInfo } from './MovieShare';
@@ -77,7 +76,7 @@ declare namespace SignalingMessage {
         features: ConversationFeature[];
         multichatId: string | null;
         tamtamMultichatId: string | null;
-        recordInfo: RecordInfo | null;
+        recordInfo?: RecordInfo;
         featuresPerRole?: IFeaturesPerRole | null;
         pinnedParticipantId: ParticipantId | null;
         options: ConversationOption[];
@@ -92,6 +91,10 @@ declare namespace SignalingMessage {
         removeParticipantIds?: CompositeUserId[];
         participants?: ParticipantListChunk;
         active?: boolean;
+        countdownSec?: number;
+        timeoutMs?: number;
+        muteStates?: MuteStates;
+        recordInfo?: RecordInfo;
     }
     interface Notification extends SignalingMessage {
         type?: string;
@@ -169,6 +172,7 @@ declare namespace SignalingMessage {
         stateUpdated?: boolean;
         unmute?: boolean;
         muteAll?: boolean;
+        roomId?: number;
     }
     export interface PinParticipant extends Notification {
         participantId: ParticipantId;
@@ -303,6 +307,7 @@ declare namespace SignalingMessage {
     }
     export interface Feedback extends Notification {
         feedback: IFeedback[];
+        roomId?: number;
     }
     export interface SharedMovieState extends Notification {
         data: ISharedMovieState[];
@@ -316,6 +321,7 @@ declare namespace SignalingMessage {
         updates: Partial<Record<RoomsEventType, {
             rooms?: Room;
             roomIds?: number[];
+            deactivated?: boolean;
         }>>;
     }
     export interface RoomUpdated extends Notification {
@@ -323,23 +329,22 @@ declare namespace SignalingMessage {
         room?: Room;
         roomId: number;
         deactivate?: boolean;
+        muteStates?: MuteStates;
+        recordInfo?: RecordInfo;
     }
     export interface RoomParticipantsUpdated extends Notification {
-        roomId: number;
+        roomId?: number;
         participantCount: number;
         addedParticipantIds?: CompositeUserId[];
         addedParticipants?: Participant[];
-        removedParticipantMarkers?: ParticipantListMarkers;
+        removedParticipantMarkers?: ParticipantListMarkers[];
+    }
+    export interface GetRooms extends Notification {
+        rooms: Room[];
     }
     export interface FeaturesPerRoleChanged extends Notification {
         featuresPerRole?: IFeaturesPerRole | null;
     }
-    export interface AsrStarted extends Notification {
-        asrInfo: AsrInfo;
-    }
-    export interface AsrStopped extends Notification {
-        movieId: number;
-    }
     export {};
 }
 export default SignalingMessage;

package/types/Streams.d.ts

@@ -0,0 +1,11 @@
+export interface IStartStreamData {
+    movieId: string | null;
+    name: string | null;
+    privacy: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK';
+    groupId: string | null;
+    roomId: number | null;
+    streamMovie: boolean;
+}
+export interface IStopStreamData {
+    roomId: number | null;
+}