@vkontakte/calls-sdk 2.6.3-dev.1fd3364.0 → 2.6.3-dev.3b25f7c.0

package/CallsSDK.d.ts

@@ -1,6 +1,7 @@
 /**
  * CallsSDK
  */
+import type * as Vmoji from '@vkontakte/calls-vmoji';
 import type { IEffect, VideoEffects } from '@vkontakte/calls-video-effects';
 import BaseApi from './abstract/BaseApi';
 import BaseLogger from './abstract/BaseLogger';
@@ -33,6 +34,7 @@ import { JSONArray, JSONObject, JSONType } from './static/Json';
 import { ParamsObject } from './static/Params';
 import Utils from './static/Utils';
 import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
+import { IAsrStartParams } from './types/Asr';
 import ConversationParams from './types/ConversationParams';
 import ConversationResponse from './types/ConversationResponse';
 import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId, ExternalParticipantListMarkers, ExternalUserId } from './types/ExternalId';
@@ -47,11 +49,12 @@ import ParticipantPriority from './types/ParticipantPriority';
 import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
 import { Room, RoomsUpdate, RoomParticipantUpdate } from './types/Room';
 import RoomsEventType from './enums/RoomsEventType';
+import { ScreenCaptureSettings } from './types/ScreenCaptureSettings';
 import SignalingMessage from './types/SignalingMessage';
 import { WaitingHallResponse } from './types/WaitingHall';
 import { IFeedbackExternal } from './types/Feedback';
 import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData } from './types/MovieShare';
-import { IStartStreamData } from './types/Streams';
+import { IStartStreamData, IStopStreamData } from './types/Streams';
 import ConversationFeature from './enums/ConversationFeature';
 import { IFeaturesPerRole } from './types/ConversationFeature';
 import { ArrayDequeue } from './utils/ArrayDequeue';
@@ -165,6 +168,12 @@ export declare const browser: {
      * Возвращает AudioContext
      */
     getAudioContext: typeof WebRTCUtils.getAudioContext;
+    /**
+     * Браузер поддерживает захват звука при трансляции экрана
+     *
+     * _Метод доступен до инициализации_
+     */
+    isAudioShareSupported: typeof WebRTCUtils.isAudioShareSupported;
 };
 export declare function setApi(api: BaseApi): void;
 export declare function setSignalingFactory(signalingFactory: () => BaseSignaling): void;
@@ -175,6 +184,13 @@ export declare function setLogger(logger: BaseLogger): void;
  * @param effects Экземпляр класса `VideoEffects` из `@vkontakte/calls-video-effects`
  */
 export declare function setVideoEffects(effects: VideoEffects): void;
+/**
+ * Устанавливает библиотеку вимоджи
+ *
+ * @param vmoji Экземпляр класса `Vmoji` из `@vkontakte/calls-vmoji`
+ * @param sdk Экземпляр модуля `@vkontakte/calls-vmoji`, нужен для проброски дебаг сообщений
+ */
+export declare function setVmoji(vmoji: typeof Vmoji, sdk?: Parameters<typeof Vmoji.setSDK>[0] | null): void;
 /**
  * Инициализирует библиотеку
  *
@@ -283,16 +299,17 @@ export declare function changeDevice(kind: MediaDeviceKind, deviceId: string): P
 /**
  * Включить/выключить захват экрана
  *
- * @param state Включить или выключить
+ * @param stateOrSettings
+ *      state Включить или выключить захват экрана
+ *      settings Параметры захваты экрана
  */
-export declare function captureScreen(state: boolean): Promise<void>;
+export declare function captureScreen(stateOrSettings: boolean | ScreenCaptureSettings): Promise<void>;
 /**
- * Включить/выключить захват экрана
+ * Включить/выключить передачу точек вимоджи
  *
- * @param screenState Включить или выключить захват экрана.
- * @param audioShareState Включить или выключить захват звука. Может быть использован только вместе с захватом экрана.
+ * @param state Включить или выключить
  */
-export declare function captureScreenAndAudio(screenState: boolean, audioShareState: boolean): Promise<void>;
+export declare function captureVmoji(state: boolean): void;
 /**
  * Позволяет установить кастомный стрим для видео
  * например для стрима из canvas, с наложением изображений
@@ -472,7 +489,7 @@ export declare function getStreamInfo(): Promise<{
  * @param params
  */
 export declare function addMovie(params: IAddMovieParams): Promise<{
-    movieId: string;
+    movieId: number;
     streamType: string;
 }>;
 /**
@@ -484,9 +501,9 @@ export declare function updateMovie(params: IUpdateMovieData): Promise<void>;
 /**
  * Удалить видео/лайв из звонка
  *
- * @param movieId
+ * @param movieId Id Ролика
  */
