@vkontakte/calls-sdk 2.8.5-dev.3825785e.0 → 2.8.5-dev.4a46d60f.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CallsSDK.d.ts CHANGED
@@ -3,9 +3,8 @@
3
3
  */
4
4
  import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
5
5
  import type * as Vmoji from '@vkontakte/calls-vmoji';
6
- import BaseApi from './abstract/BaseApi';
7
6
  import BaseLogger from './abstract/BaseLogger';
8
- import BaseSignaling, { AddParticipantParams } from './abstract/BaseSignaling';
7
+ import { AddParticipantParams } from './abstract/BaseSignaling';
9
8
  import HangupReason, { HangupReasonData } from './classes/HangupReason';
10
9
  import { MediaTrackKind } from './classes/MediaSource';
11
10
  import { AudienceModeHandsResponse } from './types/AudienceMode';
@@ -48,7 +47,7 @@ import { IVideoDimentions, MediaSettings } from './types/MediaSettings';
48
47
  import { IAddMovieParams, IMovieMetaData, IMoviePreview, IOnRemoteMovieData, ISharedMovieInfo, ISharedMovieState, ISharedMovieStateResponse, ISharedMovieStoppedInfo, IUpdateMovieData } from './types/MovieShare';
49
48
  import MuteStates, { IMuteParticipantInternalParams, IMuteParticipantParams } from './types/MuteStates';
50
49
  import { IApiEnv } from './types/Params';
51
- import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantStateMapped } from './types/Participant';
50
+ import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantsStateList, ParticipantStateMapped } from './types/Participant';
52
51
  import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
53
52
  import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
54
53
  import ParticipantPriority from './types/ParticipantPriority';
@@ -193,8 +192,6 @@ export declare const utils: {
193
192
  */
194
193
  participantMarkerCompare: typeof Utils.participantMarkerCompare;
195
194
  };
196
- export declare function setApi(api: BaseApi): void;
197
- export declare function setSignalingFactory(signalingFactory: () => BaseSignaling): void;
198
195
  export declare function setLogger(logger: BaseLogger): void;
199
196
  /**
200
197
  * Устанавливает библиотеку эффектов
@@ -368,8 +365,13 @@ export declare function changePriorities(priorities: ParticipantPriority[]): Pro
368
365
  * Изменяет состояния пользователя в звонке (например, "поднять руку" или "отошёл")
369
366
  *
370
367
  * @param state Список состояний в виде ключ-значение. Максимальная длина ключей и значений - 5 символов. Пустые значения будут пропущены
368
+ * @param externalId Внешний ID пользователя
369
+ */
370
+ export declare function changeParticipantState(state: Record<string, string>, externalId?: ExternalId): Promise<void>;
371
+ /**
372
+ * Принудительно опустить руки участников в текущем сессионном зале админа
371
373
  */
372
- export declare function changeParticipantState(state: Record<string, string>): Promise<void>;
374
+ export declare function putHandsDown(): Promise<void>;
373
375
  /**
374
376
  * Изменяет лейаут.
375
377
  * Также сообщает серверу каких участников звонка стримить на этот клиент
@@ -413,6 +415,13 @@ export declare function setMediaModifiers(mediaModifiers: MediaModifiers): Promi
413
415
  * @param enabled true - включить, false - отключить
414
416
  */
415
417
  export declare function enableVideoSuspend(enabled: boolean): Promise<void>;
418
+ /**
419
+ * Режим, при котором будет предложено включить автоматическое
420
+ * отключение приёма видео в условиях плохого соединения
421
+ *
422
+ * @param enabled true - включить, false - отключить
423
+ */
424
+ export declare function enableVideoSuspendSuggest(enabled: boolean): Promise<void>;
416
425
  /**
417
426
  * Включить/выключить опции звонка
418
427
  *
@@ -504,7 +513,7 @@ export declare function forceRelayPolicy(enabled: boolean): void;
504
513
  * @param groupId
505
514
  * @param roomId
506
515
  */
507
- export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null, externalAccessKey?: string | null): Promise<undefined>;
516
+ export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null): Promise<undefined>;
508
517
  /**
509
518
  * Завершить трансляцию звонка
510
519
  * @param roomId
@@ -696,5 +705,5 @@ export declare function sendTestCommand(name: string, params?: any): void;
696
705
  * Версия SDK
697
706
  */
698
707
  export declare function version(): string;
699
- export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, 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, IPublishStreamData, VmojiError, };
700
- export { Api, AuthData, 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, ApiExternal, };
708
+ export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, 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, IPublishStreamData, VmojiError, };
709
+ export { Api, AuthData, BaseLogger, 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, ApiExternal, };
@@ -28,7 +28,6 @@ export type LogItem = {
28
28
  uid: OkUserId | null;
29
29
  };
30
30
  export default abstract class BaseApi {
31
- abstract init(): void;
32
31
  abstract authorize(): Promise<void>;
33
32
  abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
34
33
  abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
@@ -75,5 +74,6 @@ export default abstract class BaseApi {
75
74
  hangupConversation(conversationId: string): void;
76
75
  sendUserFeedbackStats(conversationId: string, userResponse: number, reason?: string, groupCallUsersCount?: number): void;
77
76
  removeHistoryRecords(recordIds: number[]): Promise<void>;
77
+ getServerTime(): Promise<number>;
78
78
  cleanup(): void;
79
79
  }
@@ -43,12 +43,11 @@ export default abstract class BaseSignaling extends EventEmitter {
43
43
  abstract close(): void;
44
44
  abstract hangup(reason: string): Promise<SignalingMessage | void>;
45
45
  abstract acceptCall(mediaSettings: MediaSettings): Promise<SignalingMessage>;
46
- abstract sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit): Promise<SignalingMessage>;
46
+ abstract sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit, extraPayload?: Record<string, any>): Promise<SignalingMessage>;
47
47
  abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidate): Promise<SignalingMessage>;
48
48
  abstract changeMediaSettings(mediaSettings: MediaSettings): Promise<SignalingMessage>;
49
- abstract changeParticipantState(state: {
50
- [key: string]: string;
51
- }): Promise<SignalingMessage>;
49
+ abstract changeParticipantState(state: Record<string, string>, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
50
+ abstract putHandsDown(): Promise<SignalingMessage>;
52
51
  abstract addParticipant(participantId: CompositeUserId, params?: AddParticipantParams): Promise<SignalingMessage>;
53
52
  abstract removeParticipant(participantId: CompositeUserId, ban?: boolean): Promise<SignalingMessage>;
54
53
  abstract allocateConsumer(description: RTCSessionDescription | null, capabilities: {
@@ -92,6 +91,7 @@ export default abstract class BaseSignaling extends EventEmitter {
92
91
  abstract pinParticipant(participantId: ParticipantId, unpin: boolean, roomId: number | null): Promise<SignalingMessage>;
93
92
  abstract updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
94
93
  abstract enableVideoSuspend(enabled: boolean): Promise<SignalingMessage>;
94
+ abstract enableVideoSuspendSuggest(enabled: boolean): Promise<SignalingMessage>;
95
95
  abstract changeOptions(changes: {
96
96
  [key in ConversationOption]?: boolean;
97
97
  }): Promise<SignalingMessage>;