@vkontakte/calls-sdk 2.7.1 → 2.7.2-beta.1

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 CHANGED
@@ -32,8 +32,8 @@ import { DebugMessageType } from './static/Debug';
32
32
  import { ParticipantStatus } from './static/External';
33
33
  import { JSONArray, JSONObject, JSONType } from './static/Json';
34
34
  import { ParamsObject } from './static/Params';
35
- import Utils from './static/Utils';
36
35
  import WebRTCUtils, { FacingMode } from './static/WebRTCUtils';
36
+ import { IAsrStartParams } from './types/Asr';
37
37
  import ConversationParams from './types/ConversationParams';
38
38
  import ConversationResponse from './types/ConversationResponse';
39
39
  import { ExternalId, ExternalIdType, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers, ExternalUserId } from './types/ExternalId';
@@ -334,12 +334,11 @@ export declare function toggleLocalAudio(enabled: boolean): Promise<void>;
334
334
  /**
335
335
  * Изменяет размеры локального видео
336
336
  *
337
- * @param width
338
- * @param height
339
- * @param params новые размеры видео эффекта
337
+ * @param resolution
340
338
  */
341
- export declare function setLocalResolution(width: number, height: number, params?: {
342
- effect: IVideoDimentions;
339
+ export declare function setLocalResolution(resolution: {
340
+ video: IVideoDimentions;
341
+ effect?: IVideoDimentions;
343
342
  }): Promise<void>;
344
343
  /**
345
344
  * Изменяет качество отображаемых стримов - чем выше приоритет, тем лучше качество.
@@ -464,8 +463,21 @@ export declare function setVolume(volume: number): void;
464
463
  * @param enabled
465
464
  */
466
465
  export declare function forceRelayPolicy(enabled: boolean): void;
467
- export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null): Promise<SignalingMessage>;
468
- export declare function stopStream(roomId?: number | null): Promise<SignalingMessage>;
466
+ /**
467
+ * Начать трансляцию звонка
468
+ * @param isRecord Записывать ли трансляцию
469
+ * @param name Имя видеоролика
470
+ * @param movieId ID видео
471
+ * @param privacy
472
+ * @param groupId
473
+ * @param roomId
474
+ */
475
+ export declare function startStream(isRecord?: boolean, name?: string | null, movieId?: string | null, privacy?: 'PUBLIC' | 'FRIENDS' | 'DIRECT_LINK', groupId?: string | null, roomId?: number | null): Promise<never>;
476
+ /**
477
+ * Завершить трансляцию звонка
478
+ * @param roomId
479
+ */
480
+ export declare function stopStream(roomId?: number | null): Promise<never>;
469
481
  /**
470
482
  * Устанавливает роль участника в запись звонка
471
483
  * Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут
@@ -479,6 +491,9 @@ export declare function stopStream(roomId?: number | null): Promise<SignalingMes
479
491
  * @param roomId ID сессионного зала записи. Если null, то роль применится в основном звонке
480
492
  */
481
493
  export declare function recordSetRole(externalId: string | ExternalParticipantId, role: RecordRole | null, roomId?: number | null): Promise<void>;
494
+ /**
495
+ * Получить информацию о трансляции звонка
496
+ */
482
497
  export declare function getStreamInfo(): Promise<{
483
498
  movieId: any;
484
499
  preview: any;
@@ -598,7 +613,7 @@ export declare function removeHistoryRecords(recordIds: number[]): Promise<void>
598
613
  /**
599
614
  * Начинает текстовую расшифровку звонка
600
615
  */
601
- export declare function startAsr(): Promise<void>;
616
+ export declare function startAsr(params: IAsrStartParams): Promise<void>;
602
617
  /**
603
618
  * Заканчивает текстовую расшифровку звонка
604
619
  */
@@ -611,5 +626,5 @@ export declare function requestAsr(request: boolean): Promise<void>;
611
626
  * Версия SDK
612
627
  */
613
628
  export declare function version(): string;
614
- export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, 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, };
615
- 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, };
629
+ export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListChunk, ExternalParticipantListMarker, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IAsrStartParams, 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, };
630
+ 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, };
@@ -9,6 +9,7 @@ import RecordRole from '../enums/RecordRole';
9
9
  import SignalingConnectionType from '../enums/SignalingConnectionType';
10
10
  import UserRole from '../enums/UserRole';
11
11
  import { JSONObject } from '../static/Json';
12
+ import { IAsrStartParams } from '../types/Asr';
12
13
  import ConversationResponse from '../types/ConversationResponse';
13
14
  import MediaModifiers from '../types/MediaModifiers';
14
15
  import MediaSettings from '../types/MediaSettings';
@@ -95,7 +96,7 @@ export default abstract class BaseSignaling extends EventEmitter {
95
96
  abstract setAsrDataChannel(dataChannel: RTCDataChannel): void;
96
97
  abstract getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<SignalingMessage>;
97
98
  abstract getParticipants(externalIds: SignalingMessage.ExternalId[]): Promise<SignalingMessage>;
98
- abstract startAsr(): Promise<SignalingMessage>;
99
+ abstract startAsr(params: IAsrStartParams): Promise<SignalingMessage>;
99
100
  abstract stopAsr(): Promise<SignalingMessage>;
100
101
  abstract requestAsr(request: boolean): Promise<SignalingMessage>;
101
102
  get ready(): boolean;