-export declare function removeMovie(movieId: string): Promise<void>;
+export declare function removeMovie(movieId: number): Promise<void>;
 /**
  * Обновить сессионные залы
  * @param rooms id в случае обновления сессионного зала
@@ -547,6 +564,17 @@ export declare function changeVideoEffect(effect: IEffect | null): Promise<void>
  * @hidden
  */
 export declare function setAudioStream(stream: MediaStream): Promise<void>;
+/**
+ * Позволяет установить svg аватар для участника звонка
+ *
+ * @param {(string|ArrayBuffer)} svg - svg в незашифрованном (string)
+ * или зашифрованном (ArrayBuffer) виде
+ * @param {(ExternalParticipantId|null)} externalId - externalId внешнего участника звонка,
+ * не требуется для текущего участника (текущего пользователя клиента)
+ * @param {(string|null)} customKey - кастомный ключ расшифровки svg,
+ * нужен только в случае присвоения участнику чужого аватара
+ */
+export declare function setVmojiSvg(svg: string | ArrayBuffer, externalId?: ExternalParticipantId | null, customKey?: string | null): Promise<void>;
 /**
  * Получить состояние зала ожидания
  *
@@ -575,7 +603,7 @@ export declare function removeHistoryRecords(recordIds: number[]): Promise<void>
 /**
  * Начинает текстовую расшифровку звонка
  */
-export declare function startAsr(): Promise<void>;
+export declare function startAsr(params: IAsrStartParams): Promise<void>;
 /**
  * Заканчивает текстовую расшифровку звонка
  */
@@ -588,5 +616,5 @@ export declare function requestAsr(request: boolean): Promise<void>;
  * Версия SDK
  */
 export declare function version(): string;
-export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, };
+export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, ScreenCaptureSettings, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, Room, RoomsUpdate, RoomParticipantUpdate, IUpdateMovieData, IFeaturesPerRole, IMuteParticipantParams, IMuteParticipantInternalParams, IStartStreamData, IStopStreamData, };
 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, Utils, TransportTopology, RoomsEventType, ConversationFeature, ArrayDequeue, };

package/abstract/BaseSignaling.d.ts

@@ -9,6 +9,7 @@ import RecordRole from '../enums/RecordRole';
 import SignalingConnectionType from '../enums/SignalingConnectionType';
 import UserRole from '../enums/UserRole';
 import { JSONObject } from '../static/Json';
+import { IAsrStartParams } from '../types/Asr';
 import ConversationResponse from '../types/ConversationResponse';
 import MediaModifiers from '../types/MediaModifiers';
 import MediaSettings from '../types/MediaSettings';
@@ -18,7 +19,7 @@ import { CompositeUserId, ParticipantId } from '../types/Participant';
 import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
 import { ParticipantListChunkParameters } from '../types/ParticipantListChunk';
 import SignalingMessage from '../types/SignalingMessage';
-import { IStartStreamData } from '../types/Streams';
+import { IStartStreamData, IStopStreamData } from '../types/Streams';
 import { WaitingParticipantId } from '../types/WaitingHall';
 import { SharingStatReport } from '../classes/screenshare/SharingStatReport';
 /**
@@ -69,9 +70,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract getRooms(withParticipants: boolean): Promise<SignalingMessage>;
     abstract removeRooms(roomIds: number[]): Promise<SignalingMessage>;
     abstract startStream(data: IStartStreamData): Promise<SignalingMessage>;
-    abstract stopStream(data: {
-        roomId: number | null;
-    }): Promise<SignalingMessage>;
+    abstract stopStream(data: IStopStreamData): Promise<SignalingMessage>;
     abstract recordSetRole(participantId: ParticipantId, role: RecordRole | null, roomId: number | null): Promise<SignalingMessage>;
     abstract getRecordStatus(): Promise<SignalingMessage>;
     abstract switchTopology(topology: TransportTopology, force?: boolean): Promise<SignalingMessage>;
@@ -97,7 +96,7 @@ export default abstract class BaseSignaling extends EventEmitter {
     abstract setAsrDataChannel(dataChannel: RTCDataChannel): void;
     abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
     abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
-    abstract startAsr(): Promise<SignalingMessage>;
+    abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
     abstract stopAsr(): Promise<SignalingMessage>;
     abstract requestAsr(request: boolean): Promise<SignalingMessage>;
     get ready(): boolean;