@vkontakte/calls-sdk 2.8.2-dev.4283a11.0 → 2.8.2-dev.4550d8d.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 +36 -26
- package/abstract/BaseApi.d.ts +3 -2
- package/abstract/BaseSignaling.d.ts +4 -4
- 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 +6 -13
- package/classes/MediaSource.d.ts +5 -4
- 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/DirectTransport.d.ts +6 -0
- package/classes/transport/Statistics.d.ts +20 -2
- package/classes/transport/Transport.d.ts +1 -0
- package/constants/Rooms.d.ts +1 -0
- package/default/Api.d.ts +5 -3
- package/default/ApiExternal.d.ts +11 -0
- package/default/Signaling.d.ts +6 -7
- package/enums/SignalingCommandType.d.ts +4 -2
- package/package.json +3 -6
- package/static/ApiTransport.d.ts +3 -1
- package/static/AuthData.d.ts +6 -6
- package/static/Params.d.ts +77 -16
- package/static/Utils.d.ts +2 -1
- package/types/AudienceMode.d.ts +8 -0
- package/types/ExternalId.d.ts +5 -5
- package/types/Params.d.ts +1 -0
- package/types/RequestAsr.d.ts +3 -0
- package/types/SignalingMessage.d.ts +18 -0
- package/types/Statistics.d.ts +6 -0
- package/types/Streams.d.ts +10 -0
- package/types/VideoSettings.d.ts +15 -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,33 @@ 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 {
|
|
50
|
+
import { IApiEnv } from './types/Params';
|
|
51
|
+
import { CompositeUserId, IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantListMarker, ParticipantListMarkers, ParticipantListType, ParticipantStateMapped } from './types/Participant';
|
|
45
52
|
import ParticipantLayout, { Layout, RequestKeyFrame, StopStream } from './types/ParticipantLayout';
|
|
46
53
|
import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
|
|
47
54
|
import ParticipantPriority from './types/ParticipantPriority';
|
|
48
55
|
import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
|
|
49
|
-
import {
|
|
50
|
-
import RoomsEventType from './enums/RoomsEventType';
|
|
56
|
+
import { IRoomId, Room, RoomParticipantUpdate, Rooms, RoomsUpdate } from './types/Room';
|
|
51
57
|
import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
|
|
52
58
|
import SignalingMessage from './types/SignalingMessage';
|
|
59
|
+
import { StatResult } from './types/Statistics';
|
|
60
|
+
import { IStartStreamData, IStopStreamData, IPublishStreamData } from './types/Streams';
|
|
53
61
|
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
62
|
import { ArrayDequeue } from './utils/ArrayDequeue';
|
|
60
|
-
import {
|
|
63
|
+
import { ApiExternal } from './default/ApiExternal';
|
|
64
|
+
import AuthData from './static/AuthData';
|
|
61
65
|
/**
|
|
62
66
|
* Информация о текущем браузере
|
|
63
67
|
*/
|
|
@@ -224,7 +228,7 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
|
|
|
224
228
|
* @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
|
|
225
229
|
* @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
|
|
226
230
|
*/
|
|
227
|
-
export declare function callTo(externalId?:
|
|
231
|
+
export declare function callTo(externalId?: ExternalId | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
|
|
228
232
|
export declare function callInternal(ids: OkUserId[], type: CallType | undefined, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
|
|
229
233
|
/**
|
|
230
234
|
* Обработать пуш о входящем звонке
|
|
@@ -282,7 +286,7 @@ export declare function hangup(): Promise<void>;
|
|
|
282
286
|
* @param externalId Внешний ID пользователя
|
|
283
287
|
* @param params Параметры
|
|
284
288
|
*/
|
|
285
|
-
export declare function addParticipant(externalId:
|
|
289
|
+
export declare function addParticipant(externalId: ExternalId, params?: AddParticipantParams): Promise<void>;
|
|
286
290
|
export declare function addParticipantInternal(uid: OkUserId, params?: AddParticipantParams): Promise<void>;
|
|
287
291
|
/**
|
|
288
292
|
* Удалить собеседника из звонка
|
|
@@ -290,7 +294,7 @@ export declare function addParticipantInternal(uid: OkUserId, params?: AddPartic
|
|
|
290
294
|
* @param externalId Внешний ID пользователя
|
|
291
295
|
* @param ban Забанить пользователя
|
|
292
296
|
*/
|
|
293
|
-
export declare function removeParticipant(externalId:
|
|
297
|
+
export declare function removeParticipant(externalId: ExternalId, ban?: boolean): Promise<void>;
|
|
294
298
|
export declare function removeParticipantInternal(uid: OkUserId, ban?: boolean): Promise<void>;
|
|
295
299
|
/**
|
|
296
300
|
* Изменить камеру на фронтальную или заднюю (для мобильных устройств)
|
|
@@ -420,7 +424,7 @@ export declare function changeConversationOptions(changes: {
|
|
|
420
424
|
* @param message Сообщение
|
|
421
425
|
* @param externalId Внешний ID пользователя (если не указано, отправит всем)
|
|
422
426
|
*/
|
|
423
|
-
export declare function chatMessage(message: string, externalId?:
|
|
427
|
+
export declare function chatMessage(message: string, externalId?: ExternalId | null): Promise<void>;
|
|
424
428
|
export declare function chatMessageInternal(message: string, uid?: OkUserId | null): Promise<void>;
|
|
425
429
|
/**
|
|
426
430
|
* Получить историю сообщений чата
|
|
@@ -502,19 +506,21 @@ export declare function startStream(isRecord?: boolean, name?: string | null, mo
|
|
|
502
506
|
* @param roomId
|
|
503
507
|
*/
|
|
504
508
|
export declare function stopStream(roomId?: number | null): Promise<undefined>;
|
|
509
|
+
/**
|
|
510
|
+
* Опубликовать трансляцию звонка
|
|
511
|
+
* @param roomId
|
|
512
|
+
*/
|
|
513
|
+
export declare function publishStream(roomId?: number | null): Promise<undefined>;
|
|
505
514
|
/**
|
|
506
515
|
* Устанавливает роль участника в запись звонка
|
|
507
516
|
* Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
|
|
508
517
|
* видны только те участники, у кого есть роль.
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
* @param externalId Внешний ID пользователя
|
|
514
|
-
* @param role Роль, если null, то роль удалится
|
|
515
|
-
* @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
|
|
518
|
+
* @param king участник показывается крупно в записи звонка (только один участник имеет такую роль)
|
|
519
|
+
* @param pawns участник показывается в записи звонка
|
|
520
|
+
* @param hideParticipantCount скрыть/показать количество невидимых участников
|
|
521
|
+
* @param roomId комната
|
|
516
522
|
*/
|
|
517
|
-
export declare function
|
|
523
|
+
export declare function recordSetConf(king?: ExternalId, pawns?: ExternalId[], hideParticipantCount?: boolean, roomId?: number | null): Promise<void>;
|
|
518
524
|
/**
|
|
519
525
|
* Получить информацию о трансляции звонка
|
|
520
526
|
*/
|
|
@@ -617,6 +623,10 @@ export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: Exte
|
|
|
617
623
|
* @param backward Получить результат в обратном порядке
|
|
618
624
|
*/
|
|
619
625
|
export declare function getWaitingHall(pageMarker?: string | null, count?: number, backward?: boolean): Promise<WaitingHallResponse>;
|
|
626
|
+
/**
|
|
627
|
+
* Получить список слушателей, запросивших повышение в комнате в режиме Audience
|
|
628
|
+
*/
|
|
629
|
+
export declare function getAudienceModeHands(): Promise<AudienceModeHandsResponse>;
|
|
620
630
|
/**
|
|
621
631
|
* Разрешить/запретить пользователю войти из зала ожидания/стать спикером комнаты
|
|
622
632
|
* в режиме Audience
|
|
@@ -664,5 +674,5 @@ export declare function requestAsr(request: boolean): Promise<void>;
|
|
|
664
674
|
* Версия SDK
|
|
665
675
|
*/
|
|
666
676
|
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, };
|
|
677
|
+
export type { AddParticipantParams, AudienceModeHandsResponse, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, 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, };
|
|
678
|
+
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, };
|
package/abstract/BaseApi.d.ts
CHANGED
|
@@ -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:
|
|
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:
|
|
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
|
|
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,10 +96,10 @@ 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;
|
|
102
|
-
abstract setAsrDataChannel(dataChannel: RTCDataChannel): void;
|
|
103
103
|
abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
|
|
104
104
|
abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
|
|
105
105
|
abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
|