@vkontakte/calls-sdk 2.8.2-dev.9920ff6.0 → 2.8.2-dev.9a2f8df.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
@@ -1,20 +1,21 @@
1
1
  /**
2
2
  * CallsSDK
3
3
  */
4
- import type * as Vmoji from '@vkontakte/calls-vmoji';
5
4
  import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
5
+ import type * as Vmoji from '@vkontakte/calls-vmoji';
6
6
  import BaseApi from './abstract/BaseApi';
7
7
  import BaseLogger from './abstract/BaseLogger';
8
8
  import BaseSignaling, { AddParticipantParams } from './abstract/BaseSignaling';
9
9
  import HangupReason, { HangupReasonData } from './classes/HangupReason';
10
10
  import { MediaTrackKind } from './classes/MediaSource';
11
- import { StatResult } from './types/Statistics';
11
+ import { AudienceModeHandsResponse } from './types/AudienceMode';
12
12
  import { TransportTopology } from './classes/transport/Transport';
13
13
  import Api from './default/Api';
14
14
  import Signaling from './default/Signaling';
15
15
  import CallDirection from './enums/CallDirection';
16
16
  import CallType from './enums/CallType';
17
17
  import ChatRoomEventType from './enums/ChatRoomEventType';
18
+ import ConversationFeature from './enums/ConversationFeature';
18
19
  import ConversationOption from './enums/ConversationOption';
19
20
  import FatalError from './enums/FatalError';
20
21
  import HangupType from './enums/HangupType';
@@ -22,6 +23,7 @@ import MediaOption from './enums/MediaOption';
22
23
  import MuteState from './enums/MuteState';
23
24
  import ParticipantState from './enums/ParticipantState';
24
25
  import RecordRole from './enums/RecordRole';
26
+ import RoomsEventType from './enums/RoomsEventType';
25
27
  import SignalingCommandType from './enums/SignalingCommandType';
26
28
  import SignalingConnectionType from './enums/SignalingConnectionType';
27
29
  import SignalingNotification from './enums/SignalingNotification';
@@ -33,31 +35,31 @@ import { JSONArray, JSONObject, JSONType } from './static/Json';
33
35
  import { ParamsObject } from './static/Params';
34
36
  import Utils from './static/Utils';
35
37
  import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
36
- import { IAsrStartParams, IAsrStopParams, IAsrData } from './types/Asr';
38
+ import { IAsrData, IAsrStartParams, IAsrStopParams } from './types/Asr';
39
+ import { ConversationData } from './types/Conversation';
40
+ import { IFeaturesPerRole } from './types/ConversationFeature';
37
41
  import ConversationParams from './types/ConversationParams';
38
42
  import ConversationResponse from './types/ConversationResponse';
39
43
  import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers, ExternalUserId } from './types/ExternalId';
44
+ import { IFeedbackExternal } from './types/Feedback';
40
45
  import IceServer from './types/IceServer';
41
46
  import MediaModifiers from './types/MediaModifiers';
42
47
  import { IVideoDimentions, MediaSettings } from './types/MediaSettings';
48
+ import { IAddMovieParams, IMovieMetaData, IMoviePreview, IOnRemoteMovieData, ISharedMovieInfo, ISharedMovieState, ISharedMovieStateResponse, ISharedMovieStoppedInfo, IUpdateMovieData } from './types/MovieShare';
43
49
  import MuteStates, { IMuteParticipantInternalParams, IMuteParticipantParams } from './types/MuteStates';
44
- import { IGetParticipantsParameters, OkUserId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantStateMapped } from './types/Participant';
50
+ import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantStateMapped } from './types/Participant';
45
51
  import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
46
52
  import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
47
53
  import ParticipantPriority from './types/ParticipantPriority';
48
54
  import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
49
- import { Room, RoomsUpdate, RoomParticipantUpdate, Rooms, IRoomId } from './types/Room';
50
- import RoomsEventType from './enums/RoomsEventType';
55
+ import { IRoomId, Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from './types/Room';
51
56
  import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
52
57
  import SignalingMessage from './types/SignalingMessage';
58
+ import { StatResult } from './types/Statistics';
59
+ import { IStartStreamData, IStopStreamData, IPublishStreamData } from './types/Streams';
53
60
  import { WaitingHallResponse } from './types/WaitingHall';
54
- import { IFeedbackExternal } from './types/Feedback';
55
- import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData, IMovieMetaData } from './types/MovieShare';
56
- import { IStartStreamData, IStopStreamData } from './types/Streams';
57
- import ConversationFeature from './enums/ConversationFeature';
58
- import { IFeaturesPerRole } from './types/ConversationFeature';
59
61
  import { ArrayDequeue } from './utils/ArrayDequeue';
