@vkontakte/calls-sdk 2.4.4-dev.717e1c2.0 → 2.4.4-dev.71e1f68.0

package/static/Params.d.ts

@@ -7,7 +7,7 @@ import ConversationOption from '../enums/ConversationOption';
 import FatalError from '../enums/FatalError';
 import MediaOption from '../enums/MediaOption';
 import UserRole from '../enums/UserRole';
-import { ExternalId, ExternalParticipant, ExternalParticipantId } from '../types/ExternalId';
+import { ExternalId, ExternalParticipant } from '../types/ExternalId';
 import IceServer from '../types/IceServer';
 import MediaModifiers from '../types/MediaModifiers';
 import MediaSettings from '../types/MediaSettings';
@@ -220,7 +220,8 @@ export declare type ParamsObject = {
      */
     batchParticipantsOnStart: boolean;
     participantStateMapped: boolean;
-    joinFromMultipleDevices: boolean;
+    /** использовать ли список партисипантов через метод чанками, вместо `onConversation` */
+    useParticipantListChunk: boolean;
     /**
      * Получен локальный стрим с камеры/микрофона
      */
@@ -241,40 +242,40 @@ export declare type ParamsObject = {
      * Получен стрим собеседника.
      * Если сервер закончил стримить собеседника, вместо стрима будет передан null
      */
-    onRemoteStream?: (userId: ExternalParticipantId, stream: MediaStream | null) => void;
+    onRemoteStream?: (userId: ExternalId, stream: MediaStream | null) => void;
     /**
      * Получен стрим с экрана собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
      */
-    onRemoteScreenStream?: (userId: ExternalParticipantId, stream: MediaStream | null) => void;
+    onRemoteScreenStream?: (userId: ExternalId, stream: MediaStream | null) => void;
     /**
      * Получен стрим трансляция или мувик от собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
      */
-    onRemoteLive?: (userId: ExternalParticipantId, streamId: string, stream: MediaStream | null) => void;
+    onRemoteLive?: (userId: ExternalId, streamId: string, stream: MediaStream | null) => void;
     /**
      * Начат звонок
      */
-    onConversation?: (userId: ExternalParticipantId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[]) => void;
+    onConversation?: (userId: ExternalId, mediaModifiers: MediaModifiers, muteStates: MuteStates, participants?: ExternalParticipant[]) => void;
     /**
      * Изменились данные стрима собеседника
      */
-    onRemoteMediaSettings?: (userId: ExternalParticipantId, mediaSettings: MediaSettings) => void;
+    onRemoteMediaSettings?: (userId: ExternalId, mediaSettings: MediaSettings) => void;
     /**
      * Изменились данные состояний собеседника
      */
-    onRemoteParticipantState?: (userId: ExternalParticipantId, participantState: {
+    onRemoteParticipantState?: (userId: ExternalId, participantState: {
         [key: string]: string;
     }) => void;
     /**
      * Изменился статус соединения собеседников
      */
-    onRemoteStatus?: (userIds: ExternalParticipantId[], status: ParticipantStatus, data: any) => void;
+    onRemoteStatus?: (userIds: ExternalId[], status: ParticipantStatus, data: any) => void;
     /**
      * Изменился статус соединения собеседника
      * @deprecated
      */
-    onParticipantStatus?: (userId: ExternalParticipantId, status: ParticipantStatus, data: any) => void;
+    onParticipantStatus?: (userId: ExternalId, status: ParticipantStatus, data: any) => void;
     /**
      * Разрешения на доступы были запрошены в браузере
      */
@@ -286,7 +287,7 @@ export declare type ParamsObject = {
     /**
      * Пользователь отключился от звонка
      */
-    onRemoteRemoved?: (userId: ExternalParticipantId) => void;
+    onRemoteRemoved?: (userId: ExternalId) => void;
     /**
      * Изменилось состояние звонка
      */
@@ -298,11 +299,11 @@ export declare type ParamsObject = {
     /**
      * Изменились состояния устройств пользователя или разрешения включать камеру/микрофон
      */
-    onMuteStates?: (muteStates: MuteStates, unmuteOptions: MediaOption[], mediaOptions: MediaOption[], muteAll: boolean, unmute: boolean, userId: ExternalParticipantId | null, adminId: ExternalParticipantId | null) => void;
+    onMuteStates?: (muteStates: MuteStates, unmuteOptions: MediaOption[], mediaOptions: MediaOption[], muteAll: boolean, unmute: boolean, userId: ExternalId | null, adminId: ExternalId | null) => void;
     /**
      * Изменились роли собеседника в звонке
      */
-    onRolesChanged?: (userId: ExternalParticipantId, roles: UserRole[]) => void;
+    onRolesChanged?: (userId: ExternalId, roles: UserRole[]) => void;
     /**
      * Изменились свои роли в звонке
      */
@@ -310,7 +311,7 @@ export declare type ParamsObject = {
     /**
      * Закрепляет/открепляет собеседника для всех
      */
-    onPinnedParticipant?: (userId: ExternalParticipantId, unpin: boolean) => void;
+    onPinnedParticipant?: (userId: ExternalId, unpin: boolean) => void;
     /**
      * Закрепляет/открепляет текущего пользователя у других собеседников
      */
@@ -323,12 +324,12 @@ export declare type ParamsObject = {
     /**
      * Изменился говорящий в звонке
      */
-    onSpeakerChanged?: (userId: ExternalParticipantId) => void;
+    onSpeakerChanged?: (userId: ExternalId) => void;
     /**
      * Громкость собеседников
      */
     onVolumesDetected?: (volumes: {
-        uid: ExternalParticipantId;
+        uid: ExternalId;
         volume: number;
     }[]) => void;
     /**
@@ -360,15 +361,15 @@ export declare type ParamsObject = {
     /**
      * Получено сообщение чата
      */
-    onChatMessage?: (message: string, from: ExternalParticipantId, direct: boolean) => void;
+    onChatMessage?: (message: string, from: ExternalId, direct: boolean) => void;
     /**
      * Получены данные от собеседника
      */
-    onCustomData?: (data: JSONObject, from: ExternalParticipantId, direct: boolean) => void;
+    onCustomData?: (data: JSONObject, from: ExternalId, direct: boolean) => void;
     /**
      * Начата трансляция/запись звонка
      */
-    onRecordStarted?: (initiator: ExternalParticipantId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string) => void;
+    onRecordStarted?: (initiator: ExternalId, movieId: number, startTime: number, type: 'STREAM' | 'RECORD', externalMovieId?: string, externalOwnerId?: string) => void;
     /**
      * Закончена трансляция/запись звонка
      */
@@ -385,7 +386,7 @@ export declare type ParamsObject = {
      * @param status Оценки качества соединения участников от 0 до 1
      */
     onNetworkStatusChanged?: (status: {
-        uid: ExternalParticipantId;
+        uid: ExternalId;
         rating: number;
     }[]) => void;
     /**
@@ -419,7 +420,7 @@ export default abstract class Params {
     static get appVersion(): number;
     static get sdkVersion(): string | number | boolean;
     static get debug(): string | number | boolean;
-    static get protocolVersion(): 5 | 6;
+    static get protocolVersion(): number;
     static get platform(): string;
     static set platform(value: string);
     static get clientType(): string;
@@ -497,4 +498,5 @@ export default abstract class Params {
     static get filteredMessages(): boolean;
     static get batchParticipantsOnStart(): boolean;
     static get participantStateMapped(): boolean;
+    static get useParticipantListChunk(): boolean;
 }

package/static/Utils.d.ts

@@ -1,29 +1,21 @@
-import { BigInteger } from 'big-integer';
+import type { BigInteger } from 'big-integer';
 import UserType from '../enums/UserType';
 import { ExternalParticipant } from '../types/ExternalId';
-import { CompositeUserId, OkUserId, Participant, ParticipantId, ParticipantStateMapped } from '../types/Participant';
+import { CompositeUserId, OkUserId, Participant, ParticipantStateMapped } from '../types/Participant';
 import SignalingMessage from '../types/SignalingMessage';
 import VideoSettings from '../types/VideoSettings';
-export declare const PARAMETERS_SEPARATOR = ":";
-export declare const DEVICE_IDX_PARAMETER = "d";
 declare namespace Utils {
     function patchSDP(sdp: string, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, isAudioNack?: boolean): string;
     function getPeerIdString(peerId: SignalingMessage.PeerId): string;
     function comparePeerId(peerId1: SignalingMessage.PeerId, peerId2: SignalingMessage.PeerId): boolean;
     function getPeerConnectionHostInfo(pc: RTCPeerConnection): Promise<any>;
-    function composeUserId(id: CompositeUserId | OkUserId, type: UserType): CompositeUserId;
-    function composeParticipantId(id: CompositeUserId | OkUserId, type: UserType, deviceIdx: number): ParticipantId;
-    function compose(compositeId: CompositeUserId, deviceIdx: number): ParticipantId;
-    function composeId(participant: SignalingMessage.Participant): ParticipantId;
-    function composeMessageId(message: SignalingMessage): ParticipantId;
+    function composeId(id: CompositeUserId | OkUserId, type: UserType): CompositeUserId;
+    function composeParticipantId(participant: SignalingMessage.Participant): CompositeUserId;
+    function composeMessageId(message: SignalingMessage): CompositeUserId;
     function decomposeId(compositeId: CompositeUserId | OkUserId): {
         id: OkUserId;
         type: UserType;
     };
-    function decomposeParticipantId(participantId: ParticipantId): {
-        compositeUserId: CompositeUserId;
-        deviceIdx: number;
-    };
     function uuid(): string;
     function throttle(func: Function, ms: number): (this: any) => void;
     function sdpFingerprint(sdp: string): BigInteger;

package/types/ConversationParams.d.ts

@@ -5,6 +5,5 @@ declare type ConversationParams = {
     turn_server?: IceServer;
     stun_server?: IceServer;
     client_type?: string;
-    device_idx?: number;
 };
 export default ConversationParams;

package/types/ConversationResponse.d.ts

@@ -23,9 +23,5 @@ declare type ConversationResponse = {
         status: HangupType;
     }[];
     peerId?: number;
-    /**
-     * Порядковый номер, присвоенный устройству при входе в звонок
-     */
-    device_idx?: number;
 };
 export default ConversationResponse;

package/types/ExternalId.d.ts

@@ -22,13 +22,6 @@ export declare namespace ExternalIdUtils {
     function compare(id1: ExternalId, id2: ExternalId): boolean;
 }
 export declare type ExternalIdString = string;
-export declare namespace ExternalParticipantIdUtils {
-    function fromId(id: string, type?: ExternalIdType, deviceIdx?: number): ExternalParticipantId;
-    function toString(externalId: ExternalParticipantId): ExternalParticipantIdString;
-    function fromSignaling(signalingId: SignalingMessage.ExternalId, deviceIdx: number): ExternalParticipantId;
-    function getDeviceIdx(externalId: string | ExternalParticipantId | null): number;
-}
-export declare type ExternalParticipantIdString = string;
 /**
  * Идентификатор внешнего пользователя
  */
@@ -42,15 +35,6 @@ export interface ExternalId {
      */
     type: ExternalIdType;
 }
-/**
- * Идентификатор участника звонка
- */
-export interface ExternalParticipantId extends ExternalId {
-    /**
-     * Индекс устройства (позволяет отличать участников, которые присоединяются к звонку под одной учётной записью с разных устройств)
-     */
-    deviceIdx: number;
-}
 /**
  * Участник звонка
  */
@@ -58,7 +42,7 @@ export interface ExternalParticipant {
     /**
      * Идентификатор пользователя
      */
-    uid: ExternalParticipantId;
+    uid: ExternalId;
     /**
      * Данные стрима
      */

package/types/Participant.d.ts

@@ -3,18 +3,10 @@ import ParticipantState from '../enums/ParticipantState';
 import UserRole from '../enums/UserRole';
 import { ParticipantStatus } from '../static/External';
 import MediaSettings from '../types/MediaSettings';
-import { ExternalParticipantId } from './ExternalId';
+import { ExternalId } from './ExternalId';
 import MuteStates from './MuteStates';
 import ParticipantLayout from './ParticipantLayout';
-/**
- * Уникально идентифицирует пользователя или группу
- */
 export declare type CompositeUserId = string;
-/**
- * Уникально идентифицирует участника звонка
- * (одному пользователю могут соответствовать несколько участников, в случае если пользователь зашёл в звонок с нескольких устройств)
- */
-export declare type ParticipantId = string;
 export declare type OkUserId = number;
 /**
  * Стейт участника звонка
@@ -26,8 +18,8 @@ export interface ParticipantStateMapped {
     };
 }
 export interface Participant {
-    id: ParticipantId;
-    externalId: ExternalParticipantId;
+    id: CompositeUserId;
+    externalId: ExternalId;
     mediaSettings: MediaSettings;
     state: ParticipantState;
     status: ParticipantStatus | null;
@@ -46,4 +38,31 @@ export interface Participant {
     };
     muteStates: MuteStates;
     unmuteOptions: MediaOption[];
+    markers?: IParticipantListMarkers;
+}
+/** format "u123" or "g456", where 123 is user's id and 456 is group's id */
+export declare type ICompositeEntityId = string;
+export declare type IParticipantListType = 'GRID' | 'SIDE' | 'ADMIN';
+export declare type IParticipantListMarkers = {
+    [k in IParticipantListType]?: IParticipantMarker;
+};
+export interface IParticipantMarker {
+    /** server-calculated synthetic value - first criterion for sorting participants (DESC) */
+    rank: number;
+    /** sorting timestamp - second criterion for sorting participants (ASC) */
+    ts: number;
+    /** participant ID - third (and actually fourth) criterion for sorting participants (ASC); sorted first by one-letter prefix (participant type, 'u' < 'g') and second - by long participant id - numerically! */
+    id: ICompositeEntityId;
+}
+export interface IGetParticipantListChunkPayload {
+    listType: IParticipantListType;
+    /** optional, anchor in sorted list to start from, mutually exclusive with fromIdx */
+    fromMarker?: IParticipantMarker;
+    /** optional, 0-based position in sorted list to start from, mutually exclusive with fromMarker */
+    fromIdx?: number;
+    count: number;
+    /** optional, if true then list is to be iterated in reverse order */
+    backward?: boolean;
+    /** optional, if true then resulting chunk will start from Participant with specified marker, if such Participant (still) exists */
+    includeMarker?: boolean;
 }

package/types/ParticipantLayout.d.ts

@@ -1,4 +1,4 @@
-import { ExternalParticipantId } from './ExternalId';
+import { ExternalId } from './ExternalId';
 import { MediaType } from './ParticipantStreamDescription';
 /**
  * Лейаут собеседника в звонке
@@ -42,7 +42,7 @@ export declare type ParticipantLayout = (Layout | StopStream) & {
     /**
      * Внешний ID пользователя
      */
-    uid: ExternalParticipantId | string;
+    uid: ExternalId | string;
     /**
      * Тип медиа (видео с камеры, картинка с экрана, лайв или мувик)
      */

package/types/ParticipantPriority.d.ts

@@ -1,12 +1,12 @@
-import { ExternalParticipantId } from './ExternalId';
+import { ExternalId } from './ExternalId';
 /**
  * Приоритет собеседника в звонке
  */
 declare type ParticipantPriority = {
     /**
-     * Внешний ID участника звонка
+     * Внешний ID пользователя
      */
-    uid: ExternalParticipantId | string;
+    uid: ExternalId | string;
     /**
      * Приоритет [-1..MAX_INT]
      */

package/types/ParticipantStreamDescription.d.ts

@@ -1,4 +1,4 @@
-import { ParticipantId } from './Participant';
+import { CompositeUserId } from './Participant';
 /**
  * Тип пользовательского медиа
  */
@@ -11,7 +11,7 @@ export declare enum MediaType {
 export declare function serializeParticipantStreamDescription(description: ParticipantStreamDescription): string;
 export declare function parseParticipantStreamDescription(descriptionString: string): ParticipantStreamDescription;
 export declare type ParticipantStreamDescription = {
-    participantId: ParticipantId;
+    participantId: CompositeUserId;
     mediaType: MediaType | null;
     streamName?: string;
 };

package/types/SignalingMessage.d.ts

@@ -10,12 +10,12 @@ import UserType from '../enums/UserType';
 import MediaModifiers from './MediaModifiers';
 import MediaSettings from './MediaSettings';
 import MuteStates from './MuteStates';
-import { OkUserId, ParticipantId } from './Participant';
+import { CompositeUserId, IParticipantListMarkers, OkUserId } from './Participant';
 import VideoSettings from './VideoSettings';
 import { WaitingParticipant } from './WaitingHall';
 declare type SignalingMessage = Record<string, any>;
 export declare type RecordInfo = {
-    initiator: ParticipantId;
+    initiator: CompositeUserId;
     recordMovieId: number;
     recordStartTime: number;
     recordType: 'STREAM' | 'RECORD';
@@ -34,7 +34,6 @@ declare namespace SignalingMessage {
     export interface Participant {
         id: OkUserId;
         idType?: UserType;
-        deviceIdx?: number;
         externalId?: ExternalId;
         state: ParticipantState;
         responders?: OkUserId[];
@@ -50,6 +49,7 @@ declare namespace SignalingMessage {
         restricted?: boolean;
         muteStates?: MuteStates;
         unmuteOptions?: MediaOption[];
+        markers?: IParticipantListMarkers;
     }
     interface Conversation {
         id: string;
@@ -62,7 +62,7 @@ declare namespace SignalingMessage {
         multichatId: string | null;
         tamtamMultichatId: string | null;
         recordInfo: RecordInfo | null;
-        pinnedParticipantId: ParticipantId | null;
+        pinnedParticipantId: CompositeUserId | null;
         options: ConversationOption[];
         muteStates?: MuteStates;
     }
@@ -74,14 +74,12 @@ declare namespace SignalingMessage {
     export interface TransmittedData extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         peerId: PeerId;
         data: any;
     }
     export interface RegisteredPeer extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         peerId: PeerId;
         platform: string;
         clientType: string;
@@ -89,14 +87,12 @@ declare namespace SignalingMessage {
     export interface AcceptedCall extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         peerId: PeerId;
         mediaSettings: Partial<MediaSettings>;
     }
     export interface Hungup extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         peerId: PeerId;
         reason: HangupType;
     }
@@ -106,14 +102,12 @@ declare namespace SignalingMessage {
     export interface MediaSettingsChanged extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         peerId: PeerId;
         mediaSettings: Partial<MediaSettings>;
     }
     export interface ParticipantStateChanged extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         peerId: PeerId;
         mediaSettings: Partial<MediaSettings>;
         participantState: {
@@ -122,13 +116,13 @@ declare namespace SignalingMessage {
         };
     }
     export interface RolesChanged extends Notification {
-        adminId: ParticipantId;
-        participantId: ParticipantId;
+        adminId: CompositeUserId;
+        participantId: CompositeUserId;
         roles?: UserRole[];
     }
     export interface MuteParticipant extends Notification {
-        adminId?: ParticipantId;
-        participantId?: ParticipantId;
+        adminId?: CompositeUserId;
+        participantId?: CompositeUserId;
         muteStates: MuteStates;
         unmuteOptions?: MediaOption[];
         mediaOptions: MediaOption[];
@@ -136,7 +130,7 @@ declare namespace SignalingMessage {
         muteAll?: boolean;
     }
     export interface PinParticipant extends Notification {
-        participantId: ParticipantId;
+        participantId: CompositeUserId;
         unpin?: boolean;
     }
     export interface ParticipantAdded extends Notification {
@@ -160,7 +154,6 @@ declare namespace SignalingMessage {
         topology: TransportTopology;
         offerTo: OkUserId[];
         offerToTypes: UserType[];
-        offerToDeviceIdxs: number[];
     }
     export interface RateCallData extends Notification {
         maxRateForQuestion: number;
@@ -177,10 +170,12 @@ declare namespace SignalingMessage {
         reason: string;
     }
     export interface RecordStarted extends Notification {
+        idType: UserType;
+        id: OkUserId;
         recordInfo: RecordInfo;
     }
     export interface RecordStopped extends Notification {
-        participant: ParticipantId;
+        participant: CompositeUserId;
         recordMovieId: number;
     }
     export interface ReallocCon extends Notification {
@@ -190,7 +185,6 @@ declare namespace SignalingMessage {
     export interface ChatMessage extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         direct: boolean;
         message: string;
     }
@@ -203,13 +197,13 @@ declare namespace SignalingMessage {
         settings: Record<string, any>;
     }
     export interface StalledActivity extends Notification {
-        stalledParticipants: ParticipantId[];
+        stalledParticipants: CompositeUserId[];
     }
     export interface AudioActivity extends Notification {
-        activeParticipants: ParticipantId[];
+        activeParticipants: CompositeUserId[];
     }
     export interface SpeakerChanged extends Notification {
-        speaker: ParticipantId;
+        speaker: CompositeUserId;
     }
     export interface OptionsChanged extends Notification {
         options: ConversationOption[];
@@ -218,7 +212,7 @@ declare namespace SignalingMessage {
         statuses: Record<string, number>;
     }
     export interface PromotionApproved extends Notification {
-        adminId: ParticipantId;
+        adminId: CompositeUserId;
     }
     export interface PromoteParticipant extends Notification {
         demote: boolean;
@@ -229,8 +223,8 @@ declare namespace SignalingMessage {
         eventType: ChatRoomEventType;
         totalCount: number;
         firstParticipants: WaitingParticipant[];
-        addedParticipantIds: ParticipantId[];
-        removedParticipantIds: ParticipantId[];
+        addedParticipantIds: CompositeUserId[];
+        removedParticipantIds: CompositeUserId[];
         feedback: Record<string, any>[];
     }
     export interface VideoQualityUpdate extends Notification {
@@ -242,7 +236,6 @@ declare namespace SignalingMessage {
     export interface CustomData extends Notification {
         participantId: OkUserId;
         participantType: UserType;
-        deviceIdx?: number;
         data: Record<string, any>;
     }
     export interface SwitchMicro extends Notification {
@@ -255,6 +248,16 @@ declare namespace SignalingMessage {
         peerId: PeerId;
         mediaModifiers: MediaModifiers;
     }
+    export interface IParticipantListChunk extends Notification {
+        response: 'get-participant-list-chunk';
+        chunk: {
+            /** each contains ParticipantListMarker for requested ParticipantListType */
+            participants: Participant[];
+            countBefore: number;
+            countAfter: number;
+            markerFound: boolean;
+        };
+    }
     export {};
 }
 export default SignalingMessage;