@vkontakte/calls-sdk 2.8.12-dev.8c2bbcbf.0 → 2.8.12-dev.8f58ce7b.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.
Files changed (39) hide show
  1. package/CallsSDK.d.ts +24 -7
  2. package/abstract/BaseApi.d.ts +1 -1
  3. package/abstract/BaseSignaling.d.ts +6 -5
  4. package/calls-sdk.cjs.js +7 -13
  5. package/calls-sdk.esm.js +2756 -2157
  6. package/classes/CallRegistry.d.ts +1 -1
  7. package/classes/ExternalIdCache.d.ts +1 -0
  8. package/classes/MediaSource.d.ts +4 -0
  9. package/classes/{Conversation.d.ts → conversation/Conversation.d.ts} +40 -36
  10. package/classes/conversation/Conversation.testUtils.d.ts +148 -0
  11. package/classes/{ConversationResponseValidator.d.ts → conversation/ConversationResponseValidator.d.ts} +1 -1
  12. package/classes/{DisplayLayoutRequester.d.ts → conversation/DisplayLayoutRequester.d.ts} +5 -5
  13. package/classes/conversation/index.d.ts +1 -0
  14. package/classes/stat/CallFinishClassifier.d.ts +11 -0
  15. package/classes/stat/CallLifecycleStats.d.ts +1 -6
  16. package/classes/stat/StatAggregator.d.ts +4 -0
  17. package/classes/transport/DirectTransport.d.ts +1 -0
  18. package/classes/transport/ServerTransport.d.ts +1 -4
  19. package/classes/transport/SimulcastSender.d.ts +27 -0
  20. package/classes/transport/Transport.d.ts +3 -0
  21. package/default/Api.d.ts +2 -2
  22. package/default/Signaling.d.ts +12 -15
  23. package/default/SignalingTransport.d.ts +7 -1
  24. package/enums/ClientHangupReason.d.ts +7 -0
  25. package/enums/HangupType.d.ts +0 -1
  26. package/enums/Stat.d.ts +0 -1
  27. package/package.json +3 -3
  28. package/static/External.d.ts +1 -1
  29. package/static/Params.d.ts +28 -2
  30. package/static/Sdp.d.ts +3 -0
  31. package/static/SignalingCapabilities.d.ts +1 -1
  32. package/static/SimulcastInfo.d.ts +5 -3
  33. package/static/Utils.d.ts +1 -2
  34. package/static/WebRTCUtils.d.ts +8 -7
  35. package/types/Capabilities.d.ts +1 -0
  36. package/types/SignalingMessage.d.ts +5 -1
  37. package/types/WebTransport.d.ts +14 -15
  38. package/utils/IceServers.d.ts +2 -0
  39. package/utils/NavigatorPermissions.d.ts +2 -2
package/CallsSDK.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * CallsSDK
3
3
  */
4
4
  import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
5
- import type { EffectVoiceChange } from '@vkontakte/calls-audio-effects';
5
+ import type { EffectVoiceChange, VadControllerOptions, VadLib } from '@vkontakte/calls-audio-effects';
6
6
  import type * as Vmoji from '@vkontakte/calls-vmoji';
7
7
  import BaseLogger from './abstract/BaseLogger';
8
8
  import { AddParticipantParams } from './abstract/BaseSignaling';
@@ -14,6 +14,7 @@ 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
+ import type ClientHangupReason from './enums/ClientHangupReason';
17
18
  import ChatRoomEventType from './enums/ChatRoomEventType';
18
19
  import ConversationFeature from './enums/ConversationFeature';
19
20
  import ConversationOption from './enums/ConversationOption';
@@ -212,6 +213,13 @@ export declare function setVideoEffects(effects: VideoEffects): void;
212
213
  * @param effects Экземпляр класса `EffectVoiceChange` из `@vkontakte/calls-audio-effects`
213
214
  */
214
215
  export declare function setAudioEffects(effects: EffectVoiceChange): void;
216
+ /**
217
+ * Устанавливает поддержку VAD
218
+ *
219
+ * @param vad принимает VadController из `@vkontakte/calls-audio-effects`
220
+ * @param options принимает VadControllerOptions из `@vkontakte/calls-audio-effects`
221
+ */
222
+ export declare function setVad(vad: VadLib, options?: VadControllerOptions): void;
215
223
  /**
216
224
  * Устанавливает библиотеку вимоджи
217
225
  *
@@ -272,8 +280,14 @@ export declare function authorize(authToken?: string, apiBaseUrl?: IAPIBaseUrl):
272
280
  export declare function acceptCall(mediaOptions?: MediaOption[], conversationId?: string): Promise<ConversationData>;
273
281
  /**
274
282
  * Отклонить входящий звонок
283
+ *
284
+ * @param conversationId ID звонка
285
+ * @param params.reason Причина завершения для проброса в сигналинг
286
+ * (по умолчанию `REJECTED`). См. {@link ClientHangupReason}.
275
287
  */
276
- export declare function declineCall(conversationId?: string): Promise<void>;
288
+ export declare function declineCall(conversationId?: string, params?: {
289
+ reason?: ClientHangupReason;
290
+ }): Promise<void>;
277
291
  /**
278
292
  * Присоединиться к активному звонку
279
293
  *
@@ -295,8 +309,14 @@ export declare function joinCallInternal(conversationId: string, mediaOptions: M
295
309
  export declare function joinCallByLink(joinLink: string, mediaOptions?: MediaOption[], anonymToken?: string, observedIds?: ExternalUserId[], payload?: string, onFastJoin?: FastJoinHandler): Promise<ConversationData>;
296
310
  /**
297
311
  * Завершить текущий разговор
312
+ *
313
+ * @param conversationId ID звонка
314
+ * @param params.reason Причина завершения для проброса в сигналинг.
315
+ * По умолчанию `HUNGUP` (если звонок активен) или `CANCELED`. См. {@link ClientHangupReason}.
298
316
  */
