@vkontakte/calls-sdk 2.8.5-dev.1925f9b.0 → 2.8.5-dev.36da4e4e.0

package/classes/Conversation.d.ts

@@ -195,14 +195,14 @@ export default class Conversation extends EventEmitter {
      * @deprecated Use updateDisplayLayout instead
      */
     changePriorities(priorities: ParticipantPriority[]): Promise<void>;
-    changeParticipantState(state: {
-        [key: string]: string;
-    }): Promise<void>;
+    changeParticipantState(state: Record<string, string>, compositeUserId?: CompositeUserId): Promise<void>;
+    putHandsDown(): Promise<void>;
     requestKeyFrame(participantStreamDescription: ParticipantStreamDescription): Promise<void | SignalingMessage>;
     requestTestMode(consumerCommand: string, producerCommand: string): Promise<void>;
     updateDisplayLayout(layouts: ParticipantLayout[]): Promise<void>;
     feedback(key: string): Promise<SignalingMessage>;
     userFeedbackStats(userResponse: number, reason?: string, groupCallUsersCount?: number): void;
+    sendClientEvent(eventType: string, eventData?: Record<string, string | number | boolean>, immediately?: boolean): void;
     private _changeMediaSettings;
     private _stopStreaming;
     private _sendUpdateDisplayLayout;
@@ -235,6 +235,7 @@ export default class Conversation extends EventEmitter {
     pinParticipant(participantId: ParticipantId, unpin: boolean, roomId?: number | null): Promise<void>;
     updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<void>;
     enableVideoSuspend(enabled: boolean): Promise<void>;
+    enableVideoSuspendSuggest(enabled: boolean): Promise<void>;
     changeOptions(changes: {
         [key in ConversationOption]?: boolean;
     }): Promise<void>;
@@ -284,6 +285,7 @@ export default class Conversation extends EventEmitter {
     private _onLocalMediaStreamChanged;
     private _onScreenSharingStatus;
     private _changeRemoteMediaSettings;
+    private _changeLocalParticipantState;
     private _changeRemoteParticipantState;
     private _invokeRolesChangedCallbackIfNeeded;
     private _onSignalingNotification;
@@ -372,6 +374,7 @@ export default class Conversation extends EventEmitter {
     /** получили из сингналинга сообщение о реакции пользователей */
     private _onFeedback;
     private _onDecorativeParticipantIdChanged;
+    private _onVideoSuspendSuggest;
     private _isMe;
     private _getMuteStatesForRoomId;
     private _getMuteStatesForCurrentRoom;

package/classes/Logger.d.ts

@@ -7,22 +7,26 @@ export default class Logger extends BaseLogger {
     private _batchInterval;
     private _batchedLogItems;
     private _batchedClientStats;
+    private _batchedClientEvents;
     private _batchTimeout;
     private static _instance;
     constructor(api: BaseApi, externalLogger: BaseLogger | null);
     private _sendLogItems;
     private _sendClientStats;
+    private _sendClientEvents;
     private _sendBatch;
     private _startTimeout;
     private _stopTimeout;
     log(name: Stat, value?: string, immediately?: boolean): void;
     logCustom(name: string, params: Record<string, string | number>, immediately?: boolean): void;
     logClientStats(data: Record<string, string | number | undefined | null>, immediately?: boolean): void;
+    logClientEvent(data: Record<string, string | number | undefined | null>, immediately?: boolean): void;
     _logInternal(operation: string, custom: Record<string, string | number>, immediately: boolean): void;
     destroy(): void;
     static create(api: BaseApi, externalLogger: BaseLogger | null): void;
     static log(name: Stat, value?: string, immediately?: boolean): void;
     static logCustom(name: string, params: Record<string, string | number>, immediately?: boolean): void;
     static logClientStats(params: Record<string, string | number | undefined | null>, immediately?: boolean): void;
+    static logClientEvent(params: Record<string, string | number | undefined | null>, immediately?: boolean): void;
     static destroy(): void;
 }

package/classes/ProducerCommandSerializationService.d.ts

@@ -2,6 +2,7 @@ import { NetworkStatReport } from '../types/NetworkStatReport';
 import ParticipantLayout, { RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
 import { RequestAsr } from '../types/RequestAsr';
 import { EnableVideoSuspend } from '../types/EnableVideoSuspend';
+import { EnableVideoSuspendSuggest } from '../types/EnableVideoSuspendSuggest';
 import SignalingMessage from '../types/SignalingMessage';
 import { PerfStatReport } from '../types/PerfStatReporter';
 import { SharingStatReport } from './screenshare/SharingStatReport';
@@ -19,6 +20,7 @@ export declare class ProducerCommandSerializationService {
     serializeRequestAsr(sequenceNumber: number, params: RequestAsr): ArrayBuffer;
     serializeNetworkStatReport(sequenceNumber: number, report: NetworkStatReport): ArrayBuffer;
     serializeEnableVideoSuspend(sequenceNumber: number, params: EnableVideoSuspend): ArrayBuffer;
+    serializeEnableVideoSuspendSuggest(sequenceNumber: number, params: EnableVideoSuspendSuggest): ArrayBuffer;
     deserializeCommandResponse(data: BufferSource | Blob): Promise<SignalingMessage | undefined>;
     private deserializeUpdateDisplayLayoutResponse;
     private deserializeReportPerfStatResponse;

package/default/Api.d.ts

@@ -1,4 +1,4 @@
-import BaseApi, { LogItem, ClientStats } from '../abstract/BaseApi';
+import BaseApi, { LogItem, ClientStats, ClientEvent } from '../abstract/BaseApi';
 import CallType from '../enums/CallType';
 import ConversationParams from '../types/ConversationParams';
 import ConversationResponse from '../types/ConversationResponse';
@@ -16,6 +16,7 @@ export default class Api extends BaseApi {
     authorize(): Promise<void>;
     log(items: LogItem[]): void;
     logClientStats(items: ClientStats[]): void;
+    logClientEvents(items: ClientEvent[]): void;
     init(): void;
     joinConversation(conversationId: string, isVideo?: boolean, chatId?: string): Promise<ConversationResponse>;
     createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie, audienceMode, audioOnly, }?: {

package/default/Signaling.d.ts

@@ -85,9 +85,8 @@ export default class Signaling extends BaseSignaling {
     sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit): Promise<SignalingMessage>;
     acceptCall(mediaSettings: MediaSettings): Promise<SignalingMessage>;
     changeMediaSettings(mediaSettings: MediaSettings): Promise<SignalingMessage>;
-    changeParticipantState(state: {
-        [key: string]: string;
-    }): Promise<SignalingMessage>;
+    changeParticipantState(state: Record<string, string>, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
+    putHandsDown(): Promise<SignalingMessage>;
     addParticipant(participantId: CompositeUserId, params?: AddParticipantParams): Promise<SignalingMessage>;
     removeParticipant(participantId: CompositeUserId, ban?: boolean): Promise<SignalingMessage>;
     allocateConsumer(description: RTCSessionDescription | null, capabilities: {
@@ -132,6 +131,7 @@ export default class Signaling extends BaseSignaling {
     pinParticipant(participantId: ParticipantId, unpin: boolean, roomId: number | null): Promise<SignalingMessage>;
     updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
     enableVideoSuspend(enabled: boolean): Promise<SignalingMessage>;
+    enableVideoSuspendSuggest(enabled: boolean): Promise<SignalingMessage>;
     changeOptions(changes: {
         [key in ConversationOption]?: boolean;
     }): Promise<SignalingMessage>;

package/enums/SignalingCommandType.d.ts

@@ -53,6 +53,8 @@ declare enum SignalingCommandType {
     REQUEST_PROMOTION = "request-promotion",
     ACCEPT_PROMOTION = "accept-promotion",
     GET_HAND_QUEUE = "get-hand-queue",
-    ENABLE_VIDEO_SUSPEND = "enable-video-suspend"
+    ENABLE_VIDEO_SUSPEND = "enable-video-suspend",
+    ENABLE_VIDEO_SUSPEND_SUGGEST = "enable-video-suspend-suggest",
+    PUT_HANDS_DOWN = "put-hands-down"
 }
 export default SignalingCommandType;

package/enums/SignalingNotification.d.ts

@@ -48,6 +48,7 @@ declare enum SignalingNotification {
     PARTICIPANT_ANIMOJI_CHANGED = "participant-animoji-changed",
     ASR_STARTED = "asr-started",
     ASR_STOPPED = "asr-stopped",
-    DECORATIVE_PARTICIPANT_ID_CHANGED = "decorative-participant-id-changed"
+    DECORATIVE_PARTICIPANT_ID_CHANGED = "decorative-participant-id-changed",
+    VIDEO_SUSPEND_SUGGEST = "video-suspend-suggest"
 }
 export default SignalingNotification;

package/enums/Stat.d.ts

@@ -33,6 +33,8 @@ declare const enum Stat {
     SCREENSHARE_FREEZE_DURATION = "callScreenshareFreezeDuration",
     /** Объединение callFirstDataReceivedP2P и callFirstAudioMixDataReceived */
     FIRST_MEDIA_RECEIVED = "first_media_received",
-    CALL_EVENTUAL_STAT = "callEventualStat"
+    CALL_EVENTUAL_STAT = "callEventualStat",
+    CALL_DECLINED_OR_HANGED_LOCALLY = "CallDeclinedOrHangedLocally",
+    USER_FEEDBACK_RECEIVED = "UserFeedbackReceived"
 }
 export default Stat;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.5-dev.1925f9b.0",
+  "version": "2.8.5-dev.36da4e4e.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/static/External.d.ts

@@ -226,6 +226,7 @@ declare namespace External {
      * @param markers
      */
     function onParticipantJoined(userId: ExternalId, markers: ExternalParticipantListMarkers | null): void;
+    function onLocalParticipantState(participantState: ParticipantStateMapped): void;
     /**
      * Изменились данные состояний собеседника
      *
@@ -539,6 +540,7 @@ declare namespace External {
      * @param newId
      */
     function onParticipantIdChanged(prevId: ExternalParticipantId, newId: ExternalParticipantId): void;
+    function onVideoSuspendSuggest(bandwidth: number): void;
     /**
      * Одобрено повышение пользователя в зеле ожидания/зале в режиме Audience
      *

package/static/Params.d.ts

@@ -229,12 +229,18 @@ export type ParamsObject = {
     /**
      * Включает использование обновленного API и формата
      * логирования статистики качества аудио/видео.
-     * Требует указания clientStatsPlatform.
      *
      * _По умолчанию: `false`_
      * @hidden
      */
     useCallStatReportNewAPI: boolean;
+    /**
+     * Включает логирование событий продуктовой статистики.
+     *
+     * _По умолчанию: `false`_
+     * @hidden
+     */
+    clientEventsLoggingEnabled: boolean;
     /** @hidden */
     networkStatReportEnabled: boolean;
     /**
@@ -558,6 +564,11 @@ export type ParamsObject = {
      * Участник присоединился к звонку
      */
     onParticipantJoined?: (userId: ExternalParticipantId, markers: ExternalParticipantListMarkers) => void;
+    /**
+     * Получены данные по изменению локальных состояний со стороны админа
+     * Например, принудительно опущена рука
+     */
+    onLocalParticipantState?: (participantState: ParticipantStateMapped) => void;
     /**
      * Изменились данные состояний собеседника
      */
@@ -799,6 +810,12 @@ export type ParamsObject = {
      * @param newId
      */
     onParticipantIdChanged?: (prevId: ExternalParticipantId, newId: ExternalParticipantId) => void;
+    /**
+     * Предложение включить режим автоматического отключения приёма видео
+     * в плохой сети
+     * @param bandwidth текущая полоса пропускания, kbps
+     */
+    onVideoSuspendSuggest?: (bandwidth: number) => void;
     /**
      * Одобрено повышение пользователя в зале ожидания/зале в режиме Audience
      *
@@ -903,6 +920,7 @@ export default abstract class Params {
     static get perfStatReportEnabled(): boolean;
     static get callStatReportEnabled(): boolean;
     static get useCallStatReportNewAPI(): boolean;
+    static get clientEventsLoggingEnabled(): boolean;
     static get networkStatReportEnabled(): boolean;
     static get enableLogPerfStatReport(): boolean;
     static get includeRemoteRtpsInCallStat(): boolean;

package/types/EnableVideoSuspendSuggest.d.ts

@@ -0,0 +1,3 @@
+export type EnableVideoSuspendSuggest = {
+    enabled: boolean;
+};

package/types/SignalingMessage.d.ts

@@ -427,6 +427,9 @@ declare namespace SignalingMessage {
         decorativeParticipantId?: CompositeUserId;
         decorativeExternalParticipantId?: ExternalId;
     }
+    export interface VideoSuspendSuggest extends Notification {
+        bandwidth: number;
+    }
     export {};
 }
 export default SignalingMessage;