@vkontakte/calls-sdk 2.8.2-dev.968ce3b.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 +71 -36
- package/abstract/BaseApi.d.ts +10 -8
- package/abstract/BaseSignaling.d.ts +7 -5
- package/calls-sdk.cjs.js +8 -8
- package/calls-sdk.esm.js +8 -8
- package/classes/AudioOutput.d.ts +8 -3
- package/classes/Conversation.d.ts +18 -3
- package/classes/MediaSource.d.ts +2 -2
- package/classes/ParticipantIdRegistry.d.ts +5 -0
- package/classes/ProducerCommandSerializationService.d.ts +2 -0
- package/classes/codec/IEncoder.d.ts +1 -1
- package/classes/codec/LibVPxEncoder.d.ts +1 -1
- package/classes/codec/Types.d.ts +1 -1
- package/classes/codec/WebCodecsEncoder.d.ts +1 -1
- package/classes/screenshare/PacketHistory.d.ts +1 -0
- package/classes/screenshare/ScreenCaptureSender.d.ts +2 -1
- package/classes/screenshare/ScreenCongestionControl.d.ts +6 -1
- package/classes/transport/ServerTransport.d.ts +2 -0
- package/classes/transport/Statistics.d.ts +19 -1
- package/classes/transport/Transport.d.ts +1 -0
- package/default/Api.d.ts +13 -13
- package/default/Signaling.d.ts +9 -8
- package/enums/SignalingCommandType.d.ts +6 -2
- package/enums/SignalingNotification.d.ts +2 -1
- package/package.json +3 -6
- package/static/AuthData.d.ts +6 -6
- package/static/External.d.ts +36 -6
- package/static/Params.d.ts +51 -25
- package/static/Utils.d.ts +2 -2
- package/types/Asr.d.ts +1 -1
- package/types/AudienceMode.d.ts +8 -0
- package/types/Conversation.d.ts +3 -0
- package/types/ExternalId.d.ts +13 -15
- package/types/MuteStates.d.ts +1 -1
- package/types/ParticipantLayout.d.ts +2 -2
- package/types/ParticipantStreamDescription.d.ts +0 -1
- package/types/RequestAsr.d.ts +3 -0
- package/types/Room.d.ts +3 -0
- package/types/Statistics.d.ts +1 -2
- package/types/Streams.d.ts +10 -0
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 {
|
|
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
|
|
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 {
|
|
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
|
|
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?:
|
|
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:
|
|
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:
|
|
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
|
* Изменить камеру на фронтальную или заднюю (для мобильных устройств)
|
|
@@ -379,8 +381,8 @@ export declare function updateDisplayLayout(layout: ParticipantLayout[]): Promis
|
|
|
379
381
|
* @param roles Список ролей
|
|
380
382
|
* @param revoke Забрать роли
|
|
381
383
|
*/
|
|
382
|
-
export declare function grantRoles(externalId:
|
|
383
|
-
export declare function grantRolesInternal(uid: OkUserId, roles: UserRole[], revoke?: boolean): Promise<void>;
|
|
384
|
+
export declare function grantRoles(externalId: ExternalId, roles: UserRole[], revoke?: boolean): Promise<void>;
|
|
385
|
+
export declare function grantRolesInternal(uid: OkUserId, deviceIdx: number, roles: UserRole[], revoke?: boolean): Promise<void>;
|
|
384
386
|
/**
|
|
385
387
|
* Выключить или выключить микрофон и/или камеру собеседнику (только если есть соответствующая роль)
|
|
386
388
|
*
|
|
@@ -396,8 +398,9 @@ export declare function muteParticipantInternal({ uid, muteStates, requestedMedi
|
|
|
396
398
|
*
|
|
397
399
|
* @param externalId Внешний ID пользователя
|
|
398
400
|
* @param unpin Открепить
|
|
401
|
+
* @param roomId Идентификатор комнаты
|
|
399
402
|
*/
|
|
400
|
-
export declare function pinParticipant(externalId:
|
|
403
|
+
export declare function pinParticipant(externalId: ExternalId, unpin?: boolean, roomId?: number | null): Promise<void>;
|
|
401
404
|
export declare function pinParticipantInternal(uid: OkUserId, unpin?: boolean, deviceIdx?: number, roomId?: number | null): Promise<void>;
|
|
402
405
|
/**
|
|
403
406
|
* Устанавливает настройки пользовательского медиа
|
|
@@ -419,7 +422,7 @@ export declare function changeConversationOptions(changes: {
|
|
|
419
422
|
* @param message Сообщение
|
|
420
423
|
* @param externalId Внешний ID пользователя (если не указано, отправит всем)
|
|
421
424
|
*/
|
|
422
|
-
export declare function chatMessage(message: string, externalId?:
|
|
425
|
+
export declare function chatMessage(message: string, externalId?: ExternalId | null): Promise<void>;
|
|
423
426
|
export declare function chatMessageInternal(message: string, uid?: OkUserId | null): Promise<void>;
|
|
424
427
|
/**
|
|
425
428
|
* Получить историю сообщений чата
|
|
@@ -433,7 +436,7 @@ export declare function chatHistory(count?: number): Promise<void>;
|
|
|
433
436
|
* @param data Данные
|
|
434
437
|
* @param externalId Внешний ID пользователя (если не указано, отправит всем)
|
|
435
438
|
*/
|
|
436
|
-
export declare function customData(data: JSONObject, externalId?:
|
|
439
|
+
export declare function customData(data: JSONObject, externalId?: ExternalId | null): Promise<void>;
|
|
437
440
|
export declare function customDataInternal(data: JSONObject, uid?: OkUserId | null, deviceIdx?: number): Promise<void>;
|
|
438
441
|
/**
|
|
439
442
|
* Создать токен комнаты для подключения по ссылке
|
|
@@ -446,6 +449,18 @@ export declare function customDataInternal(data: JSONObject, uid?: OkUserId | nu
|
|
|
446
449
|
export declare function startConversation(payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie }?: {
|
|
447
450
|
onlyAdminCanShareMovie?: boolean | undefined;
|
|
448
451
|
}): Promise<string>;
|
|
452
|
+
/**
|
|
453
|
+
* Создать токен комнаты в режиме Audience для подключения по ссылке
|
|
454
|
+
*
|
|
455
|
+
* @param payload Дополнительные данные для передачи на сервер
|
|
456
|
+
* @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
|
|
457
|
+
* @param startConversationParameters Дополнительные параметры для создания звонка (например onlyAdminCanShareMovie)
|
|
458
|
+
* @param speakerIds Список внешних ID пользователей, которые будут выступать в роли спикеров
|
|
459
|
+
* @returns Токен комнаты
|
|
460
|
+
*/
|
|
461
|
+
export declare function startAudienceConversation(payload: string | undefined, requireAuthToJoin: boolean | undefined, { onlyAdminCanShareMovie, }: {
|
|
462
|
+
onlyAdminCanShareMovie?: boolean | undefined;
|
|
463
|
+
} | undefined, speakerIds: ExternalUserId[]): Promise<string>;
|
|
449
464
|
/**
|
|
450
465
|
* Создать токен комнаты для подключения по ссылке к существующему звонку
|
|
451
466
|
*
|
|
@@ -489,19 +504,21 @@ export declare function startStream(isRecord?: boolean, name?: string | null, mo
|
|
|
489
504
|
* @param roomId
|
|
490
505
|
*/
|
|
491
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>;
|
|
492
512
|
/**
|
|
493
513
|
* Устанавливает роль участника в запись звонка
|
|
494
514
|
* Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
|
|
495
515
|
* видны только те участники, у кого есть роль.
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
* @param externalId Внешний ID пользователя
|
|
501
|
-
* @param role Роль, если null, то роль удалится
|
|
502
|
-
* @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
|
|
516
|
+
* @param king участник показывается крупно в записи звонка (только один участник имеет такую роль)
|
|
517
|
+
* @param pawns участник показывается в записи звонка
|
|
518
|
+
* @param hideParticipantCount скрыть/показать количество невидимых участников
|
|
519
|
+
* @param roomId комната
|
|
503
520
|
*/
|
|
504
|
-
export declare function
|
|
521
|
+
export declare function recordSetConf(king?: ExternalId, pawns?: ExternalId[], hideParticipantCount?: boolean, roomId?: number | null): Promise<void>;
|
|
505
522
|
/**
|
|
506
523
|
* Получить информацию о трансляции звонка
|
|
507
524
|
*/
|
|
@@ -545,9 +562,9 @@ export declare function activateRooms(roomIds: number[], deactivate: boolean): P
|
|
|
545
562
|
/**
|
|
546
563
|
* Cменить сессионный зал
|
|
547
564
|
* @param toRoomId
|
|
548
|
-
* @param
|
|
565
|
+
* @param externalId
|
|
549
566
|
*/
|
|
550
|
-
export declare function switchRoom(toRoomId?: number | null,
|
|
567
|
+
export declare function switchRoom(toRoomId?: number | null, externalId?: ExternalId | null): Promise<void>;
|
|
551
568
|
/**
|
|
552
569
|
* Удалить сессионные залы
|
|
553
570
|
* @param roomIds
|
|
@@ -590,12 +607,12 @@ export declare function setAudioStream(stream: MediaStream): Promise<void>;
|
|
|
590
607
|
*
|
|
591
608
|
* @param {(string|ArrayBuffer)} svg - svg в незашифрованном (string)
|
|
592
609
|
* или зашифрованном (ArrayBuffer) виде
|
|
593
|
-
* @param {(
|
|
610
|
+
* @param {(ExternalId|null)} externalId - externalId внешнего участника звонка,
|
|
594
611
|
* не требуется для текущего участника (текущего пользователя клиента)
|
|
595
612
|
* @param {(string|null)} customKey - кастомный ключ расшифровки svg,
|
|
596
613
|
* нужен только в случае присвоения участнику чужого аватара
|
|
597
614
|
*/
|
|
598
|
-
export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?:
|
|
615
|
+
export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalId | null, customKey?: string | null): Promise<void>;
|
|
599
616
|
/**
|
|
600
617
|
* Получить состояние зала ожидания
|
|
601
618
|
*
|
|
@@ -605,12 +622,30 @@ export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: Exte
|
|
|
605
622
|
*/
|
|
606
623
|
export declare function getWaitingHall(pageMarker?: string | null, count?: number, backward?: boolean): Promise<WaitingHallResponse>;
|
|
607
624
|
/**
|
|
608
|
-
*
|
|
625
|
+
* Получить список слушателей, запросивших повышение в комнате в режиме Audience
|
|
626
|
+
*/
|
|
627
|
+
export declare function getAudienceModeHands(): Promise<AudienceModeHandsResponse>;
|
|
628
|
+
/**
|
|
629
|
+
* Разрешить/запретить пользователю войти из зала ожидания/стать спикером комнаты
|
|
630
|
+
* в режиме Audience
|
|
609
631
|
*
|
|
610
632
|
* @param externalId Внешний ID пользователя
|
|
611
|
-
* @param demote Запретить
|
|
633
|
+
* @param demote Запретить вход/отобрать права спикера
|
|
612
634
|
*/
|
|
613
635
|
export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
|
|
636
|
+
/**
|
|
637
|
+
* Запросить/отозвать запрос на получение права стать спикером в комнате в
|
|
638
|
+
* режиме Audience
|
|
639
|
+
*
|
|
640
|
+
* @param demote Отозвать запрос
|
|
641
|
+
*/
|
|
642
|
+
export declare function requestPromotion(demote?: boolean): Promise<void>;
|
|
643
|
+
/**
|
|
644
|
+
* Согласиться/отказаться стать спикером в комнате в режиме Audience.
|
|
645
|
+
*
|
|
646
|
+
* @param reject Отказаться стать спикером
|
|
647
|
+
*/
|
|
648
|
+
export declare function acceptPromotion(reject?: boolean): Promise<void>;
|
|
614
649
|
export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<ExternalParticipantListChunk>;
|
|
615
650
|
export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
|
|
616
651
|
export declare function feedback(key: string): Promise<SignalingMessage>;
|
|
@@ -637,5 +672,5 @@ export declare function requestAsr(request: boolean): Promise<void>;
|
|
|
637
672
|
* Версия SDK
|
|
638
673
|
*/
|
|
639
674
|
export declare function version(): string;
|
|
640
|
-
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, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, };
|
|
641
|
-
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, };
|
package/abstract/BaseApi.d.ts
CHANGED
|
@@ -2,8 +2,8 @@ import CallType from '../enums/CallType';
|
|
|
2
2
|
import { ConversationData } from '../types/Conversation';
|
|
3
3
|
import ConversationParams from '../types/ConversationParams';
|
|
4
4
|
import ConversationResponse from '../types/ConversationResponse';
|
|
5
|
-
import { ExternalId, ExternalUserId } from '../types/ExternalId';
|
|
6
|
-
import { CompositeUserId, OkUserId } from '../types/Participant';
|
|
5
|
+
import { ExternalId, ExternalParticipantId, ExternalUserId } from '../types/ExternalId';
|
|
6
|
+
import { CompositeUserId, OkUserId, ParticipantId } from '../types/Participant';
|
|
7
7
|
export type LogItem = {
|
|
8
8
|
count?: number;
|
|
9
9
|
custom: {
|
|
@@ -22,10 +22,11 @@ export type LogItem = {
|
|
|
22
22
|
export default abstract class BaseApi {
|
|
23
23
|
abstract init(): void;
|
|
24
24
|
abstract authorize(): Promise<void>;
|
|
25
|
-
abstract userId(participantId:
|
|
25
|
+
abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
|
|
26
26
|
abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
|
|
27
27
|
onlyAdminCanShareMovie?: boolean;
|
|
28
|
-
|
|
28
|
+
audienceMode?: boolean;
|
|
29
|
+
}, speakerIds?: OkUserId[]): Promise<ConversationResponse>;
|
|
29
30
|
abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, createConversationParameters?: {
|
|
30
31
|
onlyAdminCanShareMovie?: boolean;
|
|
31
32
|
}): Promise<ConversationResponse>;
|
|
@@ -43,10 +44,11 @@ export default abstract class BaseApi {
|
|
|
43
44
|
abstract setUserId(userId: OkUserId): void;
|
|
44
45
|
log(items: LogItem[]): void;
|
|
45
46
|
prepareUserIds(ids: OkUserId[]): Promise<void>;
|
|
46
|
-
abstract getOkIdsByExternalIds(externalIds:
|
|
47
|
-
abstract
|
|
48
|
-
|
|
49
|
-
|
|
47
|
+
abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
|
|
48
|
+
abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
|
|
49
|
+
abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
|
|
50
|
+
getCachedOkIdByExternalId(externalId: ExternalId): ParticipantId | null;
|
|
51
|
+
cacheExternalId(participantId: CompositeUserId, externalId: ExternalParticipantId): void;
|
|
50
52
|
hangupConversation(conversationId: string): void;
|
|
51
53
|
removeHistoryRecords(recordIds: number[]): Promise<void>;
|
|
52
54
|
cleanup(): 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
|
|
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>;
|
|
@@ -83,7 +83,7 @@ export default abstract class BaseSignaling extends EventEmitter {
|
|
|
83
83
|
abstract chatMessage(message: string, participantId: CompositeUserId | null): Promise<SignalingMessage>;
|
|
84
84
|
abstract chatHistory(count: number): Promise<SignalingMessage>;
|
|
85
85
|
abstract customData(data: JSONObject, participantId: ParticipantId | null): Promise<SignalingMessage>;
|
|
86
|
-
abstract grantRoles(participantId:
|
|
86
|
+
abstract grantRoles(participantId: ParticipantId, roles: UserRole[], revoke: boolean): Promise<SignalingMessage>;
|
|
87
87
|
abstract muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[], roomId: number | null): Promise<SignalingMessage>;
|
|
88
88
|
abstract enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<SignalingMessage>;
|
|
89
89
|
abstract pinParticipant(participantId: ParticipantId, unpin: boolean, roomId: number | null): Promise<SignalingMessage>;
|
|
@@ -93,11 +93,13 @@ export default abstract class BaseSignaling extends EventEmitter {
|
|
|
93
93
|
}): Promise<SignalingMessage>;
|
|
94
94
|
abstract getWaitingHall(fromId: WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
|
|
95
95
|
abstract promoteParticipant(participantId: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
|
|
96
|
+
abstract requestPromotion(demote: boolean): Promise<SignalingMessage>;
|
|
97
|
+
abstract acceptPromotion(reject: boolean): Promise<SignalingMessage>;
|
|
96
98
|
abstract feedback(key: string): Promise<SignalingMessage>;
|
|
99
|
+
abstract getHandQueue(): Promise<SignalingMessage>;
|
|
97
100
|
abstract setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
|
|
98
101
|
abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
|
|
99
102
|
abstract useCommandDataChannel(status: boolean): void;
|
|
100
|
-
abstract setAsrDataChannel(dataChannel: RTCDataChannel): void;
|
|
101
103
|
abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
|
|
102
104
|
abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
|
|
103
105
|
abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
|