299
- export declare function hangup(conversationId?: string): Promise<void>;
317
+ export declare function hangup(conversationId?: string, params?: {
318
+ reason?: ClientHangupReason;
319
+ }): Promise<void>;
300
320
  /**
301
321
  * Добавить собеседника в звонок
302
322
  *
@@ -769,9 +789,6 @@ export declare function stopAsr(params?: IAsrStopParams): Promise<void>;
769
789
  export declare function requestAsr(request: boolean): Promise<void>;
770
790
  export declare function startUrlSharing(sharedUrl: string): Promise<void>;
771
791
  export declare function stopUrlSharing(): Promise<void>;
772
- export declare function sendTestCommand(name: string, params?: any): void;
773
- export declare function startAnalyzingAudio(expectAudio: boolean, expectedActiveTracks?: number | null, expectedTrackFrequencies?: number[] | null): void;
774
- export declare function stopAnalyzingAudio(): void;
775
792
  export declare function switchCall(conversationId: string): Promise<void>;
776
793
  export declare function getActiveCallId(): string | null;
777
794
  /**
@@ -784,5 +801,5 @@ export declare function getSyncedTime(): number;
784
801
  * Версия SDK
785
802
  */
786
803
  export declare function version(): string;
787
- export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, DisplayLayoutRequest, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAPIBaseUrl, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, ParticipantStateData, ParticipantStateDataKey, 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, FastStartHandler, FastStartParams, FastJoinHandler, FastJoinParams, FastJoinResponse, };
804
+ export type { AddParticipantParams, AudienceModeHandsResponse, BrowserName, ClientHangupReason, CompositeUserId, ConversationData, ConversationParams, ConversationResponse, CustomError, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, DisplayLayoutRequest, GetParticipantsSignalingResponse, GetRoomsSignalingResponse, HangupReasonData, IApiEnv, IAPIBaseUrl, IAsrStartParams, IAsrStopParams, IAsrData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantId, ParticipantLayout, ParticipantListMarkers, ParticipantListType, ParticipantPriority, ParticipantsStateList, ParticipantStateData, ParticipantStateDataKey, 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, FastStartHandler, FastStartParams, FastJoinHandler, FastJoinParams, FastJoinResponse, };
788
805
  export { Api, AuthData, BaseLogger, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStateDataValue, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, ApiExternal, VolumeDetector, };
@@ -38,7 +38,7 @@ export default abstract class BaseApi {
38
38
  */
39
39
  setAbortSignal(signal: AbortSignal | undefined): void;
40
40
  abstract authorize(): Promise<void>;
41
- abstract userId(participantId: ParticipantId): Promise<ExternalParticipantId>;
41
+ abstract userId(participantId: ParticipantId): ExternalParticipantId;
42
42
  abstract deviceId(): string;
43
43
  abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
44
44
  onlyAdminCanShareMovie?: boolean;
@@ -42,6 +42,9 @@ export interface AddParticipantParams {
42
42
  */
43
43
  payload?: string;
44
44
  }
45
+ export declare class SignalingDisposedError extends Error {
46
+ constructor(command?: string);
47
+ }
45
48
  /**
46
49
  * Should trigger SignalingEvent.NOTIFICATION on notification message and SignalingEvent.FAILED on error
47
50
  * https://wiki.odkl.ru/display/projects/Signaling+API#SignalingAPI-Notifications
@@ -55,11 +58,11 @@ export default abstract class BaseSignaling extends EventEmitter {
55
58
  */
56
59
  setAbortSignal(signal: AbortSignal | undefined): void;
57
60
  abstract connect(connectionType: SignalingConnectionType, conversation?: ConversationResponse): Promise<SignalingMessage.Connection>;
58
- abstract close(): void;
61
+ abstract dispose(cause?: Error): void;
59
62
  abstract hangup(reason: string): Promise<SignalingMessage | void>;
60
63
  abstract acceptCall(mediaSettings: MediaSettings): Promise<SignalingMessage>;
61
64
  abstract sendSdp(participantId: ParticipantId, sdp: RTCSessionDescriptionInit, extraPayload?: Record<string, any>): Promise<SignalingMessage>;
62
- abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidate): Promise<SignalingMessage>;
65
+ abstract sendCandidate(participantId: ParticipantId, candidate: RTCIceCandidateInit): Promise<SignalingMessage>;
63
66
  abstract changeMediaSettings(mediaSettings: MediaSettings): Promise<SignalingMessage>;
64
67
  abstract changeParticipantState(state: ParticipantStateData, compositeUserId?: CompositeUserId): Promise<SignalingMessage>;
65
68
  abstract hold(hold: boolean, capabilities?: TCapabilities): Promise<SignalingMessage>;
@@ -130,9 +133,7 @@ export default abstract class BaseSignaling extends EventEmitter {
130
133
  requestRealloc(): void;
131
134
  setEndpoint(endpoint: string): void;
132
135
  setWebTransportEndpoint(endpoint: string | null): void;
133
- setConversationId(conversationId: string): void;
134
136
  readyToSend(isReady?: boolean): void;
135
- cleanup(): void;
136
- requestTestMode(consumerCommand: string, producerCommand: string | null): void;
137
+ requestTestMode(consumerCommand: string, producerCommand: string | null): Promise<SignalingMessage | void>;
137
138
  getNextCommandSequenceNumber(): number;
138
139
  }