@vkontakte/calls-sdk 2.8.5-dev.2b864c42.0 → 2.8.5-dev.2bca00a8.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 +23 -6
- package/abstract/BaseApi.d.ts +2 -1
- package/abstract/BaseSignaling.d.ts +8 -1
- package/calls-sdk.cjs.js +8 -8
- package/calls-sdk.esm.js +8 -8
- package/classes/AudioFix.d.ts +4 -0
- package/classes/AudioOutput.d.ts +3 -0
- package/classes/Conversation.d.ts +10 -14
- package/classes/HangupReason.d.ts +13 -0
- package/classes/Logger.d.ts +3 -0
- package/classes/MediaSource.d.ts +13 -5
- package/classes/codec/IDecoder.d.ts +1 -1
- package/classes/codec/LibVPxDecoder.d.ts +1 -1
- package/classes/codec/LibVPxEncoder.d.ts +0 -3
- package/classes/codec/WebCodecsDecoder.d.ts +1 -1
- package/classes/stat/StatFirstMediaReceived.d.ts +6 -5
- package/classes/transport/DirectTransport.d.ts +5 -0
- package/default/Api.d.ts +2 -1
- package/default/Signaling.d.ts +1 -1
- package/enums/FatalError.d.ts +2 -1
- package/enums/HangupType.d.ts +2 -1
- package/package.json +3 -2
- package/static/ApiTransport.d.ts +1 -1
- package/static/ConversationDebugLogger.d.ts +13 -0
- package/static/External.d.ts +4 -2
- package/static/Params.d.ts +41 -24
- package/static/Utils.d.ts +3 -3
- package/static/WebRTCUtils.d.ts +8 -3
- package/types/Conversation.d.ts +0 -2
- package/types/GetLogUploadUrlParams.d.ts +6 -0
- package/types/GetLogUploadUrlResponse.d.ts +3 -0
- package/types/SignalingMessage.d.ts +5 -0
- package/types/VideoSettings.d.ts +1 -1
- package/utils/Conversation.d.ts +4 -0
- package/utils/DebugStorage.d.ts +6 -0
- package/utils/NavigatorPermissions.d.ts +13 -0
package/CallsSDK.d.ts
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
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
6
|
import type * as Vmoji from '@vkontakte/calls-vmoji';
|
|
6
|
-
import BaseApi from './abstract/BaseApi';
|
|
7
7
|
import BaseLogger from './abstract/BaseLogger';
|
|
8
8
|
import { AddParticipantParams } from './abstract/BaseSignaling';
|
|
9
9
|
import HangupReason, { HangupReasonData } from './classes/HangupReason';
|
|
@@ -63,6 +63,7 @@ import { ArrayDequeue } from './utils/ArrayDequeue';
|
|
|
63
63
|
import { ApiExternal } from './default/ApiExternal';
|
|
64
64
|
import AuthData from './static/AuthData';
|
|
65
65
|
import { VmojiError } from './types/Vmoji';
|
|
66
|
+
import { VolumeDetector } from './classes/VolumeDetector';
|
|
66
67
|
/**
|
|
67
68
|
* Информация о текущем браузере
|
|
68
69
|
*/
|
|
@@ -193,19 +194,24 @@ export declare const utils: {
|
|
|
193
194
|
*/
|
|
194
195
|
participantMarkerCompare: typeof Utils.participantMarkerCompare;
|
|
195
196
|
};
|
|
196
|
-
export declare function setApi(api: BaseApi): void;
|
|
197
197
|
export declare function setLogger(logger: BaseLogger): void;
|
|
198
198
|
/**
|
|
199
|
-
* Устанавливает библиотеку эффектов
|
|
199
|
+
* Устанавливает библиотеку видео эффектов
|
|
200
200
|
*
|
|
201
201
|
* @param effects Экземпляр класса `VideoEffects` из `@vkontakte/calls-video-effects`
|
|
202
202
|
*/
|
|
203
203
|
export declare function setVideoEffects(effects: VideoEffects): void;
|
|
204
|
+
/**
|
|
205
|
+
* Устанавливает библиотеку аудио эффектов
|
|
206
|
+
*
|
|
207
|
+
* @param effects Экземпляр класса `EffectVoiceChange` из `@vkontakte/calls-audio-effects`
|
|
208
|
+
*/
|
|
209
|
+
export declare function setAudioEffects(effects: EffectVoiceChange): void;
|
|
204
210
|
/**
|
|
205
211
|
* Устанавливает библиотеку вимоджи
|
|
206
212
|
*
|
|
207
213
|
* @param vmoji Экземпляр класса `Vmoji` из `@vkontakte/calls-vmoji`
|
|
208
|
-
* @param sdk Экземпляр модуля `@vkontakte/calls-
|
|
214
|
+
* @param sdk Экземпляр модуля `@vkontakte/calls-sdk`, нужен для проброски дебаг сообщений
|
|
209
215
|
*/
|
|
210
216
|
export declare function setVmoji(vmoji: typeof Vmoji, sdk?: Parameters<typeof Vmoji.setSDK>[0] | null, renderingOptions?: Partial<Vmoji.RenderingOptions>, protocolVersion?: Vmoji.AnimojiVersion): void;
|
|
211
217
|
/**
|
|
@@ -606,12 +612,23 @@ export declare function debug(enabled: boolean): void;
|
|
|
606
612
|
* @param args
|
|
607
613
|
*/
|
|
608
614
|
export declare function debugMessage(type: DebugMessageType, ...args: any[]): void;
|
|
615
|
+
/**
|
|
616
|
+
* Отправляет клиенские логи по conversationId на сервер OK
|
|
617
|
+
* @example можно посмотреть в examples/anonym/index.html
|
|
618
|
+
*/
|
|
619
|
+
export declare function uploadDebugLogs(): Promise<void>;
|
|
609
620
|
/**
|
|
610
621
|
* Эффект локального видео
|
|
611
622
|
*
|
|
612
623
|
* @param effect
|
|
613
624
|
*/
|
|
614
625
|
export declare function changeVideoEffect(effect: IEffect | null): Promise<void>;
|
|
626
|
+
/**
|
|
627
|
+
* Эффект локального аудио
|
|
628
|
+
*
|
|
629
|
+
* @param effect
|
|
630
|
+
*/
|
|
631
|
+
export declare function changeAudioEffect(effects: string[], isPreset?: boolean): Promise<void>;
|
|
615
632
|
/**
|
|
616
633
|
* Позволяет установить кастомный стрим для аудио
|
|
617
634
|
*
|
|
@@ -655,7 +672,7 @@ export declare function getAudienceModeHands(): Promise<AudienceModeHandsRespons
|
|
|
655
672
|
* @param externalId Внешний ID пользователя
|
|
656
673
|
* @param demote Запретить вход/отобрать права спикера
|
|
657
674
|
*/
|
|
658
|
-
export declare function promoteParticipant(externalId
|
|
675
|
+
export declare function promoteParticipant(externalId?: ExternalId, demote?: boolean): Promise<void>;
|
|
659
676
|
/**
|
|
660
677
|
* Запросить/отозвать запрос на получение права стать спикером в комнате в
|
|
661
678
|
* режиме Audience
|
|
@@ -708,4 +725,4 @@ export declare function sendTestCommand(name: string, params?: any): void;
|
|
|
708
725
|
*/
|
|
709
726
|
export declare function version(): string;
|
|
710
727
|
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, };
|
|
711
|
-
export { Api, AuthData,
|
|
728
|
+
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, VolumeDetector, };
|
package/abstract/BaseApi.d.ts
CHANGED
|
@@ -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?: {
|
|
@@ -63,6 +62,7 @@ export default abstract class BaseApi {
|
|
|
63
62
|
* method: vchat.clientEvents
|
|
64
63
|
*/
|
|
65
64
|
logClientEvents(items: ClientEvent[]): void;
|
|
65
|
+
abstract uploadDebugLogs(conversationId: string, startTime: number, endTime: number, log: string): Promise<void>;
|
|
66
66
|
abstract getOkIdsByExternalIds(externalIds: ExternalId[]): Promise<OkUserId[]>;
|
|
67
67
|
abstract getParticipantIdsByExternalIds(externalIds: ExternalId[]): Promise<Map<ExternalId, ParticipantId>>;
|
|
68
68
|
abstract getExternalIdsByOkIds(uids: OkUserId[]): Promise<ExternalParticipantId[]>;
|
|
@@ -75,5 +75,6 @@ export default abstract class BaseApi {
|
|
|
75
75
|
hangupConversation(conversationId: string): void;
|
|
76
76
|
sendUserFeedbackStats(conversationId: string, userResponse: number, reason?: string, groupCallUsersCount?: number): void;
|
|
77
77
|
removeHistoryRecords(recordIds: number[]): Promise<void>;
|
|
78
|
+
getServerTime(): Promise<number>;
|
|
78
79
|
cleanup(): void;
|
|
79
80
|
}
|
|
@@ -26,12 +26,19 @@ import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
|
|
|
26
26
|
* Параметры добавления пользователя в звонок
|
|
27
27
|
*/
|
|
28
28
|
export interface AddParticipantParams {
|
|
29
|
+
/**
|
|
30
|
+
* @deprecated
|
|
31
|
+
*/
|
|
29
32
|
showChatHistory?: boolean;
|
|
30
33
|
ttChat?: boolean;
|
|
31
34
|
/**
|
|
32
35
|
* Удалить юзера из бан-листа. Доступно только админу звонка
|
|
33
36
|
*/
|
|
34
37
|
unban?: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* JSON.stringify({show_chat_history: boolean})
|
|
40
|
+
*/
|
|
41
|
+
payload?: string;
|
|
35
42
|
}
|
|
36
43
|
/**
|
|
37
44
|
* Should trigger SignalingEvent.NOTIFICATION on notification message and SignalingEvent.FAILED on error
|
|
@@ -96,7 +103,7 @@ export default abstract class BaseSignaling extends EventEmitter {
|
|
|
96
103
|
[key in ConversationOption]?: boolean;
|
|
97
104
|
}): Promise<SignalingMessage>;
|
|
98
105
|
abstract getWaitingHall(fromId: SignalingMessage.WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
|
|
99
|
-
abstract promoteParticipant(participantId
|
|
106
|
+
abstract promoteParticipant(participantId?: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
|
|
100
107
|
abstract requestPromotion(unrequest: boolean): Promise<SignalingMessage>;
|
|
101
108
|
abstract acceptPromotion(reject: boolean): Promise<SignalingMessage>;
|
|
102
109
|
abstract feedback(key: string): Promise<SignalingMessage>;
|