60
- import { ConversationData } from './types/Conversation';
62
+ import AuthData from './static/AuthData';
61
63
  /**
62
64
  * Информация о текущем браузере
63
65
  */
@@ -224,7 +226,7 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
224
226
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
225
227
  * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
226
228
  */
227
- export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
229
+ export declare function callTo(externalId?: ExternalId | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
228
230
  export declare function callInternal(ids: OkUserId[], type: CallType | undefined, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
229
231
  /**
230
232
  * Обработать пуш о входящем звонке
@@ -282,7 +284,7 @@ export declare function hangup(): Promise<void>;
282
284
  * @param externalId Внешний ID пользователя
283
285
  * @param params Параметры
284
286
  */
285
- export declare function addParticipant(externalId: string | ExternalId, params?: AddParticipantParams): Promise<void>;
287
+ export declare function addParticipant(externalId: ExternalId, params?: AddParticipantParams): Promise<void>;
286
288
  export declare function addParticipantInternal(uid: OkUserId, params?: AddParticipantParams): Promise<void>;
287
289
  /**
288
290
  * Удалить собеседника из звонка
@@ -290,7 +292,7 @@ export declare function addParticipantInternal(uid: OkUserId, params?: AddPartic
290
292
  * @param externalId Внешний ID пользователя
291
293
  * @param ban Забанить пользователя
292
294
  */
293
- export declare function removeParticipant(externalId: string | ExternalId, ban?: boolean): Promise<void>;
295
+ export declare function removeParticipant(externalId: ExternalId, ban?: boolean): Promise<void>;
294
296
  export declare function removeParticipantInternal(uid: OkUserId, ban?: boolean): Promise<void>;
295
297
  /**
296
298
  * Изменить камеру на фронтальную или заднюю (для мобильных устройств)
@@ -420,7 +422,7 @@ export declare function changeConversationOptions(changes: {
420
422
  * @param message Сообщение
421
423
  * @param externalId Внешний ID пользователя (если не указано, отправит всем)
422
424
  */
423
- export declare function chatMessage(message: string, externalId?: string | ExternalId | null): Promise<void>;
425
+ export declare function chatMessage(message: string, externalId?: ExternalId | null): Promise<void>;
424
426
  export declare function chatMessageInternal(message: string, uid?: OkUserId | null): Promise<void>;
425
427
  /**
426
428
  * Получить историю сообщений чата
@@ -502,19 +504,21 @@ export declare function startStream(isRecord?: boolean, name?: string | null, mo
502
504
  * @param roomId
503
505
  */
504
506
  export declare function stopStream(roomId?: number | null): Promise<undefined>;
507
+ /**
508
+ * Опубликовать трансляцию звонка
509
+ * @param roomId
510
+ */
511
+ export declare function publishStream(roomId?: number | null): Promise<undefined>;
505
512
  /**
506
513
  * Устанавливает роль участника в запись звонка
507
514
  * Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
508
515
  * видны только те участники, у кого есть роль.
509
- * KING - участник показывается крупно в записи звонка (только один участник имеет такую роль)
510
- * PAWN - участник показывается в записи звонка
511
- * null - роль удаляется
512
- *
513
- * @param externalId Внешний ID пользователя
514
- * @param role Роль, если null, то роль удалится
515
- * @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
516
+ * @param king участник показывается крупно в записи звонка (только один участник имеет такую роль)
517
+ * @param pawns участник показывается в записи звонка
518
+ * @param hideParticipantCount скрыть/показать количество невидимых участников
519
+ * @param roomId комната
516
520
  */
517
- export declare function recordSetRole(externalId: ExternalId, role: RecordRole | null, roomId?: number | null): Promise<void>;
521
+ export declare function recordSetConf(king?: ExternalId, pawns?: ExternalId[], hideParticipantCount?: boolean, roomId?: number | null): Promise<void>;
518
522
  /**
519
523
  * Получить информацию о трансляции звонка
520
524
  */
@@ -617,6 +621,10 @@ export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: Exte
617
621
  * @param backward Получить результат в обратном порядке
618
622
  */
619
623
  export declare function getWaitingHall(pageMarker?: string | null, count?: number, backward?: boolean): Promise<WaitingHallResponse>;
624
+ /**
625
+ * Получить список слушателей, запросивших повышение в комнате в режиме Audience
626
+ */
627
+ export declare function getAudienceModeHands(): Promise<AudienceModeHandsResponse>;
620
628
  /**
621
629
  * Разрешить/запретить пользователю войти из зала ожидания/стать спикером комнаты
622
630
  * в режиме Audience
@@ -664,5 +672,5 @@ export declare function requestAsr(request: boolean): Promise<void>;
664
672
  * Версия SDK
665
673
  */
666
674
  export declare function version(): string;
667
- export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, 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, };
668
- 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, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, };
675
+ export type { AddParticipantParams, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, 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, };
676
+ 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, };
@@ -44,9 +44,10 @@ export default abstract class BaseApi {
44
44
  abstract setUserId(userId: OkUserId): void;
45
45
  log(items: LogItem[]): void;
46
46
  prepareUserIds(ids: OkUserId[]): Promise<void>;
47
- abstract getOkIdsByExternalIds(externalIds: (string | ExternalId)[]): Promise<OkUserId[]>;
47
+ abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
48
+ abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
48
49
  abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
49
- getCachedOkIdByExternalId(externalId: ExternalParticipantId): CompositeUserId | null;
50
+ getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
50
51
  cacheExternalId(participantId: CompositeUserId, externalId: ExternalParticipantId): void;
51
52
  hangupConversation(conversationId: string): void;
52
53
  removeHistoryRecords(recordIds: number[]): Promise<void>;
@@ -6,7 +6,6 @@ import { TransportTopology } from '../classes/transport/Transport';
6
6
  import ConversationFeature from '../enums/ConversationFeature';
7
7
  import ConversationOption from '../enums/ConversationOption';
8
8
  import MediaOption from '../enums/MediaOption';
9
- import RecordRole from '../enums/RecordRole';
10
9
  import SignalingConnectionType from '../enums/SignalingConnectionType';
11
10
  import UserRole from '../enums/UserRole';
12
11
  import { JSONObject } from '../static/Json';
@@ -20,7 +19,7 @@ import { CompositeUserId, ParticipantId } from '../types/Participant';
20
19
  import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
21
20
  import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
22
21
  import SignalingMessage from '../types/SignalingMessage';
23
- import { IStartStreamData, IStopStreamData } from '../types/Streams';
22
+ import { IPublishStreamData, IRecordConfData, IStartStreamData, IStopStreamData } from '../types/Streams';
24
23
  import { WaitingParticipantId } from '../types/WaitingHall';
25
24
  import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
26
25
  /**
@@ -75,7 +74,8 @@ export default abstract class BaseSignaling extends EventEmitter {
75
74
  abstract removeRooms(roomIds: number[]): Promise<SignalingMessage>;
76
75
  abstract startStream(data: IStartStreamData): Promise<SignalingMessage>;
77
76
  abstract stopStream(data: IStopStreamData): Promise<SignalingMessage>;
78
- abstract recordSetRole(participantId: ParticipantId, role: RecordRole | null, roomId: number | null): Promise<SignalingMessage>;
77
+ abstract publishStream(data: IPublishStreamData): Promise<SignalingMessage>;
78
+ abstract recordSetConf(conf: IRecordConfData): Promise<SignalingMessage>;
79
79
  abstract getRecordStatus(): Promise<SignalingMessage>;
80
80
  abstract switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
81
81
  abstract reportPerfStat(report: PerfStatReport): Promise<SignalingMessage>;
@@ -96,6 +96,7 @@ export default abstract class BaseSignaling extends EventEmitter {
96
96
  abstract requestPromotion(demote: boolean): Promise<SignalingMessage>;
97
97
  abstract acceptPromotion(reject: boolean): Promise<SignalingMessage>;
98
98
  abstract feedback(key: string): Promise<SignalingMessage>;
99
+ abstract getHandQueue(): Promise<SignalingMessage>;
99
100
  abstract setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
100
101
  abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
101
102
  abstract useCommandDataChannel(status: boolean): void;